blob: 8de77be84dab9cc6bcb6f2f2dde5e7496454ad9b [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>DefaultMathTransformFactory.Context (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.transform.DefaultMathTransformFactory.Context class">
<meta name="keywords" content="setSource()">
<meta name="keywords" content="setTarget()">
<meta name="keywords" content="getSourceCS()">
<meta name="keywords" content="getSourceEllipsoid()">
<meta name="keywords" content="getTargetCS()">
<meta name="keywords" content="getTargetEllipsoid()">
<meta name="keywords" content="getMatrix()">
<meta name="keywords" content="getCompletedParameters()">
<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="DefaultMathTransformFactory.Context (Apache SIS 1.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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/DefaultMathTransformFactory.Context.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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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.transform</a></div>
<h2 title="Class DefaultMathTransformFactory.Context" class="title">Class DefaultMathTransformFactory.Context</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>Context</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></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="DefaultMathTransformFactory.html" title="class in org.apache.sis.referencing.operation.transform">DefaultMathTransformFactory</a></dd>
</dl>
<hr>
<pre>public static class <span class="typeNameLabel">DefaultMathTransformFactory.Context</span>
extends <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>
implements <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></pre>
<div class="block">Source and target coordinate systems for which a new parameterized transform is going to be used.
<a href="DefaultMathTransformFactory.html" title="class in org.apache.sis.referencing.operation.transform"><code>Default­Math­Transform­Factory</code></a> uses this information for:
<ul>
<li>Completing some parameters if they were not provided. In particular, the <a href="#getSourceEllipsoid()">source ellipsoid</a> can be used for providing values for the <code>"semi_major"</code> and <code>"semi_minor"</code>
parameters in map projections.</li>
<li><a href="../../cs/CoordinateSystems.html#swapAndScaleAxes(org.opengis.referencing.cs.CoordinateSystem,org.opengis.referencing.cs.CoordinateSystem)">Swapping and scaling axes</a> if the source or the target
coordinate systems are not <a href="../../cs/AxesConvention.html#NORMALIZED">normalized</a>.</li>
</ul>
By default this class does <strong>not</strong> handle change of
<a href="../../datum/DefaultGeodeticDatum.html#getPrimeMeridian()">prime meridian</a>
or anything else related to datum. Datum changes have dedicated <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/OperationMethod.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>Operation­Method</code></a>,
for example <cite>"Longitude rotation"</cite> (EPSG:9601) for changing the prime meridian.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.7</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../serialized-form.html#org.apache.sis.referencing.operation.transform.DefaultMathTransformFactory.Context">Serialized Form</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">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">Context</a></span>()</code></th>
<td class="colLast">
<div class="block">Creates a new context with all properties initialized to <code>null</code>.</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValueGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValueGroup</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCompletedParameters()">getCompletedParameters</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the parameter values used for the math transform creation, including the parameters completed
by the factory.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/Matrix.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">Matrix</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMatrix(org.apache.sis.referencing.operation.transform.ContextualParameters.MatrixRole)">getMatrix</a></span>&#8203;(<a href="ContextualParameters.MatrixRole.html" title="enum in org.apache.sis.referencing.operation.transform">ContextualParameters.MatrixRole</a>&nbsp;role)</code></th>
<td class="colLast">
<div class="block">Returns the matrix that represent the affine transform to concatenate before or after
the parameterized transform.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystem.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">CoordinateSystem</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSourceCS()">getSourceCS</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the source coordinate system, or <code>null</code> if unspecified.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/datum/Ellipsoid.html?is-external=true" title="class or interface in org.opengis.referencing.datum" class="externalLink">Ellipsoid</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSourceEllipsoid()">getSourceEllipsoid</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the ellipsoid of the source ellipsoidal coordinate system, or <code>null</code> if it does not apply.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystem.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">CoordinateSystem</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTargetCS()">getTargetCS</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the target coordinate system, or <code>null</code> if unspecified.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/datum/Ellipsoid.html?is-external=true" title="class or interface in org.opengis.referencing.datum" class="externalLink">Ellipsoid</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTargetEllipsoid()">getTargetEllipsoid</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the ellipsoid of the target ellipsoidal coordinate system, or <code>null</code> if it does not apply.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSource(org.opengis.referencing.cs.CoordinateSystem)">setSource</a></span>&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystem.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">CoordinateSystem</a>&nbsp;cs)</code></th>
<td class="colLast">
<div class="block">Sets the source coordinate system to the given value.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSource(org.opengis.referencing.cs.EllipsoidalCS,org.opengis.referencing.datum.Ellipsoid)">setSource</a></span>&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/EllipsoidalCS.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">EllipsoidalCS</a>&nbsp;cs,
<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/datum/Ellipsoid.html?is-external=true" title="class or interface in org.opengis.referencing.datum" class="externalLink">Ellipsoid</a>&nbsp;ellipsoid)</code></th>
<td class="colLast">
<div class="block">Sets the source coordinate system and its associated ellipsoid to the given value.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTarget(org.opengis.referencing.cs.CoordinateSystem)">setTarget</a></span>&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystem.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">CoordinateSystem</a>&nbsp;cs)</code></th>
<td class="colLast">
<div class="block">Sets the target coordinate system to the given value.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTarget(org.opengis.referencing.cs.EllipsoidalCS,org.opengis.referencing.datum.Ellipsoid)">setTarget</a></span>&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/EllipsoidalCS.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">EllipsoidalCS</a>&nbsp;cs,
<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/datum/Ellipsoid.html?is-external=true" title="class or interface in org.opengis.referencing.datum" class="externalLink">Ellipsoid</a>&nbsp;ellipsoid)</code></th>
<td class="colLast">
<div class="block">Sets the target coordinate system and its associated ellipsoid to the given value.</div>
</td>
</tr>
</table>
<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#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.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/Object.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/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#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/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#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/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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Context</h4>
<pre>public&nbsp;Context()</pre>
<div class="block">Creates a new context with all properties initialized to <code>null</code>.</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="setSource(org.opengis.referencing.cs.CoordinateSystem)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSource</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setSource&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystem.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">CoordinateSystem</a>&nbsp;cs)</pre>
<div class="block">Sets the source coordinate system to the given value.
The source ellipsoid is unconditionally set to <code>null</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cs</code> - the coordinate system to set as the source (can be <code>null</code>).</dd>
</dl>
</li>
</ul>
<a id="setSource(org.opengis.referencing.cs.EllipsoidalCS,org.opengis.referencing.datum.Ellipsoid)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSource</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setSource&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/EllipsoidalCS.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">EllipsoidalCS</a>&nbsp;cs,
<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/datum/Ellipsoid.html?is-external=true" title="class or interface in org.opengis.referencing.datum" class="externalLink">Ellipsoid</a>&nbsp;ellipsoid)</pre>
<div class="block">Sets the source coordinate system and its associated ellipsoid to the given value.
<div class="note"><b>Design note:</b>
ellipsoidal coordinate systems and ellipsoids are associated indirectly, through a geodetic CRS.
However this method expects those two components to be given explicitly instead than inferring
them from a <code>Coordinate­Reference­System</code> for making clear that <code>Math­Transform­Factory</code>
does not perform any <a href="../../datum/DefaultGeodeticDatum.html" title="class in org.apache.sis.referencing.datum">geodetic
datum</a> analysis. For coordinate operations that take datum changes in account (including change
of prime meridian), see <a href="../DefaultCoordinateOperationFactory.html" title="class in org.apache.sis.referencing.operation"><code>Default­Coordinate­Operation­Factory</code></a>.
This policy helps to enforce a separation of concerns.</div></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cs</code> - the coordinate system to set as the source, or <code>null</code>.</dd>
<dd><code>ellipsoid</code> - the ellipsoid associated to the given coordinate system, or <code>null</code>.</dd>
</dl>
</li>
</ul>
<a id="setTarget(org.opengis.referencing.cs.CoordinateSystem)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTarget</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setTarget&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystem.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">CoordinateSystem</a>&nbsp;cs)</pre>
<div class="block">Sets the target coordinate system to the given value.
The target ellipsoid is unconditionally set to <code>null</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cs</code> - the coordinate system to set as the target (can be <code>null</code>).</dd>
</dl>
</li>
</ul>
<a id="setTarget(org.opengis.referencing.cs.EllipsoidalCS,org.opengis.referencing.datum.Ellipsoid)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTarget</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setTarget&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/EllipsoidalCS.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">EllipsoidalCS</a>&nbsp;cs,
<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/datum/Ellipsoid.html?is-external=true" title="class or interface in org.opengis.referencing.datum" class="externalLink">Ellipsoid</a>&nbsp;ellipsoid)</pre>
<div class="block">Sets the target coordinate system and its associated ellipsoid to the given value.
<div class="note"><b>Design note:</b>
see <a href="#setSource(org.opengis.referencing.cs.EllipsoidalCS,org.opengis.referencing.datum.Ellipsoid)"><code>set­Source(Ellipsoidal­CS, Ellipsoid)</code></a>.</div></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cs</code> - the coordinate system to set as the source, or <code>null</code>.</dd>
<dd><code>ellipsoid</code> - the ellipsoid associated to the given coordinate system, or <code>null</code>.</dd>
</dl>
</li>
</ul>
<a id="getSourceCS()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSourceCS</h4>
<pre class="methodSignature">public&nbsp;<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystem.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">CoordinateSystem</a>&nbsp;getSourceCS()</pre>
<div class="block">Returns the source coordinate system, or <code>null</code> if unspecified.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the source coordinate system, or <code>null</code>.</dd>
</dl>
</li>
</ul>
<a id="getSourceEllipsoid()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSourceEllipsoid</h4>
<pre class="methodSignature">public&nbsp;<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/datum/Ellipsoid.html?is-external=true" title="class or interface in org.opengis.referencing.datum" class="externalLink">Ellipsoid</a>&nbsp;getSourceEllipsoid()</pre>
<div class="block">Returns the ellipsoid of the source ellipsoidal coordinate system, or <code>null</code> if it does not apply.
This information is valid only if <a href="#getSourceCS()"><code>get­Source­CS()</code></a> returns an instance of <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/EllipsoidalCS.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink"><code>Ellipsoidal­CS</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the ellipsoid of the source ellipsoidal coordinate system, or <code>null</code> if it does not apply.</dd>
</dl>
</li>
</ul>
<a id="getTargetCS()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTargetCS</h4>
<pre class="methodSignature">public&nbsp;<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystem.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">CoordinateSystem</a>&nbsp;getTargetCS()</pre>
<div class="block">Returns the target coordinate system, or <code>null</code> if unspecified.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the target coordinate system, or <code>null</code>.</dd>
</dl>
</li>
</ul>
<a id="getTargetEllipsoid()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTargetEllipsoid</h4>
<pre class="methodSignature">public&nbsp;<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/datum/Ellipsoid.html?is-external=true" title="class or interface in org.opengis.referencing.datum" class="externalLink">Ellipsoid</a>&nbsp;getTargetEllipsoid()</pre>
<div class="block">Returns the ellipsoid of the target ellipsoidal coordinate system, or <code>null</code> if it does not apply.
This information is valid only if <a href="#getTargetCS()"><code>get­Target­CS()</code></a> returns an instance of <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/EllipsoidalCS.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink"><code>Ellipsoidal­CS</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the ellipsoid of the target ellipsoidal coordinate system, or <code>null</code> if it does not apply.</dd>
</dl>
</li>
</ul>
<a id="getMatrix(org.apache.sis.referencing.operation.transform.ContextualParameters.MatrixRole)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMatrix</h4>
<pre class="methodSignature">public&nbsp;<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/Matrix.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">Matrix</a>&nbsp;getMatrix&#8203;(<a href="ContextualParameters.MatrixRole.html" title="enum in org.apache.sis.referencing.operation.transform">ContextualParameters.MatrixRole</a>&nbsp;role)
throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/FactoryException.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">FactoryException</a></pre>
<div class="block">Returns the matrix that represent the affine transform to concatenate before or after
the parameterized transform. The <code>role</code> argument specifies which matrix is desired:
<ul class="verbose">
<li><a href="ContextualParameters.MatrixRole.html#NORMALIZATION"><code>NORMALIZATION</code></a> for the conversion from the <a href="#getSourceCS()">source coordinate system</a> to
a <a href="../../cs/AxesConvention.html#NORMALIZED">normalized</a> coordinate system, usually with
(<var>longitude</var>, <var>latitude</var>) axis order in degrees or
(<var>easting</var>, <var>northing</var>) in metres.
This normalization needs to be applied <em>before</em> the parameterized transform.</li>
<li><a href="ContextualParameters.MatrixRole.html#DENORMALIZATION"><code>DENORMALIZATION</code></a> for the conversion from a normalized coordinate system to the
<a href="#getTargetCS()">target coordinate system</a>, for example with
(<var>latitude</var>, <var>longitude</var>) axis order.
This denormalization needs to be applied <em>after</em> the parameterized transform.</li>
<li><a href="ContextualParameters.MatrixRole.html#INVERSE_NORMALIZATION"><code>INVERSE_NORMALIZATION</code></a> and
<a href="ContextualParameters.MatrixRole.html#INVERSE_DENORMALIZATION"><code>INVERSE_DENORMALIZATION</code></a>
are also supported but rarely used.</li>
</ul>
This method is invoked by <a href="DefaultMathTransformFactory.html#swapAndScaleAxes(org.opengis.referencing.operation.MathTransform,org.apache.sis.referencing.operation.transform.DefaultMathTransformFactory.Context)"><code>Default­Math­Transform­Factory​.swap­And­Scale­Axes(Math­Transform, Context)</code></a>.
Users an override this method if they need to customize the normalization process.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>role</code> - whether the normalization or denormalization matrix is desired.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the requested matrix, or <code>null</code> if this <code>Context</code> has no information about the coordinate system.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/FactoryException.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">Factory­Exception</a></code> - if an error occurred while computing the matrix.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="DefaultMathTransformFactory.html#createAffineTransform(org.opengis.referencing.operation.Matrix)"><code>Default­Math­Transform­Factory​.create­Affine­Transform(Matrix)</code></a>,
<a href="DefaultMathTransformFactory.html#createParameterizedTransform(org.opengis.parameter.ParameterValueGroup,org.apache.sis.referencing.operation.transform.DefaultMathTransformFactory.Context)"><code>Default­Math­Transform­Factory​.create­Parameterized­Transform(Parameter­Value­Group, Context)</code></a></dd>
</dl>
</li>
</ul>
<a id="getCompletedParameters()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getCompletedParameters</h4>
<pre class="methodSignature">public&nbsp;<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValueGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValueGroup</a>&nbsp;getCompletedParameters()</pre>
<div class="block">Returns the parameter values used for the math transform creation, including the parameters completed
by the factory.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the parameter values used by the factory.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">Illegal­State­Exception</a></code> - if <a href="DefaultMathTransformFactory.html#createParameterizedTransform(org.opengis.parameter.ParameterValueGroup,org.apache.sis.referencing.operation.transform.DefaultMathTransformFactory.Context)"><code>Default­Math­Transform­Factory​.create­Parameterized­Transform(Parameter­Value­Group, Context)</code></a>
has not yet been invoked.</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/DefaultMathTransformFactory.Context.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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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>