blob: deb9d3ff19e1deb84f52f2046d067ee7b91b1286 [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>TensorParameters (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.parameter.TensorParameters class">
<meta name="keywords" content="ALPHANUM">
<meta name="keywords" content="WKT1">
<meta name="keywords" content="prefix">
<meta name="keywords" content="separator">
<meta name="keywords" content="getElementType()">
<meta name="keywords" content="rank()">
<meta name="keywords" content="getDimensionDescriptor()">
<meta name="keywords" content="getElementDescriptor()">
<meta name="keywords" content="createElementDescriptor()">
<meta name="keywords" content="indicesToName()">
<meta name="keywords" content="nameToIndices()">
<meta name="keywords" content="getDefaultValue()">
<meta name="keywords" content="getAllDescriptors()">
<meta name="keywords" content="createValueGroup()">
<meta name="keywords" content="toMatrix()">
<meta name="keywords" content="hashCode()">
<meta name="keywords" content="equals()">
<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="TensorParameters (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,"i10":10,"i11":10,"i12":10,"i13":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/TensorParameters.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.parameter</a></div>
<h2 title="Class TensorParameters" class="title">Class TensorParameters&lt;E&gt;</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>TensorParameters&lt;E&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>E</code> - the type of tensor element values.</dd>
</dl>
<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>
<hr>
<pre>public class <span class="typeNameLabel">TensorParameters&lt;E&gt;</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">Creates parameter groups for tensors (usually matrices).
Matrices are handled as a special case of tensors (<cite>second-order</cite> tensors).
<p>Each group of parameters contains the following elements:</p>
<ul>
<li>Parameters (usually mandatory) for the tensor dimensions:
<ul>
<li>number of rows (named <code>"num_row"</code> in <a href="#WKT1">WKT1</a> conventions),</li>
<li>number of columns (named <code>"num_col"</code> in WKT1 conventions),</li>
<li><i>etc.</i> for third-order or higher-order tensors.</li>
</ul>
</li>
<li>A maximum of <code>num_row</code> × <code>num_col</code> × … optional parameters for the matrix or tensor element values.
Parameter names depend on the formatting convention.</li>
</ul>
For all matrix or tensor elements, the default value is 1 for elements on the diagonal (where all indices have
the same value) and 0 for all other elements. Those default values defines an <cite>identity matrix</cite>,
or (more generally) <cite>Kroenecker delta tensor</cite>.
<p><b>Parameters are not an efficient storage format for large tensors.</b>
Parameters are used only for small matrices/tensors to be specified in coordinate operations or processing libraries.
In particular, those parameters integrate well in <cite>Well Known Text</cite> (WKT) format.
For a more efficient matrix storage,
see the <a href="../referencing/operation/matrix/package-summary.html">matrix package</a>.</p>
<div class="section">Formatting</div>
In the particular case of a tensor of <a href="#rank()">rank</a> 2 (i.e. a matrix),
the parameters are typically formatted as below. Note that in the EPSG convention,
the matrix is implicitly <a href="../referencing/operation/matrix/Matrices.html#isAffine(org.opengis.referencing.operation.Matrix)">affine</a> and of dimension 3×3.
<table class="sis">
<caption>Well Known Text (WKT) formats for matrix parameters</caption>
<tr>
<th>Using EPSG:9624 names and identifiers</th>
<th class="sep">Using OGC names</th>
</tr>
<tr><td>
<blockquote><pre>Parameter["A0", &lt;value&gt;, Id["EPSG", 8623]],
Parameter["A1", &lt;value&gt;, Id["EPSG", 8624]],
Parameter["A2", &lt;value&gt;, Id["EPSG", 8625]],
Parameter["B0", &lt;value&gt;, Id["EPSG", 8639]],
Parameter["B1", &lt;value&gt;, Id["EPSG", 8640]],
Parameter["B2", &lt;value&gt;, Id["EPSG", 8641]]</pre></blockquote>
<div class="note"><b>Note:</b>
the EPSG database contains also A3, A4, A5, A6, A7, A8 and B3 parameters,
but they are for polynomial transformations, not for affine transformations.</div>
</td><td class="sep">
<blockquote><pre>Parameter["num_row", 3],
Parameter["num_col", 3],
Parameter["elt_0_0", &lt;value&gt;],
Parameter["elt_0_1", &lt;value&gt;],
...
Parameter["elt_0_&lt;num_col-1&gt;", &lt;value&gt;],
Parameter["elt_1_0", &lt;value&gt;],
Parameter["elt_1_1", &lt;value&gt;],
...
Parameter["elt_&lt;num_row-1&gt;_&lt;num_col-1&gt;", &lt;value&gt;]</pre></blockquote>
</td></tr></table>
Those groups are extensible, i.e. the number of <code>"elt_<var>row</var>_<var>col</var>"</code> parameters
depends on the <code>"num_row"</code> and <code>"num_col"</code> parameter values. For this reason, the descriptor of
matrix or tensor parameters is not immutable.
<div class="section">Usage examples</div>
For creating a new group of parameters for a matrix using the <a href="#WKT1"><code>WKT1</code></a> naming conventions,
one can use the following code:
<blockquote><pre>Map&lt;String,?&gt; properties = Collections.<b>singletonMap</b>(ParameterValueGroup.NAME_KEY, <font color="orangered">"Affine"</font>);
ParameterValueGroup p = TensorParameters.WKT1.<b>createValueGroup</b>(properties);</pre></blockquote>
For setting the elements of a few values, then create a matrix from the parameter values:
<blockquote><pre>p.<b>parameter</b>(<font color="orangered">"elt_0_0"</font>).<b>setValue</b>(4); <i><font color="gray">// "A0" also accepted as a synonymous of "elt_0_0".</font></i>
p.<b>parameter</b>(<font color="orangered">"elt_1_1"</font>).<b>setValue</b>(6); <i><font color="gray">// "B1" also accepted as a synonymous of "elt_1_1".</font></i>
Matrix m = TensorParameters.WKT1.<b>toMatrix</b>(p);</pre></blockquote></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.4</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../referencing/operation/matrix/Matrices.html" title="class in org.apache.sis.referencing.operation.matrix"><code>Matrices</code></a>,
<a href="../../../../serialized-form.html#org.apache.sis.parameter.TensorParameters">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">
<!-- =========== 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>static <a href="TensorParameters.html" title="class in org.apache.sis.parameter">TensorParameters</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang" class="externalLink">Double</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ALPHANUM">ALPHANUM</a></span></code></th>
<td class="colLast">
<div class="block">Parses and creates matrix parameters with alphanumeric names.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#prefix">prefix</a></span></code></th>
<td class="colLast">
<div class="block">The prefix of parameter names for tensor elements.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#separator">separator</a></span></code></th>
<td class="colLast">
<div class="block">The separator between row and column in parameter names for tensor elements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="TensorParameters.html" title="class in org.apache.sis.parameter">TensorParameters</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang" class="externalLink">Double</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#WKT1">WKT1</a></span></code></th>
<td class="colLast">
<div class="block">Parses and creates matrix parameters with names matching the
<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/doc-files/WKT.html">Well Known Text</a>
version 1 (WKT 1) convention.</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(java.lang.Class,java.lang.String,java.lang.String,org.opengis.parameter.ParameterDescriptor...)">TensorParameters</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;<a href="TensorParameters.html" title="type parameter in TensorParameters">E</a>&gt;&nbsp;elementType,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;prefix,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;separator,
<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptor</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>&gt;...&nbsp;dimensions)</code></th>
<td class="colLast">
<div class="block">Constructs a descriptors provider.</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>protected <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptor</a>&lt;<a href="TensorParameters.html" title="type parameter in TensorParameters">E</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createElementDescriptor(int%5B%5D)">createElementDescriptor</a></span>&#8203;(int[]&nbsp;indices)</code></th>
<td class="colLast">
<div class="block">Creates a new parameter descriptor for a matrix or tensor element at the given indices.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<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="#createValueGroup(java.util.Map)">createValueGroup</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;?&gt;&nbsp;properties)</code></th>
<td class="colLast">
<div class="block">Creates a new instance of parameter group with default values of 1 on the diagonal, and 0 everywhere else.</div>
</td>
</tr>
<tr id="i2" 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="#createValueGroup(java.util.Map,org.opengis.referencing.operation.Matrix)">createValueGroup</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;?&gt;&nbsp;properties,
<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;matrix)</code></th>
<td class="colLast">
<div class="block">Creates a new instance of parameter group initialized to the given matrix.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>&#8203;(<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>&nbsp;other)</code></th>
<td class="colLast">
<div class="block">Compares this object with the given object for equality.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptor</a>&lt;?&gt;[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllDescriptors(int...)">getAllDescriptors</a></span>&#8203;(int...&nbsp;actualSize)</code></th>
<td class="colLast">
<div class="block">Returns all parameters in this group for a tensor of the specified dimensions.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected <a href="TensorParameters.html" title="type parameter in TensorParameters">E</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDefaultValue(int%5B%5D)">getDefaultValue</a></span>&#8203;(int[]&nbsp;indices)</code></th>
<td class="colLast">
<div class="block">Returns the default value for the parameter descriptor at the given indices.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptor</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDimensionDescriptor(int)">getDimensionDescriptor</a></span>&#8203;(int&nbsp;i)</code></th>
<td class="colLast">
<div class="block">Returns the parameter descriptor for the dimension at the given index.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptor</a>&lt;<a href="TensorParameters.html" title="type parameter in TensorParameters">E</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getElementDescriptor(int...)">getElementDescriptor</a></span>&#8203;(int...&nbsp;indices)</code></th>
<td class="colLast">
<div class="block">Returns the parameter descriptor for a matrix or tensor element at the given indices.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;<a href="TensorParameters.html" title="type parameter in TensorParameters">E</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getElementType()">getElementType</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the type of tensor element values.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a hash code value for this object.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#indicesToName(int%5B%5D)">indicesToName</a></span>&#8203;(int[]&nbsp;indices)</code></th>
<td class="colLast">
<div class="block">Returns the parameter descriptor name of a matrix or tensor element at the given indices.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>protected int[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#nameToIndices(java.lang.String)">nameToIndices</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Returns the indices of matrix element for the given parameter name, or <code>null</code> if none.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rank()">rank</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the rank of the tensor objects for which this instance will create parameters.</div>
</td>
</tr>
<tr id="i13" 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="#toMatrix(org.opengis.parameter.ParameterValueGroup)">toMatrix</a></span>&#8203;(<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;parameters)</code></th>
<td class="colLast">
<div class="block">Constructs a matrix from a group of parameters.</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#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#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="ALPHANUM">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ALPHANUM</h4>
<pre>public static final&nbsp;<a href="TensorParameters.html" title="class in org.apache.sis.parameter">TensorParameters</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang" class="externalLink">Double</a>&gt; ALPHANUM</pre>
<div class="block">Parses and creates matrix parameters with alphanumeric names.
<a href="../referencing/AbstractIdentifiedObject.html#getName()">Names</a> are made of a letter indicating the row
(first row is <code>"A"</code>), followed by a digit indicating the column index (first column is <code>"0"</code>).
<a href="../referencing/AbstractIdentifiedObject.html#getAlias()">Aliases</a> are the names as they were defined in version 1
of <cite>Well Known Text</cite> (WKT) format.
<table class="sis">
<caption>Parameter names for a 3×3 matrix</caption>
<tr>
<th>Primary name</th>
<th class="sep">Alias</th>
</tr>
<tr><td>
<blockquote><pre>┌ ┐
│ A0 A1 A2 │
│ B0 B1 B2 │
│ C0 C1 C2 │
└ ┘</pre></blockquote></td><td class="sep">
<blockquote><pre>┌ ┐
│ elt_0_0 elt_0_1 elt_0_2 │
│ elt_1_0 elt_1_1 elt_1_2 │
│ elt_2_0 elt_2_1 elt_2_2 │
└ ┘</pre></blockquote></td></tr>
</table>
<div class="section">Relationship with EPSG</div>
The above-cited group of parameters are close, but not identical, to the definitions provided
by the <cite>"Affine parametric transformation"</cite> (EPSG:9624) operation method.
The differences are:
<ul>
<li>EPSG:9624 is for matrices of size 3×3 and does not provide any way to specify the matrix size.
This <code>ALPHANUM</code> convention extends the definition to matrices of arbitrary size and accepts
<code>"num_row"</code> and <code>"num_col"</code> as optional parameters.</li>
<li>EPSG:9624 is restricted to affine matrices and consequently define parameters only for the two
first rows. This class accepts also parameters for the last row (namely <code>"C0"</code>, <code>"C1"</code>
and <code>"C2"</code> in a 3×3 matrices).</li>
</ul>
Because of the above-cited extensions, this <code>Tensor­Parameters</code> constant can not be named <code>EPSG</code>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.6</dd>
</dl>
</li>
</ul>
<a id="WKT1">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WKT1</h4>
<pre>public static final&nbsp;<a href="TensorParameters.html" title="class in org.apache.sis.parameter">TensorParameters</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang" class="externalLink">Double</a>&gt; WKT1</pre>
<div class="block">Parses and creates matrix parameters with names matching the
<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/doc-files/WKT.html">Well Known Text</a>
version 1 (WKT 1) convention.
<ul>
<li>First parameter is <code>"num_row"</code>.</li>
<li>Second parameter is <code>"num_col"</code>.</li>
<li>All other parameters are of the form <code>"elt_</code><var>row</var><code>_</code><var>col</var><code>"</code>.
Those parameters have alias of the form <code>"A0"</code>, <code>"A1"</code>, <i>etc.</i> where the letter indicates
the row (first row is <code>"A"</code>) and the digit is the column index (first column is <code>"0"</code>).</li>
</ul>
<div class="note"><b>Example:</b> <code>"elt_1_2"</code> is the element name for the value at row 1 and column 2.
Its alias is <code>"B2"</code>, which is the EPSG name for the same parameter.</div></div>
</li>
</ul>
<a id="prefix">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prefix</h4>
<pre>protected final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> prefix</pre>
<div class="block">The prefix of parameter names for tensor elements.
This is <code>"elt_"</code> in WKT 1.</div>
</li>
</ul>
<a id="separator">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>separator</h4>
<pre>protected final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> separator</pre>
<div class="block">The separator between row and column in parameter names for tensor elements.
This is <code>"_"</code> in WKT 1.</div>
</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;(java.lang.Class,java.lang.String,java.lang.String,org.opengis.parameter.ParameterDescriptor...)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TensorParameters</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/SafeVarargs.html?is-external=true" title="class or interface in java.lang" class="externalLink">@SafeVarargs</a>
public&nbsp;TensorParameters&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;<a href="TensorParameters.html" title="type parameter in TensorParameters">E</a>&gt;&nbsp;elementType,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;prefix,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;separator,
<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptor</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>&gt;...&nbsp;dimensions)</pre>
<div class="block">Constructs a descriptors provider.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>element­Type</code> - the type of tensor element values.</dd>
<dd><code>prefix</code> - the prefix to insert in front of parameter name for each tensor elements.</dd>
<dd><code>separator</code> - the separator between dimension (row, column, …) indices in parameter names.</dd>
<dd><code>dimensions</code> - the parameter for the size of each dimension, usually in an array of length 2.
Length may be different if the caller wants to generalize usage of this class to tensors.</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="getElementType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getElementType</h4>
<pre class="methodSignature">public final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;<a href="TensorParameters.html" title="type parameter in TensorParameters">E</a>&gt;&nbsp;getElementType()</pre>
<div class="block">Returns the type of tensor element values.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the type of tensor element values.</dd>
</dl>
</li>
</ul>
<a id="rank()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rank</h4>
<pre class="methodSignature">public final&nbsp;int&nbsp;rank()</pre>
<div class="block">Returns the rank of the tensor objects for which this instance will create parameters.
The rank determines the type of objects represented by the parameters:
<table class="sis">
<caption>Tensor types implied by rank</caption>
<tr><th>Rank</th> <th>Type</th> <th>Used with</th></tr>
<tr><td>0</td> <td>scalar</td> <td></td></tr>
<tr><td>1</td> <td>vector</td> <td></td></tr>
<tr><td>2</td> <td>matrix</td> <td>Affine parametric transformation</td></tr>
<tr><td><var>k</var></td><td>rank <var>k</var> tensor</td></tr>
</table></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the rank of the tensors for which to create parameters.</dd>
</dl>
</li>
</ul>
<a id="getDimensionDescriptor(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDimensionDescriptor</h4>
<pre class="methodSignature">public final&nbsp;<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptor</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>&gt;&nbsp;getDimensionDescriptor&#8203;(int&nbsp;i)</pre>
<div class="block">Returns the parameter descriptor for the dimension at the given index.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>i</code> - the dimension index, from 0 inclusive to <a href="#rank()"><code>rank()</code></a> exclusive.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the parameter descriptor for the dimension at the given index.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#getElementDescriptor(int...)"><code>get­Element­Descriptor(int...)</code></a>,
<a href="#getAllDescriptors(int...)"><code>get­All­Descriptors(int...)</code></a></dd>
</dl>
</li>
</ul>
<a id="getElementDescriptor(int...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getElementDescriptor</h4>
<pre class="methodSignature">public final&nbsp;<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptor</a>&lt;<a href="TensorParameters.html" title="type parameter in TensorParameters">E</a>&gt;&nbsp;getElementDescriptor&#8203;(int...&nbsp;indices)</pre>
<div class="block">Returns the parameter descriptor for a matrix or tensor element at the given indices.
The length of the given <code>indices</code> array shall be equals to the <a href="#rank()">rank</a>.
That length is usually 2, where <code>indices[0]</code> is the <var>row</var> index and <code>indices[1]</code>
is the <var>column</var> index.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>indices</code> - the indices of the tensor element for which to get the descriptor.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the parameter descriptor for the given tensor element.</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 the given array does not have the expected length or have illegal value.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#getDimensionDescriptor(int)"><code>get­Dimension­Descriptor(int)</code></a>,
<a href="#getAllDescriptors(int...)"><code>get­All­Descriptors(int...)</code></a></dd>
</dl>
</li>
</ul>
<a id="createElementDescriptor(int[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createElementDescriptor</h4>
<pre class="methodSignature">protected&nbsp;<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptor</a>&lt;<a href="TensorParameters.html" title="type parameter in TensorParameters">E</a>&gt;&nbsp;createElementDescriptor&#8203;(int[]&nbsp;indices)
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">Creates a new parameter descriptor for a matrix or tensor element at the given indices.
This method is invoked by <a href="#getElementDescriptor(int...)"><code>get­Element­Descriptor(int[])</code></a> when a new descriptor needs
to be created.
<div class="section">Default implementation</div>
The default implementation converts the given indices to a parameter name by invoking the
<a href="#indicesToName(int%5B%5D)"><code>indices­To­Name(int[])</code></a> method, then creates a descriptor for an optional parameter
of that name. The default value is given by <a href="#getDefaultValue(int%5B%5D)"><code>get­Default­Value(int[])</code></a>.
<div class="section">Subclassing</div>
Subclasses can override this method if they want more control on descriptor properties
like identification information, aliases or value domain.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>indices</code> - the indices of the tensor element for which to create a parameter.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the parameter descriptor for the given tensor element.</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 the given array does not have the expected length or have illegal value.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#indicesToName(int%5B%5D)"><code>indices­To­Name(int[])</code></a>,
<a href="#getDefaultValue(int%5B%5D)"><code>get­Default­Value(int[])</code></a></dd>
</dl>
</li>
</ul>
<a id="indicesToName(int[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>indicesToName</h4>
<pre class="methodSignature">protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;indicesToName&#8203;(int[]&nbsp;indices)
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">Returns the parameter descriptor name of a matrix or tensor element at the given indices.
The returned name shall be parsable by the <a href="#nameToIndices(java.lang.String)"><code>name­To­Indices(String)</code></a> method.
<div class="section">Default implementation</div>
The default implementation requires an <code>indices</code> array having a length equals to the <a href="#rank()">rank</a>. That length is usually 2, where <code>indices[0]</code> is the <var>row</var> index and <code>indices[1]</code> is
the <var>column</var> index. Then this method builds a name with the “<a href="#prefix"><code>prefix</code></a> + <var>row</var> +
<a href="#separator"><code>separator</code></a> + <var>column</var> + …” pattern (e.g. <code>"elt_0_0"</code>).
<div class="section">Subclassing</div>
If a subclass overrides this method for creating different names, then that subclass shall
also override <a href="#nameToIndices(java.lang.String)"><code>name­To­Indices(String)</code></a> for parsing those names.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>indices</code> - the indices of the tensor element for which to create a parameter name.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the parameter descriptor name for the tensor element at the given indices.</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 the given array does not have the expected length or have illegal value.</dd>
</dl>
</li>
</ul>
<a id="nameToIndices(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nameToIndices</h4>
<pre class="methodSignature">protected&nbsp;int[]&nbsp;nameToIndices&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)
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">Returns the indices of matrix element for the given parameter name, or <code>null</code> if none.
This method is the converse of <a href="#indicesToName(int%5B%5D)"><code>indices­To­Name(int[])</code></a>.
<div class="section">Default implementation</div>
The default implementation expects a name matching the “<a href="#prefix"><code>prefix</code></a> + <var>row</var> + <a href="#separator"><code>separator</code></a> +
<var>column</var> + …” pattern and returns an array containing the <var>row</var>, <var>column</var> and other
indices, in that order.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the parameter name to parse.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>indices of the tensor element of the given name, or <code>null</code> if the name is not recognized.</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 the name has been recognized but an error occurred while parsing it
(e.g. an <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NumberFormatException.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Number­Format­Exception</code></a>, which is an <code>Illegal­Argument­Exception</code> subclass).</dd>
</dl>
</li>
</ul>
<a id="getDefaultValue(int[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultValue</h4>
<pre class="methodSignature">protected&nbsp;<a href="TensorParameters.html" title="type parameter in TensorParameters">E</a>&nbsp;getDefaultValue&#8203;(int[]&nbsp;indices)</pre>
<div class="block">Returns the default value for the parameter descriptor at the given indices.
The default implementation returns 1 if all indices are equals, or 0 otherwise.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>indices</code> - the indices of the tensor element for which to get the default value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the default value for the tensor element at the given indices, or <code>null</code> if none.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.6</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="DefaultParameterDescriptor.html#getDefaultValue()"><code>Default­Parameter­Descriptor​.get­Default­Value()</code></a></dd>
</dl>
</li>
</ul>
<a id="getAllDescriptors(int...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllDescriptors</h4>
<pre class="methodSignature">public&nbsp;<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptor</a>&lt;?&gt;[]&nbsp;getAllDescriptors&#8203;(int...&nbsp;actualSize)</pre>
<div class="block">Returns all parameters in this group for a tensor of the specified dimensions.
The returned array contains all descriptors returned by <a href="#getDimensionDescriptor(int)"><code>get­Dimension­Descriptor(int)</code></a>
and <a href="#getElementDescriptor(int...)"><code>get­Element­Descriptor(int...)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>actual­Size</code> - the matrix (or tensor) dimensions for which to get the parameters.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the tensor parameters, including all elements.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.6</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#getDimensionDescriptor(int)"><code>get­Dimension­Descriptor(int)</code></a>,
<a href="#getElementDescriptor(int...)"><code>get­Element­Descriptor(int...)</code></a></dd>
</dl>
</li>
</ul>
<a id="createValueGroup(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createValueGroup</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;createValueGroup&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;?&gt;&nbsp;properties)</pre>
<div class="block">Creates a new instance of parameter group with default values of 1 on the diagonal, and 0 everywhere else.
The returned parameter group is extensible, i.e. the number of elements will depend upon the value associated
to the parameters that define the matrix (or tensor) dimension.
<p>The properties map is given unchanged to the
<a href="../referencing/AbstractIdentifiedObject.html#%3Cinit%3E(java.util.Map)">identified object constructor</a>. The following table is a reminder of main (not all) properties:</p>
<table class="sis">
<caption>Recognized properties (non exhaustive list)</caption>
<tr>
<th>Property name</th>
<th>Value type</th>
<th>Returned by</th>
</tr>
<tr>
<td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true#NAME_KEY" title="class or interface in org.opengis.referencing" class="externalLink">"name"</a></td>
<td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceIdentifier.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink"><code>ReferenceIdentifier</code></a> or <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>String</code></a></td>
<td><a href="../referencing/AbstractIdentifiedObject.html#getName()"><code>AbstractIdentifiedObject.getName()</code></a></td>
</tr>
<tr>
<td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true#ALIAS_KEY" title="class or interface in org.opengis.referencing" class="externalLink">"alias"</a></td>
<td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>GenericName</code></a> or <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Char­Sequence</code></a> (optionally as array)</td>
<td><a href="../referencing/AbstractIdentifiedObject.html#getAlias()"><code>AbstractIdentifiedObject.getAlias()</code></a></td>
</tr>
<tr>
<td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true#IDENTIFIERS_KEY" title="class or interface in org.opengis.referencing" class="externalLink">"identifiers"</a></td>
<td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceIdentifier.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink"><code>ReferenceIdentifier</code></a> (optionally as array)</td>
<td><a href="../referencing/AbstractIdentifiedObject.html#getIdentifiers()"><code>AbstractIdentifiedObject.getIdentifiers()</code></a></td>
</tr>
<tr>
<td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true#REMARKS_KEY" title="class or interface in org.opengis.referencing" class="externalLink">"remarks"</a></td>
<td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>InternationalString</code></a> or <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>String</code></a></td>
<td><a href="../referencing/AbstractIdentifiedObject.html#getRemarks()"><code>AbstractIdentifiedObject.getRemarks()</code></a></td>
</tr>
</table></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>properties</code> - the properties to be given to the identified object.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new parameter group initialized to the default values.</dd>
</dl>
</li>
</ul>
<a id="createValueGroup(java.util.Map,org.opengis.referencing.operation.Matrix)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createValueGroup</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;createValueGroup&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;?&gt;&nbsp;properties,
<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;matrix)</pre>
<div class="block">Creates a new instance of parameter group initialized to the given matrix.
This operation is allowed only for tensors of <a href="#rank()">rank</a> 2.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>properties</code> - the properties to be given to the identified object.</dd>
<dd><code>matrix</code> - the matrix to copy in the new parameter group.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new parameter group initialized to the given matrix.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#toMatrix(org.opengis.parameter.ParameterValueGroup)"><code>to­Matrix(Parameter­Value­Group)</code></a></dd>
</dl>
</li>
</ul>
<a id="toMatrix(org.opengis.parameter.ParameterValueGroup)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toMatrix</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;toMatrix&#8203;(<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;parameters)
throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterNameException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterNameException</a></pre>
<div class="block">Constructs a matrix from a group of parameters.
This operation is allowed only for tensors of <a href="#rank()">rank</a> 2.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parameters</code> - the group of parameters.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a matrix constructed from the specified group of parameters.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterNameException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">Invalid­Parameter­Name­Exception</a></code> - if a parameter name was not recognized.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#createValueGroup(java.util.Map,org.opengis.referencing.operation.Matrix)"><code>create­Value­Group(Map, Matrix)</code></a></dd>
</dl>
</li>
</ul>
<a id="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;hashCode()</pre>
<div class="block">Returns a hash code value for this object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><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></code>&nbsp;in class&nbsp;<code><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></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a hash code value.</dd>
</dl>
</li>
</ul>
<a id="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>equals</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;equals&#8203;(<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>&nbsp;other)</pre>
<div class="block">Compares this object with the given object for equality.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><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></code>&nbsp;in class&nbsp;<code><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></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>other</code> - the other object to compare with this object.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if both object are equal.</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/TensorParameters.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>