| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (24) on Mon Sep 29 10:48:08 CEST 2025 --> |
| <title>MatrixParameters (Apache SIS 1.5 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2025-09-29"> |
| <meta name="description" content="declaration: module: org.apache.sis.referencing, package: org.apache.sis.parameter, class: MatrixParameters"> |
| <meta name="generator" content="javadoc/ClassWriter"> |
| <meta name="keywords" content="org.apache.sis.parameter.MatrixParameters class"> |
| <meta name="keywords" content="WKT1"> |
| <meta name="keywords" content="ALPHANUM"> |
| <meta name="keywords" content="EPSG"> |
| <meta name="keywords" content="prefix"> |
| <meta name="keywords" content="separator"> |
| <meta name="keywords" content="getElementType()"> |
| <meta name="keywords" content="order()"> |
| <meta name="keywords" content="getDimensionDescriptor()"> |
| <meta name="keywords" content="getElementDescriptor()"> |
| <meta name="keywords" content="createElementDescriptor()"> |
| <meta name="keywords" content="properties()"> |
| <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()"> |
| <meta name="keywords" content="toString()"> |
| <link rel="stylesheet" type="text/css" href="../../../../../resource-files/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../resource-files/stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../resource-files/sis.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script-files/script.js"></script> |
| <script type="text/javascript" src="../../../../../script-files/jquery-3.7.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-files/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">const pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="nav-content"> |
| <div class="nav-menu-button"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button></div> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/MatrixParameters.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../new-list.html">New</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../search.html">Search</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| </div> |
| <div class="sub-nav"> |
| <div class="nav-content"> |
| <ol class="sub-nav-list"> |
| <li><a href="../../../../module-summary.html">org.apache.sis.referencing</a></li> |
| <li><a href="package-summary.html">org.apache.sis.parameter</a></li> |
| <li><a href="MatrixParameters.html" class="current-selection">MatrixParameters</a></li> |
| </ol> |
| <div class="nav-list-search"> |
| <input type="text" id="search-input" disabled placeholder="Search" aria-label="Search in documentation" autocomplete="off"> |
| <input type="reset" id="reset-search" disabled value="Reset"> |
| </div> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="main-grid"> |
| <nav role="navigation" class="toc" aria-label="Table of contents"> |
| <div class="toc-header">Contents |
| <input type="text" class="filter-input" disabled placeholder="Filter" aria-label="Filter table of contents" autocomplete="off"> |
| <input type="reset" class="reset-filter" disabled value="Reset"> |
| </div> |
| <button class="hide-sidebar"><span>Hide sidebar </span>❮</button><button class="show-sidebar">❯<span> Show sidebar</span></button> |
| <ol class="toc-list"> |
| <li><a href="#" tabindex="0">Description</a> |
| <ol class="toc-list"> |
| <li><a href="#formatting-heading" tabindex="0">Formatting</a></li> |
| <li><a href="#usage-examples-heading" tabindex="0">Usage examples</a></li> |
| </ol> |
| </li> |
| <li><a href="#field-summary" tabindex="0">Field Summary</a></li> |
| <li><a href="#constructor-summary" tabindex="0">Constructor Summary</a></li> |
| <li><a href="#method-summary" tabindex="0">Method Summary</a></li> |
| <li><a href="#field-detail" tabindex="0">Field Details</a> |
| <ol class="toc-list"> |
| <li><a href="#WKT1" tabindex="0">WKT1</a></li> |
| <li><a href="#ALPHANUM" tabindex="0">ALPHANUM</a></li> |
| <li><a href="#EPSG" tabindex="0">EPSG</a></li> |
| <li><a href="#prefix" tabindex="0">prefix</a></li> |
| <li><a href="#separator" tabindex="0">separator</a></li> |
| </ol> |
| </li> |
| <li><a href="#constructor-detail" tabindex="0">Constructor Details</a> |
| <ol class="toc-list"> |
| <li><a href="#%3Cinit%3E(org.apache.sis.parameter.MatrixParameters)" tabindex="0">MatrixParameters(MatrixParameters)</a></li> |
| <li><a href="#%3Cinit%3E(java.lang.Class,java.lang.String,java.lang.String,org.opengis.parameter.ParameterDescriptor...)" tabindex="0">MatrixParameters(Class, String, String, ParameterDescriptor...)</a></li> |
| </ol> |
| </li> |
| <li><a href="#method-detail" tabindex="0">Method Details</a> |
| <ol class="toc-list"> |
| <li><a href="#getElementType()" tabindex="0">getElementType()</a></li> |
| <li><a href="#order()" tabindex="0">order()</a></li> |
| <li><a href="#getDimensionDescriptor(int)" tabindex="0">getDimensionDescriptor(int)</a></li> |
| <li><a href="#getElementDescriptor(int...)" tabindex="0">getElementDescriptor(int...)</a></li> |
| <li><a href="#createElementDescriptor(int%5B%5D)" tabindex="0">createElementDescriptor(int[])</a></li> |
| <li><a href="#properties(int%5B%5D)" tabindex="0">properties(int[])</a></li> |
| <li><a href="#indicesToName(int%5B%5D)" tabindex="0">indicesToName(int[])</a></li> |
| <li><a href="#nameToIndices(java.lang.String)" tabindex="0">nameToIndices(String)</a></li> |
| <li><a href="#getDefaultValue(int%5B%5D)" tabindex="0">getDefaultValue(int[])</a></li> |
| <li><a href="#getAllDescriptors(int...)" tabindex="0">getAllDescriptors(int...)</a></li> |
| <li><a href="#createValueGroup(java.util.Map)" tabindex="0">createValueGroup(Map)</a></li> |
| <li><a href="#createValueGroup(java.util.Map,org.opengis.referencing.operation.Matrix)" tabindex="0">createValueGroup(Map, Matrix)</a></li> |
| <li><a href="#toMatrix(org.opengis.parameter.ParameterValueGroup)" tabindex="0">toMatrix(ParameterValueGroup)</a></li> |
| <li><a href="#hashCode()" tabindex="0">hashCode()</a></li> |
| <li><a href="#equals(java.lang.Object)" tabindex="0">equals(Object)</a></li> |
| <li><a href="#toString()" tabindex="0">toString()</a></li> |
| </ol> |
| </li> |
| </ol> |
| </nav> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <h1 title="Class MatrixParameters" class="title">Class MatrixParameters<E></h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| <div class="inheritance">MatrixParameters<E></div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><span id="type-param-E"><code>E</code> - the type of matrix element values.</span></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="../../../../../org.apache.sis.util/org/apache/sis/util/collection/CheckedContainer.html" title="interface in org.apache.sis.util.collection">CheckedContainer</a><E></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="TensorParameters.html" title="class in org.apache.sis.parameter">TensorParameters</a></code></dd> |
| </dl> |
| <hr> |
| <div class="horizontal-scroll"> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">MatrixParameters<E></span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements <a href="../../../../../org.apache.sis.util/org/apache/sis/util/collection/CheckedContainer.html" title="interface in org.apache.sis.util.collection">CheckedContainer</a><E>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></span></div> |
| <div class="block">Builder of parameter groups for matrices or mathematical objects of higher dimensions. |
| While this class is primarily used for reading and writing matrix parameters in Well Known Text format |
| (i.e., in two-dimensional arrays of coefficients for multi-dimensional transforms), |
| this class can also be used for describing parameters in multidimensional arrays. |
| Each group of parameters contains the following elements: |
| <ul> |
| <li>Parameters for specifying the size along each dimension: |
| <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 <abbr>WKT</abbr> 1 convention),</li> |
| <li><i>etc.</i> for multi-dimensional arrays of more than two dimensions.</li> |
| </ul> |
| </li> |
| <li>A maximum of <code>num_row</code> × <code>num_col</code> × … optional parameters for the matrix element values. |
| The parameter names depend on the formatting convention.</li> |
| </ul> |
| |
| In matrices, the default value is 1 for all elements on the diagonal and 0 everywhere else. |
| For object of higher dimensions, this is generalized to 1 in elements where all indices have the same value. |
| Those default values defines an <i>identity matrix</i> (or more generally, a Kroenecker delta tensor). |
| |
| <h2 id="formatting-heading">Formatting</h2> |
| In the usual case of a matrix, the parameters are typically formatted as below. |
| Note that in the <abbr>EPSG</abbr> 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. The <abbr>EPSG</abbr> database also contains A3, A4, A5, A6, A7, A8 and B3 parameters, |
| but they are for polynomial transformations, not for affine transformations. |
| |
| <table class="sis"> |
| <caption>Well Known Text (<abbr>WKT</abbr>) formats for matrix parameters</caption> |
| <tr> |
| <th>Using <abbr>EPSG</abbr>:9624 names and identifiers</th> |
| <th class="sep">Using <abbr>OGC</abbr> names</th> |
| </tr> |
| <tr><td> |
| |
| <div class="snippet-container"><button class="copy snippet-copy" aria-label="Copy snippet" onclick="copySnippet(this)"><span data-copied="Copied!">Copy</span><img src="../../../../../resource-files/copy.svg" alt="Copy snippet"></button> |
| <pre class="snippet" id="snippet-org.apache.sis.parameter.MatrixParameters1"><code class="language-wkt"> Parameter["A0", <value>, Id["EPSG", 8623]], |
| Parameter["A1", <value>, Id["EPSG", 8624]], |
| Parameter["A2", <value>, Id["EPSG", 8625]], |
| Parameter["B0", <value>, Id["EPSG", 8639]], |
| Parameter["B1", <value>, Id["EPSG", 8640]], |
| Parameter["B2", <value>, Id["EPSG", 8641]] |
| </code></pre> |
| </div> |
| |
| |
| </td><td class="sep"> |
| |
| <div class="snippet-container"><button class="copy snippet-copy" aria-label="Copy snippet" onclick="copySnippet(this)"><span data-copied="Copied!">Copy</span><img src="../../../../../resource-files/copy.svg" alt="Copy snippet"></button> |
| <pre class="snippet" id="snippet-org.apache.sis.parameter.MatrixParameters2"><code class="language-wkt"> Parameter["num_row", 3], |
| Parameter["num_col", 3], |
| Parameter["elt_0_0", <value>], |
| Parameter["elt_0_1", <value>], |
| ... |
| Parameter["elt_0_<num_col-1>", <value>], |
| Parameter["elt_1_0", <value>], |
| Parameter["elt_1_1", <value>], |
| ... |
| Parameter["elt_<num_row-1>_<num_col-1>", <value>] |
| </code></pre> |
| </div> |
| |
| </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 parameters is not immutable. |
| |
| <h2 id="usage-examples-heading">Usage examples</h2> |
| 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: |
| |
| |
| <div class="snippet-container"><button class="copy snippet-copy" aria-label="Copy snippet" onclick="copySnippet(this)"><span data-copied="Copied!">Copy</span><img src="../../../../../resource-files/copy.svg" alt="Copy snippet"></button> |
| <pre class="snippet" id="snippet-org.apache.sis.parameter.MatrixParameters3"><code class="language-java">Map<String,?> properties = Map.of(ParameterValueGroup.NAME_KEY, "Affine"); |
| ParameterValueGroup p = MatrixParameters.WKT1.createValueGroup(properties); |
| </code></pre> |
| </div> |
| |
| |
| For setting the elements of a few values, the next step is to create a matrix from the parameter values: |
| |
| |
| <div class="snippet-container"><button class="copy snippet-copy" aria-label="Copy snippet" onclick="copySnippet(this)"><span data-copied="Copied!">Copy</span><img src="../../../../../resource-files/copy.svg" alt="Copy snippet"></button> |
| <pre class="snippet" id="snippet-org.apache.sis.parameter.MatrixParameters4"><code class="language-java">p.parameter("elt_0_0").setValue(4); |
| p.parameter("elt_1_1").setValue(6); |
| Matrix m = MatrixParameters.WKT1.toMatrix(p); |
| </code></pre> |
| </div> |
| </div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>1.5</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list"> |
| <li><a href="../referencing/operation/matrix/Matrices.html" title="class in org.apache.sis.referencing.operation.matrix"><code>Matrices</code></a></li> |
| <li><a href="../../../../../serialized-form.html#org.apache.sis.parameter.MatrixParameters">Serialized Form</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final <a href="MatrixParameters.html" title="class in org.apache.sis.parameter">MatrixParameters</a><wbr><<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></code></div> |
| <div class="col-second even-row-color"><code><a href="#ALPHANUM" class="member-name-link">ALPHANUM</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Parses and creates matrix parameters with alphanumeric names.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final <a href="MatrixParameters.html" title="class in org.apache.sis.parameter">MatrixParameters</a><wbr><<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></code></div> |
| <div class="col-second odd-row-color"><code><a href="#EPSG" class="member-name-link">EPSG</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Parses and creates matrix parameters with alphanumeric names in the order defined by <abbr>EPSG</abbr>.</div> |
| </div> |
| <div class="col-first even-row-color"><code>protected final <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#prefix" class="member-name-link">prefix</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The prefix of parameter names for matrix elements.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected final <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#separator" class="member-name-link">separator</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The separator between row and column in parameter names for matrix elements.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static final <a href="MatrixParameters.html" title="class in org.apache.sis.parameter">MatrixParameters</a><wbr><<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></code></div> |
| <div class="col-second even-row-color"><code><a href="#WKT1" class="member-name-link">WKT1</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Parses and creates matrix parameters with names matching the |
| Well Known Text version 1 (<abbr>WKT</abbr> 1) convention.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code> </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.Class,java.lang.String,java.lang.String,org.opengis.parameter.ParameterDescriptor...)" class="member-name-link">MatrixParameters</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="#type-param-E" title="type parameter in MatrixParameters">E</a>> elementType, |
| <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> prefix, |
| <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> separator, |
| <a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>>... dimensions)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a builder of matrix descriptors.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected </code></div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.sis.parameter.MatrixParameters)" class="member-name-link">MatrixParameters</a><wbr>(<a href="MatrixParameters.html" title="class in org.apache.sis.parameter">MatrixParameters</a><<a href="#type-param-E" title="type parameter in MatrixParameters">E</a>> other)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Creates a copy of the given builder of matrix descriptors.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><wbr><<a href="#type-param-E" title="type parameter in MatrixParameters">E</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createElementDescriptor(int%5B%5D)" class="member-name-link">createElementDescriptor</a><wbr>(int[] indices)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Creates a new parameter descriptor for a matrix element at the given indices.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValueGroup</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createValueGroup(java.util.Map)" class="member-name-link">createValueGroup</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>?> properties)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Creates a new instance of parameter group with default values of 1 on the diagonal, and 0 everywhere else.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValueGroup</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createValueGroup(java.util.Map,org.opengis.referencing.operation.Matrix)" class="member-name-link">createValueGroup</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>?> properties, |
| <a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/Matrix.html" title="class or interface in org.opengis.referencing.operation" class="external-link">Matrix</a> matrix)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Creates a new instance of parameter group initialized to the given matrix.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> other)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Compares this object with the given object for equality.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><?>[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAllDescriptors(int...)" class="member-name-link">getAllDescriptors</a><wbr>(int... actualSize)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns all parameters in this group for a matrix of the specified size.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="#type-param-E" title="type parameter in MatrixParameters">E</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDefaultValue(int%5B%5D)" class="member-name-link">getDefaultValue</a><wbr>(int[] indices)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the default value for the parameter descriptor at the given indices.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><wbr><<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDimensionDescriptor(int)" class="member-name-link">getDimensionDescriptor</a><wbr>(int i)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the parameter descriptor for the dimension at the given index.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><wbr><<a href="#type-param-E" title="type parameter in MatrixParameters">E</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getElementDescriptor(int...)" class="member-name-link">getElementDescriptor</a><wbr>(int... indices)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the parameter descriptor for a matrix element at the given indices.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><wbr><<a href="#type-param-E" title="type parameter in MatrixParameters">E</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getElementType()" class="member-name-link">getElementType</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the type of matrix element values.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" class="member-name-link">hashCode</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a hash code value for this object.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#indicesToName(int%5B%5D)" class="member-name-link">indicesToName</a><wbr>(int[] indices)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the parameter descriptor name of a matrix element at the given indices.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected int[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#nameToIndices(java.lang.String)" class="member-name-link">nameToIndices</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the indices of matrix element for the given parameter name, or <code>null</code> if none.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#order()" class="member-name-link">order</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the number of dimensions of the multi-dimensional array for which this builder will create parameters.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><wbr><<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>?></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#properties(int%5B%5D)" class="member-name-link">properties</a><wbr>(int[] indices)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the properties of the parameter descriptor at the given indices.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/Matrix.html" title="class or interface in org.opengis.referencing.operation" class="external-link">Matrix</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toMatrix(org.opengis.parameter.ParameterValueGroup)" class="member-name-link">toMatrix</a><wbr>(<a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValueGroup</a> parameters)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Constructs a matrix from a group of parameters.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a string representation of this object for debugging purposes.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Object">Methods inherited from class <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="WKT1"> |
| <h3>WKT1</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="MatrixParameters.html" title="class in org.apache.sis.parameter">MatrixParameters</a><<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></span> <span class="element-name">WKT1</span></div> |
| <div class="block">Parses and creates matrix parameters with names matching the |
| Well Known Text version 1 (<abbr>WKT</abbr> 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_<var>row</var>_<var>col</var>"</code> |
| where <var>row</var> and <var>col</var> are zero-based.</li> |
| </ul> |
| |
| For example, <code>"elt_1_2"</code> is the element name for the value at row 1 and column 2 (zero-based indices). |
| There are no alphanumeric aliases for avoiding confusion between <a href="#ALPHANUM"><code>ALPHANUM</code></a> and <a href="#EPSG"><code>EPSG</code></a>.</div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ALPHANUM"> |
| <h3>ALPHANUM</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="MatrixParameters.html" title="class in org.apache.sis.parameter">MatrixParameters</a><<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></span> <span class="element-name">ALPHANUM</span></div> |
| <div class="block">Parses and creates matrix parameters with alphanumeric names. |
| <a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#getName()" title="class or interface in org.opengis.referencing" class="external-link">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="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#getAlias()" title="class or interface in org.opengis.referencing" class="external-link">Aliases</a> are the names as they were defined in version 1 |
| of <i>Well Known Text</i> (<abbr>WKT</abbr>) 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> |
| <pre class="text"> |
| ┌ ┐ |
| │ A0 A1 A2 │ |
| │ B0 B1 B2 │ |
| │ C0 C1 C2 │ |
| └ ┘</pre> |
| </td><td class="sep"> |
| <pre class="text"> |
| ┌ ┐ |
| │ 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> |
| </td></tr> |
| </table></div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="EPSG"> |
| <h3>EPSG</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="MatrixParameters.html" title="class in org.apache.sis.parameter">MatrixParameters</a><<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></span> <span class="element-name">EPSG</span></div> |
| <div class="block">Parses and creates matrix parameters with alphanumeric names in the order defined by <abbr>EPSG</abbr>. |
| This is similar to <a href="#ALPHANUM"><code>ALPHANUM</code></a>, except that coefficients with index 0 are in the translation column. |
| These parameter names are defined by the <q>Affine parametric transformation</q> (EPSG:9624) operation method. |
| The last row cannot be specified by <abbr>EPSG</abbr> names. |
| |
| <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> |
| <pre class="text"> |
| ┌ ┐ |
| │ A1 A2 A0 │ |
| │ B1 B2 B0 │ |
| │ 0 0 1 │ |
| └ ┘</pre> |
| </td><td class="sep"> |
| <pre class="text"> |
| ┌ ┐ |
| │ 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> |
| </td></tr> |
| </table></div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="prefix"> |
| <h3>prefix</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">prefix</span></div> |
| <div class="block">The prefix of parameter names for matrix elements. |
| This is <code>"elt_"</code> in <abbr>WKT</abbr> 1.</div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="separator"> |
| <h3>separator</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">separator</span></div> |
| <div class="block">The separator between row and column in parameter names for matrix elements. |
| This is <code>"_"</code> in <abbr>WKT</abbr> 1.</div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.apache.sis.parameter.MatrixParameters)"> |
| <h3>MatrixParameters</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">MatrixParameters</span><wbr><span class="parameters">(<a href="MatrixParameters.html" title="class in org.apache.sis.parameter">MatrixParameters</a><<a href="#type-param-E" title="type parameter in MatrixParameters">E</a>> other)</span></div> |
| <div class="block">Creates a copy of the given builder of matrix descriptors. |
| The new builder will use the same prefix, separator and dimensions than the given builder. |
| This constructor is for subclasses which use an existing instance as a basis, then override methods.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>other</code> - the existing builder from which to copy the prefix, separator and dimensions.</dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.Class,java.lang.String,java.lang.String,org.opengis.parameter.ParameterDescriptor...)"> |
| <h3>MatrixParameters</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/SafeVarargs.html" title="class or interface in java.lang" class="external-link">@SafeVarargs</a> |
| </span><span class="modifiers">public</span> <span class="element-name">MatrixParameters</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="#type-param-E" title="type parameter in MatrixParameters">E</a>> elementType, |
| <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> prefix, |
| <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> separator, |
| <a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>>... dimensions)</span></div> |
| <div class="block">Creates a builder of matrix descriptors.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>elementType</code> - the type of matrix element values.</dd> |
| <dd><code>prefix</code> - the prefix to insert in front of parameter name for each matrix 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 multi-dimensional arrays.</dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getElementType()"> |
| <h3>getElementType</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="#type-param-E" title="type parameter in MatrixParameters">E</a>></span> <span class="element-name">getElementType</span>()</div> |
| <div class="block">Returns the type of matrix element values.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../../../../org.apache.sis.util/org/apache/sis/util/collection/CheckedContainer.html#getElementType()">getElementType</a></code> in interface <code><a href="../../../../../org.apache.sis.util/org/apache/sis/util/collection/CheckedContainer.html" title="interface in org.apache.sis.util.collection">CheckedContainer</a><<a href="#type-param-E" title="type parameter in MatrixParameters">E</a>></code></dd> |
| <dt>Returns:</dt> |
| <dd>the type of matrix element values.</dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="order()"> |
| <h3>order</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">int</span> <span class="element-name">order</span>()</div> |
| <div class="block">Returns the number of dimensions of the multi-dimensional array for which this builder will create parameters. |
| The number of array dimensions (matrix order) determines the type of objects represented by the parameters: |
| |
| <table class="sis"> |
| <caption>Type of mathematical object implied by the number of array dimensions</caption> |
| <tr><th>dimension</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>array of <var>k</var> dimensions</td></tr> |
| </table></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the number of dimensions of the multi-dimensional array for which to create parameters.</dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDimensionDescriptor(int)"> |
| <h3>getDimensionDescriptor</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></span> <span class="element-name">getDimensionDescriptor</span><wbr><span class="parameters">(int i)</span></div> |
| <div class="block">Returns the parameter descriptor for the dimension at the given index.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>i</code> - the dimension index, from 0 inclusive to <a href="#order()"><code>order()</code></a> exclusive.</dd> |
| <dt>Returns:</dt> |
| <dd>the parameter descriptor for the dimension at the given index.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list"> |
| <li><a href="#getElementDescriptor(int...)"><code>getElementDescriptor(int...)</code></a></li> |
| <li><a href="#getAllDescriptors(int...)"><code>getAllDescriptors(int...)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getElementDescriptor(int...)"> |
| <h3>getElementDescriptor</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><<a href="#type-param-E" title="type parameter in MatrixParameters">E</a>></span> <span class="element-name">getElementDescriptor</span><wbr><span class="parameters">(int... indices)</span></div> |
| <div class="block">Returns the parameter descriptor for a matrix element at the given indices. |
| The length of the given <code>indices</code> array shall be equal to the <a href="#order()">dimension</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 class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>indices</code> - the indices of the matrix element for which to get the descriptor, |
| in (<var>row</var>, <var>column</var>, …) order.</dd> |
| <dt>Returns:</dt> |
| <dd>the parameter descriptor for the given matrix element.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given array does not have the expected length or have illegal value.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list"> |
| <li><a href="#getDimensionDescriptor(int)"><code>getDimensionDescriptor(int)</code></a></li> |
| <li><a href="#getAllDescriptors(int...)"><code>getAllDescriptors(int...)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createElementDescriptor(int[])"> |
| <h3>createElementDescriptor</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><<a href="#type-param-E" title="type parameter in MatrixParameters">E</a>></span> <span class="element-name">createElementDescriptor</span><wbr><span class="parameters">(int[] indices)</span></div> |
| <div class="block">Creates a new parameter descriptor for a matrix element at the given indices. |
| This method is invoked by <a href="#getElementDescriptor(int...)"><code>getElementDescriptor(int[])</code></a> when a new descriptor |
| needs to be created. |
| |
| <h4 id="default-implementation-heading">Default implementation</h4> |
| The default implementation converts the given indices to a parameter name by invoking the |
| <a href="#indicesToName(int%5B%5D)"><code>indicesToName(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>getDefaultValue(int[])</code></a>. |
| |
| <h4 id="subclassing-heading">Subclassing</h4> |
| Subclasses can override this method if they want more control on descriptor properties |
| like identification information, aliases or value domain.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>indices</code> - the indices of the matrix element for which to create a parameter, |
| in (<var>row</var>, <var>column</var>, …) order.</dd> |
| <dt>Returns:</dt> |
| <dd>the parameter descriptor for the given matrix element.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given array does not have the expected length or have illegal value.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list"> |
| <li><a href="#indicesToName(int%5B%5D)"><code>indicesToName(int[])</code></a></li> |
| <li><a href="#getDefaultValue(int%5B%5D)"><code>getDefaultValue(int[])</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="properties(int[])"> |
| <h3>properties</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>?></span> <span class="element-name">properties</span><wbr><span class="parameters">(int[] indices)</span></div> |
| <div class="block">Returns the properties of the parameter descriptor at the given indices. |
| This is an alternative to overriding <a href="#createElementDescriptor(int%5B%5D)"><code>createElementDescriptor(int[])</code></a> |
| when only the identification (name, aliases, <i>etc.</i>) need to be modified.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>indices</code> - the indices of the matrix element for which to create parameter aliases, |
| in (<var>row</var>, <var>column</var>, …) order.</dd> |
| <dt>Returns:</dt> |
| <dd>the parameter descriptor properties for the matrix element at the given indices.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given array does not have the expected length or have illegal value.</dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="indicesToName(int[])"> |
| <h3>indicesToName</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">indicesToName</span><wbr><span class="parameters">(int[] indices)</span></div> |
| <div class="block">Returns the parameter descriptor name of a matrix element at the given indices. |
| The returned name shall be parsable by the <a href="#nameToIndices(java.lang.String)"><code>nameToIndices(String)</code></a> method. |
| |
| <h4 id="default-implementation-heading1">Default implementation</h4> |
| The default implementation requires an <code>indices</code> array having a length equals to the |
| <a href="#order()">matrix order</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>). |
| |
| <h4 id="subclassing-heading1">Subclassing</h4> |
| If a subclass overrides this method for creating different names, then that subclass |
| should also override the <a href="#nameToIndices(java.lang.String)"><code>nameToIndices(String)</code></a> method for parsing those names.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>indices</code> - the indices of the matrix element for which to create a parameter name, |
| in (<var>row</var>, <var>column</var>, …) order.</dd> |
| <dt>Returns:</dt> |
| <dd>the parameter descriptor name for the matrix element at the given indices.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given array does not have the expected length or have illegal value.</dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="nameToIndices(java.lang.String)"> |
| <h3>nameToIndices</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">int[]</span> <span class="element-name">nameToIndices</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> |
| <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 the <a href="#indicesToName(int%5B%5D)"><code>indicesToName(int[])</code></a> method, eventually extended |
| for recognizing also the aliases (if any). |
| |
| <h4 id="default-implementation-heading2">Default implementation</h4> |
| 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 class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the parameter name to parse.</dd> |
| <dt>Returns:</dt> |
| <dd>indices of the matrix element of the given name, or <code>null</code> if the name is not recognized.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the name has been recognized but an error occurred while parsing it |
| (e.g. an <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/NumberFormatException.html" title="class or interface in java.lang" class="external-link"><code>NumberFormatException</code></a>, which is an <code>IllegalArgumentException</code> subclass).</dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDefaultValue(int[])"> |
| <h3>getDefaultValue</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="#type-param-E" title="type parameter in MatrixParameters">E</a></span> <span class="element-name">getDefaultValue</span><wbr><span class="parameters">(int[] indices)</span></div> |
| <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 class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>indices</code> - the indices of the matrix element for which to get the default value, |
| in (<var>row</var>, <var>column</var>, …) order.</dd> |
| <dt>Returns:</dt> |
| <dd>the default value for the matrix element at the given indices, or <code>null</code> if none.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="DefaultParameterDescriptor.html#getDefaultValue()"><code>DefaultParameterDescriptor.getDefaultValue()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAllDescriptors(int...)"> |
| <h3>getAllDescriptors</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><?>[]</span> <span class="element-name">getAllDescriptors</span><wbr><span class="parameters">(int... actualSize)</span></div> |
| <div class="block">Returns all parameters in this group for a matrix of the specified size. |
| The returned array contains all descriptors returned by <a href="#getDimensionDescriptor(int)"><code>getDimensionDescriptor(int)</code></a> |
| and <a href="#getElementDescriptor(int...)"><code>getElementDescriptor(int...)</code></a> for all values that exist for the given size.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>actualSize</code> - the matrix size in (<code>num_row</code>, <code>num_col</code>, …) order.</dd> |
| <dt>Returns:</dt> |
| <dd>the matrix parameters, including all elements.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list"> |
| <li><a href="#getDimensionDescriptor(int)"><code>getDimensionDescriptor(int)</code></a></li> |
| <li><a href="#getElementDescriptor(int...)"><code>getElementDescriptor(int...)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createValueGroup(java.util.Map)"> |
| <h3>createValueGroup</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValueGroup</a></span> <span class="element-name">createValueGroup</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>?> properties)</span></div> |
| <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 size. |
| |
| <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="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#NAME_KEY" title="class or interface in org.opengis.referencing" class="external-link">"name"</a></td> |
| <td><a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/Identifier.html" title="class or interface in org.opengis.metadata" class="external-link"><code>Identifier</code></a> or <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></td> |
| <td><a href="../referencing/AbstractIdentifiedObject.html#getName()"><code>AbstractIdentifiedObject.getName()</code></a></td> |
| </tr><tr> |
| <td><a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#ALIAS_KEY" title="class or interface in org.opengis.referencing" class="external-link">"alias"</a></td> |
| <td><a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/GenericName.html" title="class or interface in org.opengis.util" class="external-link"><code>GenericName</code></a> or <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link"><code>CharSequence</code></a> (optionally as array)</td> |
| <td><a href="../referencing/AbstractIdentifiedObject.html#getAlias()"><code>AbstractIdentifiedObject.getAlias()</code></a></td> |
| </tr><tr> |
| <td><a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#IDENTIFIERS_KEY" title="class or interface in org.opengis.referencing" class="external-link">"identifiers"</a></td> |
| <td><a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/Identifier.html" title="class or interface in org.opengis.metadata" class="external-link"><code>Identifier</code></a> (optionally as array)</td> |
| <td><a href="../referencing/AbstractIdentifiedObject.html#getIdentifiers()"><code>AbstractIdentifiedObject.getIdentifiers()</code></a></td> |
| </tr><tr> |
| <td><a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#REMARKS_KEY" title="class or interface in org.opengis.referencing" class="external-link">"remarks"</a></td> |
| <td><a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link"><code>InternationalString</code></a> or <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></td> |
| <td><a href="../referencing/AbstractIdentifiedObject.html#getRemarks()"><code>AbstractIdentifiedObject.getRemarks()</code></a></td> |
| </tr> |
| </table></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>properties</code> - the properties to be given to the identified object.</dd> |
| <dt>Returns:</dt> |
| <dd>a new parameter group initialized to the default values.</dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createValueGroup(java.util.Map,org.opengis.referencing.operation.Matrix)"> |
| <h3>createValueGroup</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValueGroup</a></span> <span class="element-name">createValueGroup</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>?> properties, |
| <a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/Matrix.html" title="class or interface in org.opengis.referencing.operation" class="external-link">Matrix</a> matrix)</span></div> |
| <div class="block">Creates a new instance of parameter group initialized to the given matrix. |
| This operation is allowed only for two-dimensional arrays.</div> |
| <dl class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>a new parameter group initialized to the given matrix.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if <a href="#order()"><code>order()</code></a> does not return 2.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list"> |
| <li><a href="#toMatrix(org.opengis.parameter.ParameterValueGroup)"><code>toMatrix(ParameterValueGroup)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toMatrix(org.opengis.parameter.ParameterValueGroup)"> |
| <h3>toMatrix</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/Matrix.html" title="class or interface in org.opengis.referencing.operation" class="external-link">Matrix</a></span> <span class="element-name">toMatrix</span><wbr><span class="parameters">(<a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValueGroup</a> parameters)</span></div> |
| <div class="block">Constructs a matrix from a group of parameters. |
| This operation is allowed only for two-dimensional arrays.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>parameters</code> - the group of parameters.</dd> |
| <dt>Returns:</dt> |
| <dd>a matrix constructed from the specified group of parameters.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if <a href="#order()"><code>order()</code></a> does not return 2.</dd> |
| <dd><code><a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/InvalidParameterNameException.html" title="class or interface in org.opengis.parameter" class="external-link">InvalidParameterNameException</a></code> - if a parameter name was not recognized.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="#createValueGroup(java.util.Map,org.opengis.referencing.operation.Matrix)"><code>createValueGroup(Map, Matrix)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hashCode()"> |
| <h3>hashCode</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">hashCode</span>()</div> |
| <div class="block">Returns a hash code value for this object.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>a hash code value.</dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="equals(java.lang.Object)"> |
| <h3>equals</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">equals</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> other)</span></div> |
| <div class="block">Compares this object with the given object for equality.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>other</code> - the other object to compare with this object.</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if both object are equal.</dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> |
| <div class="block">Returns a string representation of this object for debugging purposes.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| </div> |
| </body> |
| </html> |
