blob: 9bd5eba2f992b6aa56a6c957884152395906cc82 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 -->
<title>DefaultMathTransformFactory.Context (Apache SIS 1.4 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-10-05">
<meta name="description" content="declaration: module: org.apache.sis.referencing, package: org.apache.sis.referencing.operation.transform, class: DefaultMathTransformFactory, class: Context">
<meta name="generator" content="javadoc/ClassWriterImpl">
<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="getMethodUsed()">
<meta name="keywords" content="getContextualParameters()">
<meta name="keywords" content="getCompletedParameters()">
<meta name="keywords" content="toString()">
<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="../../../../../../../script-dir/jquery-ui.min.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var pathtoroot = "../../../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../../../index.html">Overview</a></li>
<li><a href="../../../../../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</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#class">Help</a></li>
</ul>
<ul class="sub-nav-list-small">
<li>
<p>Summary:</p>
<ul>
<li>Nested</li>
<li>Field</li>
<li><a href="#constructor-summary">Constr</a></li>
<li><a href="#method-summary">Method</a></li>
</ul>
</li>
<li>
<p>Detail:</p>
<ul>
<li>Field</li>
<li><a href="#constructor-detail">Constr</a></li>
<li><a href="#method-detail">Method</a></li>
</ul>
</li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list">
<ul class="sub-nav-list">
<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="sub-nav-list">
<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>
<div class="nav-list-search"><a href="../../../../../../../search.html">SEARCH</a>
<input type="text" id="search-input" disabled placeholder="Search">
<input type="reset" id="reset-button" disabled value="reset">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="module-label-in-type">Module</span>&nbsp;<a href="../../../../../../module-summary.html">org.apache.sis.referencing</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.referencing.operation.transform</a></div>
<h1 title="Class DefaultMathTransformFactory.Context" class="title">Class DefaultMathTransformFactory.Context</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
<div class="inheritance">Context</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code></dd>
</dl>
<dl class="notes">
<dt>Enclosing class:</dt>
<dd><code><a href="DefaultMathTransformFactory.html" title="class in org.apache.sis.referencing.operation.transform">Default­Math­Transform­Factory</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public static class </span><span class="element-name type-name-label">DefaultMathTransformFactory.Context</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
implements <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></span></div>
<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>
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.geoapi/org/opengis/referencing/operation/OperationMethod.html" title="class or interface in org.opengis.referencing.operation" class="external-link"><code>Operation­Method</code></a>,
for example <cite>"Longitude rotation"</cite> (EPSG:9601) for changing the prime meridian.
<h2 id="scope-heading">Scope</h2>
Instances of this class should be short-lived
(they exist only the time needed for creating a <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransform.html" title="class or interface in org.opengis.referencing.operation" class="external-link"><code>Math­Transform</code></a>)
and should not be shared (because they provide no immutability guarantees).
This class is not thread-safe.</div>
<dl class="notes">
<dt>Since:</dt>
<dd>0.7</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="../../../../../../../serialized-form.html#org.apache.sis.referencing.operation.transform.DefaultMathTransformFactory.Context">Serialized Form</a></li>
</ul>
</dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Context</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Creates a new context with all properties initialized to <code>null</code>.</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link">Parameter­Value­Group</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCompletedParameters()" class="member-name-link">get­Completed­Parameters</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the parameter values used for the math transform creation,
including the parameters completed by the factory.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><wbr>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getContextualParameters()" class="member-name-link">get­Contextual­Parameters</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the names of parameters that have been inferred from the context.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/Matrix.html" title="class or interface in org.opengis.referencing.operation" class="external-link">Matrix</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMatrix(org.apache.sis.referencing.operation.transform.ContextualParameters.MatrixRole)" class="member-name-link">get­Matrix</a><wbr>(<a href="ContextualParameters.MatrixRole.html" title="enum class in org.apache.sis.referencing.operation.transform">Contextual­Parameters​.Matrix­Role</a>&nbsp;role)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the matrix that represent the affine transform to concatenate before or after
the parameterized transform.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/OperationMethod.html" title="class or interface in org.opengis.referencing.operation" class="external-link">Operation­Method</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMethodUsed()" class="member-name-link">get­Method­Used</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the operation method used for the math transform creation.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/cs/CoordinateSystem.html" title="class or interface in org.opengis.referencing.cs" class="external-link">Coordinate­System</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSourceCS()" class="member-name-link">get­Source­CS</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the source coordinate system, or <code>null</code> if unspecified.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/datum/Ellipsoid.html" title="class or interface in org.opengis.referencing.datum" class="external-link">Ellipsoid</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSourceEllipsoid()" class="member-name-link">get­Source­Ellipsoid</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the ellipsoid of the source ellipsoidal coordinate system, or <code>null</code> if it does not apply.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/cs/CoordinateSystem.html" title="class or interface in org.opengis.referencing.cs" class="external-link">Coordinate­System</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTargetCS()" class="member-name-link">get­Target­CS</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the target coordinate system, or <code>null</code> if unspecified.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/datum/Ellipsoid.html" title="class or interface in org.opengis.referencing.datum" class="external-link">Ellipsoid</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTargetEllipsoid()" class="member-name-link">get­Target­Ellipsoid</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the ellipsoid of the target ellipsoidal coordinate system, or <code>null</code> if it does not apply.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSource(org.opengis.referencing.crs.GeodeticCRS)" class="member-name-link">set­Source</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/GeodeticCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link">Geodetic­CRS</a>&nbsp;crs)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the source coordinate system and related ellipsoid to the components of given CRS.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSource(org.opengis.referencing.cs.CoordinateSystem)" class="member-name-link">set­Source</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/cs/CoordinateSystem.html" title="class or interface in org.opengis.referencing.cs" class="external-link">Coordinate­System</a>&nbsp;cs)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the source coordinate system to the given value.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setTarget(org.opengis.referencing.crs.GeodeticCRS)" class="member-name-link">set­Target</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/GeodeticCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link">Geodetic­CRS</a>&nbsp;crs)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the target coordinate system and related ellipsoid to the components of given CRS.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setTarget(org.opengis.referencing.cs.CoordinateSystem)" class="member-name-link">set­Target</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/cs/CoordinateSystem.html" title="class or interface in org.opengis.referencing.cs" class="external-link">Coordinate­System</a>&nbsp;cs)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the target coordinate system to the given value.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">to­String</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns a string representation of this context for debugging purposes.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-Object">Methods inherited from class&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">get­Class</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hash­Code</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notify­All</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>Context</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Context</span>()</div>
<div class="block">Creates a new context with all properties initialized to <code>null</code>.</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="setSource(org.opengis.referencing.cs.CoordinateSystem)">
<h3>setSource</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setSource</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/cs/CoordinateSystem.html" title="class or interface in org.opengis.referencing.cs" class="external-link">CoordinateSystem</a>&nbsp;cs)</span></div>
<div class="block">Sets the source coordinate system to the given value.
The source ellipsoid is unconditionally set to <code>null</code>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>cs</code> - the coordinate system to set as the source (can be <code>null</code>).</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setSource(org.opengis.referencing.crs.GeodeticCRS)">
<h3>setSource</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setSource</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/GeodeticCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link">GeodeticCRS</a>&nbsp;crs)</span></div>
<div class="block">Sets the source coordinate system and related ellipsoid to the components of given CRS.
The <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/datum/Ellipsoid.html" title="class or interface in org.opengis.referencing.datum" class="external-link"><code>Ellipsoid</code></a>, fetched from the geodetic datum, is often used together with an <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/cs/EllipsoidalCS.html" title="class or interface in org.opengis.referencing.cs" class="external-link"><code>Ellipsoidal­CS</code></a>,
but not necessarily. The geodetic CRS may also be associated with a spherical or Cartesian coordinate system,
and the ellipsoid information may still be needed even with those non-ellipsoidal coordinate systems.
<p><strong>This method is not for datum shifts.</strong>
All datum information other than the ellipsoid are ignored.</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>crs</code> - the coordinate system and ellipsoid to set as the source, or <code>null</code>.</dd>
<dt>Since:</dt>
<dd>1.3</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setTarget(org.opengis.referencing.cs.CoordinateSystem)">
<h3>setTarget</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setTarget</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/cs/CoordinateSystem.html" title="class or interface in org.opengis.referencing.cs" class="external-link">CoordinateSystem</a>&nbsp;cs)</span></div>
<div class="block">Sets the target coordinate system to the given value.
The target ellipsoid is unconditionally set to <code>null</code>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>cs</code> - the coordinate system to set as the target (can be <code>null</code>).</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setTarget(org.opengis.referencing.crs.GeodeticCRS)">
<h3>setTarget</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setTarget</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/GeodeticCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link">GeodeticCRS</a>&nbsp;crs)</span></div>
<div class="block">Sets the target coordinate system and related ellipsoid to the components of given CRS.
The <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/datum/Ellipsoid.html" title="class or interface in org.opengis.referencing.datum" class="external-link"><code>Ellipsoid</code></a>, fetched from the geodetic datum, is often used together with an <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/cs/EllipsoidalCS.html" title="class or interface in org.opengis.referencing.cs" class="external-link"><code>Ellipsoidal­CS</code></a>,
but not necessarily. The geodetic CRS may also be associated with a spherical or Cartesian coordinate system,
and the ellipsoid information may still be needed even with those non-ellipsoidal coordinate systems.
<p><strong>This method is not for datum shifts.</strong>
All datum information other than the ellipsoid are ignored.</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>crs</code> - the coordinate system and ellipsoid to set as the target, or <code>null</code>.</dd>
<dt>Since:</dt>
<dd>1.3</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getSourceCS()">
<h3>getSourceCS</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/cs/CoordinateSystem.html" title="class or interface in org.opengis.referencing.cs" class="external-link">CoordinateSystem</a></span>&nbsp;<span class="element-name">getSourceCS</span>()</div>
<div class="block">Returns the source coordinate system, or <code>null</code> if unspecified.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the source coordinate system, or <code>null</code>.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getSourceEllipsoid()">
<h3>getSourceEllipsoid</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/datum/Ellipsoid.html" title="class or interface in org.opengis.referencing.datum" class="external-link">Ellipsoid</a></span>&nbsp;<span class="element-name">getSourceEllipsoid</span>()</div>
<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.geoapi/org/opengis/referencing/cs/EllipsoidalCS.html" title="class or interface in org.opengis.referencing.cs" class="external-link"><code>Ellipsoidal­CS</code></a>.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the ellipsoid of the source ellipsoidal coordinate system, or <code>null</code> if it does not apply.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getTargetCS()">
<h3>getTargetCS</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/cs/CoordinateSystem.html" title="class or interface in org.opengis.referencing.cs" class="external-link">CoordinateSystem</a></span>&nbsp;<span class="element-name">getTargetCS</span>()</div>
<div class="block">Returns the target coordinate system, or <code>null</code> if unspecified.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the target coordinate system, or <code>null</code>.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getTargetEllipsoid()">
<h3>getTargetEllipsoid</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/datum/Ellipsoid.html" title="class or interface in org.opengis.referencing.datum" class="external-link">Ellipsoid</a></span>&nbsp;<span class="element-name">getTargetEllipsoid</span>()</div>
<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.geoapi/org/opengis/referencing/cs/EllipsoidalCS.html" title="class or interface in org.opengis.referencing.cs" class="external-link"><code>Ellipsoidal­CS</code></a>.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the ellipsoid of the target ellipsoidal coordinate system, or <code>null</code> if it does not apply.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getMatrix(org.apache.sis.referencing.operation.transform.ContextualParameters.MatrixRole)">
<h3>getMatrix</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/Matrix.html" title="class or interface in org.opengis.referencing.operation" class="external-link">Matrix</a></span>&nbsp;<span class="element-name">getMatrix</span><wbr><span class="parameters">(<a href="ContextualParameters.MatrixRole.html" title="enum class in org.apache.sis.referencing.operation.transform">ContextualParameters.MatrixRole</a>&nbsp;role)</span>
throws <span class="exceptions"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/FactoryException.html" title="class or interface in org.opengis.util" class="external-link">FactoryException</a></span></div>
<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 class="notes">
<dt>Parameters:</dt>
<dd><code>role</code> - whether the normalization or denormalization matrix is desired.</dd>
<dt>Returns:</dt>
<dd>the requested matrix, or <code>null</code> if this <code>Context</code> has no information about the coordinate system.</dd>
<dt>Throws:</dt>
<dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/FactoryException.html" title="class or interface in org.opengis.util" class="external-link">Factory­Exception</a></code> - if an error occurred while computing the matrix.</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list-long">
<li><a href="DefaultMathTransformFactory.html#createAffineTransform(org.opengis.referencing.operation.Matrix)"><code>Default­Math­Transform­Factory​.create­Affine­Transform(Matrix)</code></a></li>
<li><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></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getMethodUsed()">
<h3>getMethodUsed</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/OperationMethod.html" title="class or interface in org.opengis.referencing.operation" class="external-link">OperationMethod</a></span>&nbsp;<span class="element-name">getMethodUsed</span>()</div>
<div class="block">Returns the operation method used for the math transform creation.
This is the same information than <a href="DefaultMathTransformFactory.html#getLastMethodUsed()"><code>Default­Math­Transform­Factory​.get­Last­Method­Used()</code></a> but more stable
(not affected by transforms created with other contexts).</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the operation method used by the factory.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">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>
<dt>Since:</dt>
<dd>1.3</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list-long">
<li><a href="DefaultMathTransformFactory.html#getLastMethodUsed()"><code>Default­Math­Transform­Factory​.get­Last­Method­Used()</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getContextualParameters()">
<h3>getContextualParameters</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>&gt;</span>&nbsp;<span class="element-name">getContextualParameters</span>()</div>
<div class="block">Returns the names of parameters that have been inferred from the context.
The set of keys can contain any of <code>"dim"</code>,
<code> "semi_major"</code>, <code> "semi_minor"</code>,
<code>"src_semi_major"</code>, <code>"src_semi_minor"</code>,
<code>"tgt_semi_major"</code>, <code>"tgt_semi_minor"</code> and/or
<code>"inverse_flattening"</code>, depending on the operation method used.
The parameters named in that set are included in the parameters
returned by <a href="#getCompletedParameters()"><code>get­Completed­Parameters()</code></a>.
<h4 id="associated-boolean-values-heading">Associated boolean values</h4>
The associated boolean in the map tells whether the named parameter value is really contextual.
The boolean is <code>FALSE</code> if the user explicitly specified a value in the parameters given to
the <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> method,
and that value is different than the value inferred from the context.
Such inconsistencies are also logged at <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/Level.html#WARNING" title="class or interface in java.util.logging" class="external-link"><code>Level​.WARNING</code></a>.
In all other cases
(no value specified by the user, or a value was specified but is consistent with the context),
the associated boolean in the map is <code>TRUE</code>.
<h4 id="mutability-heading">Mutability</h4>
The returned map is modifiable for making easier for callers to amend the contextual information.
This map is not used by <code>Context</code> except for information purposes (e.g. in <a href="#toString()"><code>to­String()</code></a>).
In particular, modifications of this map have no incidence on the created <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransform.html" title="class or interface in org.opengis.referencing.operation" class="external-link"><code>Math­Transform</code></a>.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>names of parameters inferred from context.</dd>
<dt>Since:</dt>
<dd>1.3</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getCompletedParameters()">
<h3>getCompletedParameters</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValueGroup</a></span>&nbsp;<span class="element-name">getCompletedParameters</span>()</div>
<div class="block">Returns the parameter values used for the math transform creation,
including the parameters completed by the factory.
The parameters inferred from the context are listed by <a href="#getContextualParameters()"><code>get­Contextual­Parameters()</code></a>.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the parameter values used by the factory.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">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>
</section>
</li>
<li>
<section class="detail" id="toString()">
<h3>toString</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">toString</span>()</div>
<div class="block">Returns a string representation of this context for debugging purposes.
Current implementation write the name of source/target coordinate systems and ellipsoids.
If <a href="#getContextualParameters()">contextual parameters</a> have already been inferred,
then their names are appended with inconsistent parameters (if any) written on a separated line.</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">to­String</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
<dt>Returns:</dt>
<dd>a string representation of this context.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>