blob: 7b49211ed49ca32a81821d454a7cf4545308d57e [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>TransformSeparator (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.TransformSeparator class">
<meta name="keywords" content="transform">
<meta name="keywords" content="sourceDimensions">
<meta name="keywords" content="targetDimensions">
<meta name="keywords" content="clear()">
<meta name="keywords" content="addSourceDimensions()">
<meta name="keywords" content="addSourceDimensionRange()">
<meta name="keywords" content="getSourceDimensions()">
<meta name="keywords" content="addTargetDimensions()">
<meta name="keywords" content="addTargetDimensionRange()">
<meta name="keywords" content="getTargetDimensions()">
<meta name="keywords" content="separate()">
<meta name="keywords" content="filterSourceDimensions()">
<meta name="keywords" content="filterTargetDimensions()">
<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="TransformSeparator (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/TransformSeparator.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="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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 TransformSeparator" class="title">Class TransformSeparator</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>TransformSeparator</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">TransformSeparator</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></pre>
<div class="block">Extracts a sub-transform from a given <code>Math­Transform</code> and source or target dimension indices.
Given an arbitrary <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>Math­Transform</code></a>, this class tries to return a new math transform that operates
only on a given set of source or target dimensions.
<div class="note"><b>Example:</b>
if the supplied <code>transform</code> has (<var>x</var>,<var>y</var>,<var>z</var>) inputs
and (<var>λ</var>,<var>φ</var>,<var>h</var>) outputs, then the following code:
<blockquote><pre>TransformSeparator s = <font color="green">new</font> <b>TransformSeparator</b>(theTransform);
s.<b>addSourceDimensionRange</b>(0, 2);
MathTransform mt = s.<b>separate</b>();</pre></blockquote>
will return a transform with (<var>x</var>,<var>y</var>) inputs and (probably) (<var>λ</var>,<var>φ</var>) outputs.
The output dimensions can be verified with a call to <a href="#getTargetDimensions()"><code>get­Target­Dimensions()</code></a>.</div></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.7</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">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sourceDimensions">sourceDimensions</a></span></code></th>
<td class="colLast">
<div class="block">Indices of transform input dimensions to keep, or <code>null</code> if not yet defined.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#targetDimensions">targetDimensions</a></span></code></th>
<td class="colLast">
<div class="block">Indices of transform output dimensions to keep, or <code>null</code> if not yet defined.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">MathTransform</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#transform">transform</a></span></code></th>
<td class="colLast">
<div class="block">The transform to separate.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== 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(org.opengis.referencing.operation.MathTransform)">TransformSeparator</a></span>&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">MathTransform</a>&nbsp;transform)</code></th>
<td class="colLast">
<div class="block">Constructs a separator for the given transform.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.opengis.referencing.operation.MathTransform,org.opengis.referencing.operation.MathTransformFactory)">TransformSeparator</a></span>&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">MathTransform</a>&nbsp;transform,
<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransformFactory.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">MathTransformFactory</a>&nbsp;factory)</code></th>
<td class="colLast">
<div class="block">Constructs a separator for the given transform and using the given factory.</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>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addSourceDimensionRange(int,int)">addSourceDimensionRange</a></span>&#8203;(int&nbsp;lower,
int&nbsp;upper)</code></th>
<td class="colLast">
<div class="block">Adds a range of input dimensions to keep in the separated transform.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addSourceDimensions(int...)">addSourceDimensions</a></span>&#8203;(int...&nbsp;dimensions)</code></th>
<td class="colLast">
<div class="block">Adds input dimensions to keep in the separated transform.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addTargetDimensionRange(int,int)">addTargetDimensionRange</a></span>&#8203;(int&nbsp;lower,
int&nbsp;upper)</code></th>
<td class="colLast">
<div class="block">Adds a range of output dimensions to keep in the separated transform.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addTargetDimensions(int...)">addTargetDimensions</a></span>&#8203;(int...&nbsp;dimensions)</code></th>
<td class="colLast">
<div class="block">Adds output dimensions to keep in the separated transform.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clear()">clear</a></span>()</code></th>
<td class="colLast">
<div class="block">Resets this transform separator in the same state than after construction.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">MathTransform</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#filterSourceDimensions(org.opengis.referencing.operation.MathTransform,int%5B%5D)">filterSourceDimensions</a></span>&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">MathTransform</a>&nbsp;step,
int[]&nbsp;dimensions)</code></th>
<td class="colLast">
<div class="block">Creates a transform for the same mathematic than the given <code>step</code>
but expecting only the given dimensions as inputs.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">MathTransform</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#filterTargetDimensions(org.opengis.referencing.operation.MathTransform,int%5B%5D)">filterTargetDimensions</a></span>&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">MathTransform</a>&nbsp;step,
int[]&nbsp;dimensions)</code></th>
<td class="colLast">
<div class="block">Creates a transform for the same mathematic than the given <code>step</code>
but producing only the given dimensions as outputs.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSourceDimensions()">getSourceDimensions</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the input dimensions to keep or kept in the separated transform.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTargetDimensions()">getTargetDimensions</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the output dimensions to keep or kept in the separated transform.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">MathTransform</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#separate()">separate</a></span>()</code></th>
<td class="colLast">
<div class="block">Separates the math transform specified at construction time for given dimension indices.</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">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="transform">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>transform</h4>
<pre>protected final&nbsp;<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">MathTransform</a> transform</pre>
<div class="block">The transform to separate.</div>
</li>
</ul>
<a id="sourceDimensions">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sourceDimensions</h4>
<pre>protected&nbsp;int[] sourceDimensions</pre>
<div class="block">Indices of transform input dimensions to keep, or <code>null</code> if not yet defined.
If non-null, the indices in the array must be sorted in strictly increasing order.
This sequence can contain any integers in the range 0 inclusive to
<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true#getSourceDimensions()" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>Math­Transform​.get­Source­Dimensions()</code></a> exclusive.
<p>Values in this array should never be modified. For adding, removing or editing indices,
new arrays should be created and assigned to this field. This approach makes easier to keep snapshots
of indices arrays at various stages during the process of separating a <code>Math­Transform</code>.</p></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#getSourceDimensions()"><code>get­Source­Dimensions()</code></a>,
<a href="#addSourceDimensions(int...)"><code>add­Source­Dimensions(int...)</code></a>,
<a href="#addSourceDimensionRange(int,int)"><code>add­Source­Dimension­Range(int, int)</code></a></dd>
</dl>
</li>
</ul>
<a id="targetDimensions">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>targetDimensions</h4>
<pre>protected&nbsp;int[] targetDimensions</pre>
<div class="block">Indices of transform output dimensions to keep, or <code>null</code> if not yet defined.
If non-null, the indices in the array must be sorted in strictly increasing order.
This sequence can contain any integers in the range 0 inclusive to
<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true#getTargetDimensions()" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>Math­Transform​.get­Target­Dimensions()</code></a> exclusive.
<p>Values in this array should never be modified. For adding, removing or editing indices,
new arrays should be created and assigned to this field. This approach makes easier to keep snapshots
of indices arrays at various stages during the process of separating a <code>Math­Transform</code>.</p></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#getTargetDimensions()"><code>get­Target­Dimensions()</code></a>,
<a href="#addTargetDimensions(int...)"><code>add­Target­Dimensions(int...)</code></a>,
<a href="#addTargetDimensionRange(int,int)"><code>add­Target­Dimension­Range(int, int)</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= 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;(org.opengis.referencing.operation.MathTransform)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TransformSeparator</h4>
<pre>public&nbsp;TransformSeparator&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">MathTransform</a>&nbsp;transform)</pre>
<div class="block">Constructs a separator for the given transform.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>transform</code> - the transform to separate.</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(org.opengis.referencing.operation.MathTransform,org.opengis.referencing.operation.MathTransformFactory)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TransformSeparator</h4>
<pre>public&nbsp;TransformSeparator&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">MathTransform</a>&nbsp;transform,
<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransformFactory.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">MathTransformFactory</a>&nbsp;factory)</pre>
<div class="block">Constructs a separator for the given transform and using the given factory.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>transform</code> - the transform to separate.</dd>
<dd><code>factory</code> - the factory to use for creating new math transforms, or <code>null</code> if none.</dd>
</dl>
</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="clear()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;clear()</pre>
<div class="block">Resets this transform separator in the same state than after construction. This method clears any
<a href="#getSourceDimensions()">source dimensions</a> and <a href="#getTargetDimensions()">target dimensions</a> settings.
This method can be invoked when the same <code>Math­Transform</code> needs to be separated in more than one part,
for example an horizontal and a vertical component.</div>
</li>
</ul>
<a id="addSourceDimensions(int...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addSourceDimensions</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;addSourceDimensions&#8203;(int...&nbsp;dimensions)
throws <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">IllegalArgumentException</a></pre>
<div class="block">Adds input dimensions to keep in the separated transform.
The given values are <em>source</em> dimension indices of the transform given to the constructor.
<p>Constraints:</p>
<ul>
<li>All numbers shall be in the range 0 inclusive to <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true#getSourceDimensions()" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>Math­Transform​.get­Source­Dimensions()</code></a> exclusive.</li>
<li>The <code>dimensions</code> values shall be in strictly increasing order.</li>
<li>The <code>dimensions</code> values shall be greater than all values specified by all previous calls
of this method since construction or since the last call to <a href="#clear()"><code>clear()</code></a>.</li>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dimensions</code> - a sequence of source dimensions to keep, in strictly increasing order.</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 <code>dimensions</code> contains negative values
or if values are not in a strictly increasing order.</dd>
</dl>
</li>
</ul>
<a id="addSourceDimensionRange(int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addSourceDimensionRange</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;addSourceDimensionRange&#8203;(int&nbsp;lower,
int&nbsp;upper)
throws <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">IllegalArgumentException</a></pre>
<div class="block">Adds a range of input dimensions to keep in the separated transform.
The <code>lower</code> and <code>upper</code> values define a range of <em>source</em> dimension indices
of the transform given to the constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>lower</code> - the lower dimension, inclusive. Shall not be smaller than 0.</dd>
<dd><code>upper</code> - the upper dimension, exclusive. Shall be smaller than <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true#getSourceDimensions()" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>Math­Transform​.get­Source­Dimensions()</code></a>.</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 <code>lower</code> or <code>upper</code> are out of bounds.</dd>
</dl>
</li>
</ul>
<a id="getSourceDimensions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSourceDimensions</h4>
<pre class="methodSignature">public&nbsp;int[]&nbsp;getSourceDimensions()
throws <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">IllegalStateException</a></pre>
<div class="block">Returns the input dimensions to keep or kept in the separated transform.
This method performs the first applicable action in the following list:
<ol class="verbose">
<li>Source dimensions have been explicitly set by at least one call to <a href="#addSourceDimensions(int...)"><code>add­Source­Dimensions(int...)</code></a>
or <a href="#addSourceDimensionRange(int,int)"><code>add­Source­Dimension­Range(int, int)</code></a> since construction or since last call to <a href="#clear()"><code>clear()</code></a>.
In such case, this method returns all specified source dimensions.</li>
<li>No source dimensions were set but <a href="#separate()"><code>separate()</code></a> has been invoked.
In such case, this method returns the sequence of source dimensions that <code>separate()</code> chooses to retain.
It may be all source dimensions of the transform given at construction time, but not necessarily.</li>
<li>Otherwise an exception is thrown.</li>
</ol>
If source dimensions have not been set explicitly, <code>Transform­Separator</code> tries to reduce
the set of source dimensions to the smallest set required for computing the target dimensions.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the input dimension as a sequence of strictly increasing values.</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 input dimensions have not been set and
<a href="#separate()"><code>separate()</code></a> has not yet been invoked.</dd>
</dl>
</li>
</ul>
<a id="addTargetDimensions(int...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addTargetDimensions</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;addTargetDimensions&#8203;(int...&nbsp;dimensions)
throws <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">IllegalArgumentException</a></pre>
<div class="block">Adds output dimensions to keep in the separated transform.
The given values are <em>target</em> dimension indices of the transform given to the constructor.
<p>Constraints:</p>
<ul>
<li>All numbers shall be in the range 0 inclusive to <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true#getTargetDimensions()" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>Math­Transform​.get­Target­Dimensions()</code></a> exclusive.</li>
<li>The <code>dimensions</code> values shall be in strictly increasing order.</li>
<li>The <code>dimensions</code> values shall be greater than all values specified by all previous calls
of this method since construction or since the last call to <a href="#clear()"><code>clear()</code></a>.</li>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dimensions</code> - a sequence of target dimensions to keep, in strictly increasing order.</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 <code>dimensions</code> contains negative values
or if values are not in a strictly increasing order.</dd>
</dl>
</li>
</ul>
<a id="addTargetDimensionRange(int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addTargetDimensionRange</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;addTargetDimensionRange&#8203;(int&nbsp;lower,
int&nbsp;upper)
throws <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">IllegalArgumentException</a></pre>
<div class="block">Adds a range of output dimensions to keep in the separated transform.
The <code>lower</code> and <code>upper</code> values define a range of <em>target</em> dimension indices
of the transform given to the constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>lower</code> - the lower dimension, inclusive. Shall not be smaller than 0.</dd>
<dd><code>upper</code> - the upper dimension, exclusive. Shall be smaller than <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true#getTargetDimensions()" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>Math­Transform​.get­Target­Dimensions()</code></a>.</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 <code>lower</code> or <code>upper</code> are out of bounds.</dd>
</dl>
</li>
</ul>
<a id="getTargetDimensions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTargetDimensions</h4>
<pre class="methodSignature">public&nbsp;int[]&nbsp;getTargetDimensions()
throws <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">IllegalStateException</a></pre>
<div class="block">Returns the output dimensions to keep or kept in the separated transform.
This method performs the first applicable action in the following list:
<ol class="verbose">
<li>Target dimensions have been explicitly set by at least one call to <a href="#addTargetDimensions(int...)"><code>add­Target­Dimensions(int...)</code></a>
or <a href="#addTargetDimensionRange(int,int)"><code>add­Target­Dimension­Range(int, int)</code></a> since construction or since last call to <a href="#clear()"><code>clear()</code></a>.
In such case, this method returns all specified target dimensions.</li>
<li>No target dimensions were set but <a href="#separate()"><code>separate()</code></a> has been invoked.
In such case, the target dimensions are inferred automatically from the <a href="#getSourceDimensions()">source dimensions</a> and the transform.</li>
<li>Otherwise an exception is thrown.</li>
</ol></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the output dimension as a sequence of strictly increasing values.</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 output dimensions have not been set and
<a href="#separate()"><code>separate()</code></a> has not yet been invoked.</dd>
</dl>
</li>
</ul>
<a id="separate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>separate</h4>
<pre class="methodSignature">public&nbsp;<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">MathTransform</a>&nbsp;separate()
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">Separates the math transform specified at construction time for given dimension indices.
This method creates a math transform that use only the <a href="#addSourceDimensions(int...)">specified
source dimensions</a> and return only the <a href="#addTargetDimensions(int...)">specified target dimensions</a>.
If the source or target dimensions were not specified, then they will be inferred as below:
<ul class="verbose">
<li>If source dimensions were unspecified, then the returned transform will keep only the source dimensions
needed for computing the specified target dimensions. If all source dimensions need to be kept,
then they should be <a href="#addSourceDimensionRange(int,int)">specified explicitly</a>.</li>
<li>If target dimensions were unspecified, then the returned transform will expect only the specified
source dimensions as inputs, and the target dimensions will be inferred automatically.</li>
<li>If neither source and target positions were specified, then the returned transform will have the same
set of target dimensions, but only the set of source dimensions required for computing those targets.
In other words, this method drops unused source dimensions.</li>
</ul>
The source and target dimensions actually used can be queried by calls to <a href="#getSourceDimensions()"><code>get­Source­Dimensions()</code></a>
or <a href="#getTargetDimensions()"><code>get­Target­Dimensions()</code></a> after this <code>separate()</code> method.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the separated math transform.</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 the transform can not be separated.</dd>
</dl>
</li>
</ul>
<a id="filterSourceDimensions(org.opengis.referencing.operation.MathTransform,int[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>filterSourceDimensions</h4>
<pre class="methodSignature">protected&nbsp;<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">MathTransform</a>&nbsp;filterSourceDimensions&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">MathTransform</a>&nbsp;step,
int[]&nbsp;dimensions)
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">Creates a transform for the same mathematic than the given <code>step</code>
but expecting only the given dimensions as inputs.
This method is invoked by <a href="#separate()"><code>separate()</code></a> when user-specified source dimensions need to be taken in account.
The given <code>step</code> and <code>dimensions</code> are typically the values of
<a href="#transform"><code>transform</code></a> and <a href="#sourceDimensions"><code>source­Dimensions</code></a> fields respectively, but not necessarily.
In particular those arguments will differ when this method is invoked recursively for processing
concatenated or <a href="PassThroughTransform.html#getSubTransform()">sub-transforms</a>.
<p>Subclasses can override this method if they need to handle some <code>Math­Transform</code> implementations
in a special way. However all implementations of this method shall obey to the following contract:</p>
<ul class="verbose">
<li><a href="#sourceDimensions"><code>source­Dimensions</code></a> and <a href="#targetDimensions"><code>target­Dimensions</code></a> should not be assumed accurate
since they may be temporarily outdated or modified during recursive calls to this method.</li>
<li><a href="#sourceDimensions"><code>source­Dimensions</code></a> should not be modified by this method.</li>
<li><a href="#targetDimensions"><code>target­Dimensions</code></a> <strong>must</strong> be <em>overwritten</em> (not updated) by this method to the
sequence of all target dimensions of <code>step</code> that are also target dimensions of the returned transform.
The indices shall be in strictly increasing order from 0 inclusive to
<code>step​.get­Target­Dimensions()</code> exclusive.</li>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>step</code> - the transform for which to retain only a subset of the source dimensions.</dd>
<dd><code>dimensions</code> - indices of the source dimensions of <code>step</code> to retain.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a transform expecting only the given source dimensions.</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 the given transform is not separable.</dd>
</dl>
</li>
</ul>
<a id="filterTargetDimensions(org.opengis.referencing.operation.MathTransform,int[])">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>filterTargetDimensions</h4>
<pre class="methodSignature">protected&nbsp;<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">MathTransform</a>&nbsp;filterTargetDimensions&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">MathTransform</a>&nbsp;step,
int[]&nbsp;dimensions)
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">Creates a transform for the same mathematic than the given <code>step</code>
but producing only the given dimensions as outputs.
This method is invoked by <a href="#separate()"><code>separate()</code></a> when user-specified target dimensions need to be taken in account.
The given <code>step</code> and <code>dimensions</code> are typically the values of
<a href="#transform"><code>transform</code></a> and <a href="#targetDimensions"><code>target­Dimensions</code></a> fields respectively, but not necessarily.
<p>Subclasses can override this method if they need to handle some <code>Math­Transform</code> implementations
in a special way. However all implementations of this method shall obey to the following contract:</p>
<ul>
<li><a href="#sourceDimensions"><code>source­Dimensions</code></a> and <a href="#targetDimensions"><code>target­Dimensions</code></a> should not be assumed accurate.</li>
<li><a href="#sourceDimensions"><code>source­Dimensions</code></a> should not be modified by this method.</li>
<li><a href="#targetDimensions"><code>target­Dimensions</code></a> should not be modified by this method.</li>
</ul>
The number and nature of inputs stay unchanged. For example if the supplied <code>transform</code>
has (<var>longitude</var>, <var>latitude</var>, <var>height</var>) outputs, then a filtered
transform may keep only the (<var>longitude</var>, <var>latitude</var>) part for the same inputs.
In most cases, the filtered transform is non-invertible since it looses information.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>step</code> - the transform for which to retain only a subset of the target dimensions.</dd>
<dd><code>dimensions</code> - indices of the target dimensions of <code>step</code> to retain.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a transform producing only the given target dimensions.</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 the given transform is not separable.</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/TransformSeparator.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="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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>