blob: 05b086ec602df9df6980f95a18f7efac41493026 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 -->
<title>NormalizedProjection.ParameterRole (Apache SIS 1.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2019-09-20">
<meta name="keywords" content="org.apache.sis.referencing.operation.projection.NormalizedProjection.ParameterRole class">
<meta name="keywords" content="values()">
<meta name="keywords" content="valueOf()">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../sis.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="NormalizedProjection.ParameterRole (Apache SIS 1.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../";
var useModuleDirectories = false;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/NormalizedProjection.ParameterRole.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.referencing.operation.projection</a></div>
<h2 title="Enum NormalizedProjection.ParameterRole" class="title">Enum NormalizedProjection.ParameterRole</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></li>
<li>
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang" class="externalLink">Enum</a>&lt;<a href="NormalizedProjection.ParameterRole.html" title="enum in org.apache.sis.referencing.operation.projection">NormalizedProjection.ParameterRole</a>&gt;</li>
<li>
<ul class="inheritance">
<li>ParameterRole</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a>&lt;<a href="NormalizedProjection.ParameterRole.html" title="enum in org.apache.sis.referencing.operation.projection">Normalized­Projection​.Parameter­Role</a>&gt;</code></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="NormalizedProjection.html" title="class in org.apache.sis.referencing.operation.projection">NormalizedProjection</a></dd>
</dl>
<hr>
<pre>protected static enum <span class="typeNameLabel">NormalizedProjection.ParameterRole</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang" class="externalLink">Enum</a>&lt;<a href="NormalizedProjection.ParameterRole.html" title="enum in org.apache.sis.referencing.operation.projection">NormalizedProjection.ParameterRole</a>&gt;</pre>
<div class="block">Maps the parameters to be used for initializing <a href="NormalizedProjection.html" title="class in org.apache.sis.referencing.operation.projection"><code>Normalized­Projection</code></a> and its
<a href="../transform/ContextualParameters.html#getMatrix(org.apache.sis.referencing.operation.transform.ContextualParameters.MatrixRole)">normalization / denormalization</a> matrices.
This is an enumeration of parameters found in almost every map projections, but under different names.
This enumeration allows <code>Normalized­Projection</code> subclasses to specify which parameter names, ranges
and default values should be used by the
<a href="NormalizedProjection.html#%3Cinit%3E(org.opengis.referencing.operation.OperationMethod,org.apache.sis.parameter.Parameters,java.util.Map)">projection constructor</a>.
<p><code>Normalized­Projection</code> subclasses will typically provide values only for the following keys:
<a href="#CENTRAL_MERIDIAN"><code>CENTRAL_MERIDIAN</code></a>, <a href="#SCALE_FACTOR"><code>SCALE_FACTOR</code></a>, <a href="#FALSE_EASTING"><code>FALSE_EASTING</code></a> and <a href="#FALSE_NORTHING"><code>FALSE_NORTHING</code></a>.</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.6</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="NormalizedProjection.html#%3Cinit%3E(org.opengis.referencing.operation.OperationMethod,org.apache.sis.parameter.Parameters,java.util.Map)"><code>Normalized­Projection(Operation­Method, Parameters, Map)</code></a></dd>
<p><font size="-1">Defined in the <code>sis-referencing</code> module</font></p>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="enum.constant.summary">
<!-- -->
</a>
<h3>Enum Constant Summary</h3>
<table class="memberSummary">
<caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum Constant</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#CENTRAL_MERIDIAN">CENTRAL_MERIDIAN</a></span></code></th>
<td class="colLast">
<div class="block">Maps the <cite>central meridian</cite> parameter (symbol: λ₀).</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#FALSE_EASTING">FALSE_EASTING</a></span></code></th>
<td class="colLast">
<div class="block">Maps the <cite>false easting</cite> parameter (symbol: <var>FE</var>).</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#FALSE_NORTHING">FALSE_NORTHING</a></span></code></th>
<td class="colLast">
<div class="block">Maps the <cite>false northing</cite> parameter (symbol: <var>FN</var>).</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#FALSE_SOUTHING">FALSE_SOUTHING</a></span></code></th>
<td class="colLast">
<div class="block">Maps the <cite>false southing</cite> parameter (symbol: <var>FS</var>).</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#FALSE_WESTING">FALSE_WESTING</a></span></code></th>
<td class="colLast">
<div class="block">Maps the <cite>false westing</cite> parameter (symbol: <var>FW</var>).</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#LATITUDE_OF_CONFORMAL_SPHERE_RADIUS">LATITUDE_OF_CONFORMAL_SPHERE_RADIUS</a></span></code></th>
<td class="colLast">
<div class="block">Maps the parameter for the latitude where to compute the <cite>radius of conformal sphere</cite>
(symbol: <var>R</var><sub>c</sub>).</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#SCALE_FACTOR">SCALE_FACTOR</a></span></code></th>
<td class="colLast">
<div class="block">Maps the <cite>scale factor</cite> parameter (symbol: <var>k₀</var>).</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#SEMI_MAJOR">SEMI_MAJOR</a></span></code></th>
<td class="colLast">
<div class="block">Maps the <cite>semi-major axis length</cite> parameter (symbol: <var>a</var>).</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#SEMI_MINOR">SEMI_MINOR</a></span></code></th>
<td class="colLast">
<div class="block">Maps the <cite>semi-minor axis length</cite> parameter (symbol: <var>b</var>).</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="NormalizedProjection.ParameterRole.html" title="enum in org.apache.sis.referencing.operation.projection">NormalizedProjection.ParameterRole</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#valueOf(java.lang.String)">valueOf</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Returns the enum constant of this type with the specified name.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="NormalizedProjection.ParameterRole.html" title="enum in org.apache.sis.referencing.operation.projection">NormalizedProjection.ParameterRole</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#values()">values</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.Enum">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang" class="externalLink">Enum</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#compareTo(E)" title="class or interface in java.lang" class="externalLink">compare­To</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass()" title="class or interface in java.lang" class="externalLink">get­Declaring­Class</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hash­Code</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#name()" title="class or interface in java.lang" class="externalLink">name</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#ordinal()" title="class or interface in java.lang" class="externalLink">ordinal</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">to­String</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="externalLink">value­Of</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">get­Class</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notify­All</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ENUM CONSTANT DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="enum.constant.detail">
<!-- -->
</a>
<h3>Enum Constant Detail</h3>
<a id="SEMI_MAJOR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SEMI_MAJOR</h4>
<pre>public static final&nbsp;<a href="NormalizedProjection.ParameterRole.html" title="enum in org.apache.sis.referencing.operation.projection">NormalizedProjection.ParameterRole</a> SEMI_MAJOR</pre>
<div class="block">Maps the <cite>semi-major axis length</cite> parameter (symbol: <var>a</var>).
This value is used for computing <a href="NormalizedProjection.html#eccentricity"><code>Normalized­Projection​.eccentricity</code></a>,
and is also a multiplication factor for the denormalization matrix.
<p>Unless specified otherwise, this is always mapped to a parameter named <code>"semi_major"</code>.
<code>Normalized­Projection</code> subclasses typically do not need to provide a value for this key.</p></div>
</li>
</ul>
<a id="SEMI_MINOR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SEMI_MINOR</h4>
<pre>public static final&nbsp;<a href="NormalizedProjection.ParameterRole.html" title="enum in org.apache.sis.referencing.operation.projection">NormalizedProjection.ParameterRole</a> SEMI_MINOR</pre>
<div class="block">Maps the <cite>semi-minor axis length</cite> parameter (symbol: <var>b</var>).
This value is used for computing <a href="NormalizedProjection.html#eccentricity"><code>Normalized­Projection​.eccentricity</code></a>.
<p>Unless specified otherwise, this is always mapped to a parameter named <code>"semi_minor"</code>.
<code>Normalized­Projection</code> subclasses typically do not need to provide a value for this key.</p></div>
</li>
</ul>
<a id="LATITUDE_OF_CONFORMAL_SPHERE_RADIUS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LATITUDE_OF_CONFORMAL_SPHERE_RADIUS</h4>
<pre>public static final&nbsp;<a href="NormalizedProjection.ParameterRole.html" title="enum in org.apache.sis.referencing.operation.projection">NormalizedProjection.ParameterRole</a> LATITUDE_OF_CONFORMAL_SPHERE_RADIUS</pre>
<div class="block">Maps the parameter for the latitude where to compute the <cite>radius of conformal sphere</cite>
(symbol: <var>R</var><sub>c</sub>). If this parameter is provided, then the radius of the conformal
sphere at latitude φ will be used instead than the semi-major axis length in the denormalisation matrix.
In other words, if provided then <var>a</var> is replaced by <var>R</var><sub>c</sub> below:
<div style="text-align:center"> <math display="block" alttext="MathML capable browser required">
<mfenced open="[" close="]">
<mtable>
<mtr>
<mtd><mi>a</mi> <mo></mo> <msub><mi>k</mi><mn>0</mn></msub></mtd>
<mtd><mn>0</mn></mtd>
<mtd><mi>FE</mi></mtd>
</mtr>
<mtr>
<mtd><mn>0</mn></mtd>
<mtd><mi>a</mi> <mo></mo> <msub><mi>k</mi><mn>0</mn></msub></mtd>
<mtd><mi>FN</mi></mtd>
</mtr>
<mtr>
<mtd><mn>0</mn></mtd>
<mtd><mn>0</mn></mtd>
<mtd><mn>1</mn></mtd>
</mtr>
</mtable>
</mfenced>
</math>
</div>
<p>This enumeration shall be used <strong>only</strong> when the user requested explicitly spherical
formulas, for example the <cite>"Mercator (Spherical)"</cite> projection (EPSG:1026), but the figure
of the Earth may be an ellipsoid rather than a sphere. In the majority of cases, this enumeration should
not be used.</p></div>
</li>
</ul>
<a id="CENTRAL_MERIDIAN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CENTRAL_MERIDIAN</h4>
<pre>public static final&nbsp;<a href="NormalizedProjection.ParameterRole.html" title="enum in org.apache.sis.referencing.operation.projection">NormalizedProjection.ParameterRole</a> CENTRAL_MERIDIAN</pre>
<div class="block">Maps the <cite>central meridian</cite> parameter (symbol: λ₀).
This value is subtracted from the longitude values before the map projections.
<p>Some common names for this parameter are:</p>
<ul>
<li>Longitude of origin</li>
<li>Longitude of false origin</li>
<li>Longitude of natural origin</li>
<li>Spherical longitude of origin</li>
<li>Longitude of projection centre</li>
</ul></div>
</li>
</ul>
<a id="SCALE_FACTOR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SCALE_FACTOR</h4>
<pre>public static final&nbsp;<a href="NormalizedProjection.ParameterRole.html" title="enum in org.apache.sis.referencing.operation.projection">NormalizedProjection.ParameterRole</a> SCALE_FACTOR</pre>
<div class="block">Maps the <cite>scale factor</cite> parameter (symbol: <var>k₀</var>).
This is a multiplication factor for the (<var>x</var>,<var>y</var>) values obtained after map projections.
<p>Some common names for this parameter are:</p>
<ul>
<li>Scale factor at natural origin</li>
<li>Scale factor on initial line</li>
<li>Scale factor on pseudo standard parallel</li>
</ul></div>
</li>
</ul>
<a id="FALSE_EASTING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FALSE_EASTING</h4>
<pre>public static final&nbsp;<a href="NormalizedProjection.ParameterRole.html" title="enum in org.apache.sis.referencing.operation.projection">NormalizedProjection.ParameterRole</a> FALSE_EASTING</pre>
<div class="block">Maps the <cite>false easting</cite> parameter (symbol: <var>FE</var>).
This is a translation term for the <var>x</var> values obtained after map projections.
<p>Some common names for this parameter are:</p>
<ul>
<li>False easting</li>
<li>Easting at false origin</li>
<li>Easting at projection centre</li>
</ul></div>
</li>
</ul>
<a id="FALSE_WESTING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FALSE_WESTING</h4>
<pre>public static final&nbsp;<a href="NormalizedProjection.ParameterRole.html" title="enum in org.apache.sis.referencing.operation.projection">NormalizedProjection.ParameterRole</a> FALSE_WESTING</pre>
<div class="block">Maps the <cite>false westing</cite> parameter (symbol: <var>FW</var>).
This is the same <var>x</var> translation than <a href="#FALSE_EASTING"><code>FALSE_EASTING</code></a>, but of opposite sign.
<p>Actually, there is usually no parameter named "false westing" in a map projection.
But some projections like <cite>"Lambert Conic Conformal (West Orientated)"</cite> are
defined in such a way that their "false easting" parameter is effectively a "false westing".
This enumeration value can be used for informing <a href="NormalizedProjection.html" title="class in org.apache.sis.referencing.operation.projection"><code>Normalized­Projection</code></a> about that fact.</p></div>
</li>
</ul>
<a id="FALSE_NORTHING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FALSE_NORTHING</h4>
<pre>public static final&nbsp;<a href="NormalizedProjection.ParameterRole.html" title="enum in org.apache.sis.referencing.operation.projection">NormalizedProjection.ParameterRole</a> FALSE_NORTHING</pre>
<div class="block">Maps the <cite>false northing</cite> parameter (symbol: <var>FN</var>).
This is a translation term for the <var>y</var> values obtained after map projections.
<p>Some common names for this parameter are:</p>
<ul>
<li>False northing</li>
<li>Northing at false origin</li>
<li>Northing at projection centre</li>
</ul></div>
</li>
</ul>
<a id="FALSE_SOUTHING">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FALSE_SOUTHING</h4>
<pre>public static final&nbsp;<a href="NormalizedProjection.ParameterRole.html" title="enum in org.apache.sis.referencing.operation.projection">NormalizedProjection.ParameterRole</a> FALSE_SOUTHING</pre>
<div class="block">Maps the <cite>false southing</cite> parameter (symbol: <var>FS</var>).
This is the same <var>y</var> translation than <a href="#FALSE_NORTHING"><code>FALSE_NORTHING</code></a>, but of opposite sign.
<p>Actually, there is usually no parameter named "false southing" in a map projection.
But some projections like <cite>"Transverse Mercator (South Orientated)"</cite> are
defined in such a way that their "false northing" parameter is effectively a "false southing".
This enumeration value can be used for informing <a href="NormalizedProjection.html" title="class in org.apache.sis.referencing.operation.projection"><code>Normalized­Projection</code></a> about that fact.</p></div>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="values()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>values</h4>
<pre class="methodSignature">public static&nbsp;<a href="NormalizedProjection.ParameterRole.html" title="enum in org.apache.sis.referencing.operation.projection">NormalizedProjection.ParameterRole</a>[]&nbsp;values()</pre>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared. This method may be used to iterate
over the constants as follows:
<pre>
for (NormalizedProjection.ParameterRole c : NormalizedProjection.ParameterRole.values())
&nbsp; System.out.println(c);
</pre></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array containing the constants of this enum type, in the order they are declared</dd>
</dl>
</li>
</ul>
<a id="valueOf(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>valueOf</h4>
<pre class="methodSignature">public static&nbsp;<a href="NormalizedProjection.ParameterRole.html" title="enum in org.apache.sis.referencing.operation.projection">NormalizedProjection.ParameterRole</a>&nbsp;valueOf&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)</pre>
<div class="block">Returns the enum constant of this type with the specified name.
The string must match <i>exactly</i> an identifier used to declare an
enum constant in this type. (Extraneous whitespace characters are
not permitted.)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the enum constant to be returned.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the enum constant with the specified name</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">Illegal­Argument­Exception</a></code> - if this enum type has no constant with the specified name</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">Null­Pointer­Exception</a></code> - if the argument is null</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/NormalizedProjection.ParameterRole.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2010&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>