| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 --> |
| <title>Plane (Apache SIS 1.4 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2023-10-05"> |
| <meta name="description" content="declaration: module: org.apache.sis.util, package: org.apache.sis.math, class: Plane"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.math.Plane class"> |
| <meta name="keywords" content="slopeX()"> |
| <meta name="keywords" content="slopeY()"> |
| <meta name="keywords" content="z0()"> |
| <meta name="keywords" content="x()"> |
| <meta name="keywords" content="y()"> |
| <meta name="keywords" content="z()"> |
| <meta name="keywords" content="applyAsDouble()"> |
| <meta name="keywords" content="setEquation()"> |
| <meta name="keywords" content="fit()"> |
| <meta name="keywords" content="clone()"> |
| <meta name="keywords" content="equals()"> |
| <meta name="keywords" content="hashCode()"> |
| <meta name="keywords" content="toString()"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../sis.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="../../../../module-summary.html">Module</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Summary:</p> |
| <ul> |
| <li>Nested</li> |
| <li>Field</li> |
| <li><a href="#constructor-summary">Constr</a></li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li>Field</li> |
| <li><a href="#constructor-detail">Constr</a></li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><a href="../../../../../search.html">SEARCH</a> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-type">Module</span> <a href="../../../../module-summary.html">org.apache.sis.util</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.sis.math</a></div> |
| <h1 title="Class Plane" class="title">Class Plane</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| <div class="inheritance">Plane</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/DoubleBinaryOperator.html" title="class or interface in java.util.function" class="external-link">DoubleBinaryOperator</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Plane</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/DoubleBinaryOperator.html" title="class or interface in java.util.function" class="external-link">DoubleBinaryOperator</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></span></div> |
| <div class="block">Equation of a plane in a three-dimensional space (<var>x</var>,<var>y</var>,<var>z</var>). |
| The plane equation is expressed by <a href="#slopeX()">sx</a>, <a href="#slopeY()">sy</a> and |
| <a href="#z0()">z₀</a> coefficients as below: |
| |
| <blockquote> |
| <var><a href="#z(double,double)">z</a></var>(<var>x</var>,<var>y</var>) = |
| <var>sx</var>⋅<var>x</var> + <var>sy</var>⋅<var>y</var> + <var>z₀</var> |
| </blockquote> |
| |
| Those coefficients can be set directly, or computed by a linear regression of this plane |
| through a set of three-dimensional points.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>0.5</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list"> |
| <li><a href="Line.html" title="class in org.apache.sis.math"><code>Line</code></a></li> |
| <li><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/operation/builder/LinearTransformBuilder.html" title="class in org.apache.sis.referencing.operation.builder"><code>LinearTransformBuilder</code></a></li> |
| <li><a href="../../../../../serialized-form.html#org.apache.sis.math.Plane">Serialized Form</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Plane</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Constructs a new plane with all coefficients initialized to <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html#NaN" title="class or interface in java.lang" class="external-link"><code>Double.NaN</code></a>.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(double,double,double)" class="member-name-link">Plane</a><wbr>(double sx, |
| double sy, |
| double z0)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Constructs a new plane initialized to the given coefficients.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#applyAsDouble(double,double)" class="member-name-link">applyAsDouble</a><wbr>(double x, |
| double y)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Evaluates this equation for the given values.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Plane.html" title="class in org.apache.sis.math">Plane</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clone()" class="member-name-link">clone</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 clone of this plane.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-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/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> object)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Compares this plane with the specified object for equality.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#fit(double%5B%5D,double%5B%5D,double%5B%5D)" class="member-name-link">fit</a><wbr>(double[] x, |
| double[] y, |
| double[] z)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Computes the plane's coefficients from the given coordinate values.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#fit(int,int,org.apache.sis.math.Vector)" class="member-name-link">fit</a><wbr>(int nx, |
| int ny, |
| <a href="Vector.html" title="class in org.apache.sis.math">Vector</a> z)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Computes the plane's coefficients from values distributed on a regular grid.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#fit(java.lang.Iterable)" class="member-name-link">fit</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><? extends <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/DirectPosition.html" title="class or interface in org.opengis.geometry" class="external-link">DirectPosition</a>> points)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Computes the plane's coefficients from the given sequence of points.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#fit(org.apache.sis.math.Vector,org.apache.sis.math.Vector,org.apache.sis.math.Vector)" class="member-name-link">fit</a><wbr>(<a href="Vector.html" title="class in org.apache.sis.math">Vector</a> x, |
| <a href="Vector.html" title="class in org.apache.sis.math">Vector</a> y, |
| <a href="Vector.html" title="class in org.apache.sis.math">Vector</a> z)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Computes the plane's coefficients from the given coordinate 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 plane.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setEquation(double,double,double)" class="member-name-link">setEquation</a><wbr>(double sx, |
| double sy, |
| double z0)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the equation of this plane to the given coefficients.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setEquation(java.lang.Number,java.lang.Number,java.lang.Number)" class="member-name-link">setEquation</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a> sx, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a> sy, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a> z0)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets this plane from values of arbitrary <code>Number</code> type.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final double</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#slopeX()" class="member-name-link">slopeX</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 slope along the <var>x</var> values.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final double</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#slopeY()" class="member-name-link">slopeY</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the slope along the <var>y</var> values.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a string representation of this plane.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final double</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#x(double,double)" class="member-name-link">x</a><wbr>(double y, |
| double z)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Computes the <var>x</var> value for the specified (<var>y</var>,<var>z</var>) point.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final double</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#y(double,double)" class="member-name-link">y</a><wbr>(double x, |
| double z)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Computes the <var>y</var> value for the specified (<var>x</var>,<var>z</var>) point.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final double</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#z(double,double)" class="member-name-link">z</a><wbr>(double x, |
| double y)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Computes the <var>z</var> value for the specified (<var>x</var>,<var>y</var>) point.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final double</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#z0()" class="member-name-link">z0</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 <var>z</var> value at (<var>x</var>,<var>y</var>) = (0,0).</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/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>Plane</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Plane</span>()</div> |
| <div class="block">Constructs a new plane with all coefficients initialized to <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html#NaN" title="class or interface in java.lang" class="external-link"><code>Double.NaN</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(double,double,double)"> |
| <h3>Plane</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Plane</span><wbr><span class="parameters">(double sx, |
| double sy, |
| double z0)</span></div> |
| <div class="block">Constructs a new plane initialized to the given coefficients.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sx</code> - the slope along the <var>x</var> values.</dd> |
| <dd><code>sy</code> - the slope along the <var>y</var> values.</dd> |
| <dd><code>z0</code> - the <var>z</var> value at (<var>x</var>,<var>y</var>) = (0,0).</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="#setEquation(double,double,double)"><code>setEquation(double, double, double)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </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="slopeX()"> |
| <h3>slopeX</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">double</span> <span class="element-name">slopeX</span>()</div> |
| <div class="block">Returns the slope along the <var>x</var> values. This coefficient appears in the plane equation |
| <var><b><u>sx</u></b></var>⋅<var>x</var> + <var>sy</var>⋅<var>y</var> + <var>z₀</var>.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the <var>sx</var> term.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="slopeY()"> |
| <h3>slopeY</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">double</span> <span class="element-name">slopeY</span>()</div> |
| <div class="block">Returns the slope along the <var>y</var> values. This coefficient appears in the plane equation |
| <var>sx</var>⋅<var>x</var> + <var><b><u>sy</u></b></var>⋅<var>y</var> + <var>z₀</var>.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the <var>sy</var> term.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="z0()"> |
| <h3>z0</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">double</span> <span class="element-name">z0</span>()</div> |
| <div class="block">Returns the <var>z</var> value at (<var>x</var>,<var>y</var>) = (0,0). This coefficient appears in the |
| plane equation <var>sx</var>⋅<var>x</var> + <var>sy</var>⋅<var>y</var> + <b><var>z₀</var></b>.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the <var>z₀</var> term.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="#z(double,double)"><code>z(double, double)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="x(double,double)"> |
| <h3>x</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">double</span> <span class="element-name">x</span><wbr><span class="parameters">(double y, |
| double z)</span></div> |
| <div class="block">Computes the <var>x</var> value for the specified (<var>y</var>,<var>z</var>) point. |
| The <var>x</var> value is computed using the following equation: |
| |
| <blockquote>x(y,z) = (z - (<a href="#z0()">z₀</a> + <a href="#slopeY()">sy</a>⋅y)) / <a href="#slopeX()">sx</a></blockquote></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>y</code> - the <var>y</var> value where to compute <var>x</var>.</dd> |
| <dd><code>z</code> - the <var>z</var> value where to compute <var>x</var>.</dd> |
| <dt>Returns:</dt> |
| <dd>the <var>x</var> value.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="y(double,double)"> |
| <h3>y</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">double</span> <span class="element-name">y</span><wbr><span class="parameters">(double x, |
| double z)</span></div> |
| <div class="block">Computes the <var>y</var> value for the specified (<var>x</var>,<var>z</var>) point. |
| The <var>y</var> value is computed using the following equation: |
| |
| <blockquote>y(x,z) = (z - (<a href="#z0()">z₀</a> + <a href="#slopeX()">sx</a>⋅x)) / <a href="#slopeY()">sy</a></blockquote></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>x</code> - the <var>x</var> value where to compute <var>y</var>.</dd> |
| <dd><code>z</code> - the <var>z</var> value where to compute <var>y</var>.</dd> |
| <dt>Returns:</dt> |
| <dd>the <var>y</var> value.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="z(double,double)"> |
| <h3>z</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">double</span> <span class="element-name">z</span><wbr><span class="parameters">(double x, |
| double y)</span></div> |
| <div class="block">Computes the <var>z</var> value for the specified (<var>x</var>,<var>y</var>) point. |
| The <var>z</var> value is computed using the following equation: |
| |
| <blockquote>z(x,y) = <a href="#slopeX()">sx</a>⋅x + <a href="#slopeY()">sy</a>⋅y + <a href="#z0()">z₀</a></blockquote></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>x</code> - the <var>x</var> value where to compute <var>z</var>.</dd> |
| <dd><code>y</code> - the <var>y</var> value where to compute <var>z</var>.</dd> |
| <dt>Returns:</dt> |
| <dd>the <var>z</var> value.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list"> |
| <li><a href="#z0()"><code>z0()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="applyAsDouble(double,double)"> |
| <h3>applyAsDouble</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">applyAsDouble</span><wbr><span class="parameters">(double x, |
| double y)</span></div> |
| <div class="block">Evaluates this equation for the given values. The default implementation delegates to |
| <a href="#z(double,double)"><code>z(x,y)</code></a>, but subclasses may override with different formulas. |
| This method is provided for interoperability with libraries making use of <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/package-summary.html" class="external-link"><code>java.util.function</code></a>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/DoubleBinaryOperator.html#applyAsDouble(double,double)" title="class or interface in java.util.function" class="external-link">applyAsDouble</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/DoubleBinaryOperator.html" title="class or interface in java.util.function" class="external-link">DoubleBinaryOperator</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>x</code> - the first operand where to evaluate the function.</dd> |
| <dd><code>y</code> - the second operand where to evaluate the function.</dd> |
| <dt>Returns:</dt> |
| <dd>the function value for the given operands.</dd> |
| <dt>Since:</dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setEquation(double,double,double)"> |
| <h3>setEquation</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setEquation</span><wbr><span class="parameters">(double sx, |
| double sy, |
| double z0)</span></div> |
| <div class="block">Sets the equation of this plane to the given coefficients.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sx</code> - the slope along the <var>x</var> values.</dd> |
| <dd><code>sy</code> - the slope along the <var>y</var> values.</dd> |
| <dd><code>z0</code> - the <var>z</var> value at (<var>x</var>,<var>y</var>) = (0,0).</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setEquation(java.lang.Number,java.lang.Number,java.lang.Number)"> |
| <h3>setEquation</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setEquation</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a> sx, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a> sy, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a> z0)</span></div> |
| <div class="block">Sets this plane from values of arbitrary <code>Number</code> type. This method is invoked by algorithms that |
| may produce other kind of numbers (for example with different precision) than the usual <code>double</code> |
| primitive type. The default implementation delegates to <a href="#setEquation(double,double,double)"><code>setEquation(double, double, double)</code></a>, |
| but subclasses can override this method if they want to process other kind of numbers in a special way.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sx</code> - the slope along the <var>x</var> values.</dd> |
| <dd><code>sy</code> - the slope along the <var>y</var> values.</dd> |
| <dd><code>z0</code> - the <var>z</var> value at (<var>x</var>,<var>y</var>) = (0,0).</dd> |
| <dt>Since:</dt> |
| <dd>0.8</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fit(double[],double[],double[])"> |
| <h3>fit</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">fit</span><wbr><span class="parameters">(double[] x, |
| double[] y, |
| double[] z)</span></div> |
| <div class="block">Computes the plane's coefficients from the given coordinate values. |
| This method uses a linear regression in the least-square sense, with the assumption that |
| the (<var>x</var>,<var>y</var>) values are precise and all uncertainty is in <var>z</var>. |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html#NaN" title="class or interface in java.lang" class="external-link"><code>Double.NaN</code></a> values are ignored. The result is undetermined if all points are colinear. |
| |
| <p>The default implementation delegates to <a href="#fit(org.apache.sis.math.Vector,org.apache.sis.math.Vector,org.apache.sis.math.Vector)"><code>fit(Vector, Vector, Vector)</code></a>.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>x</code> - vector of <var>x</var> coordinates.</dd> |
| <dd><code>y</code> - vector of <var>y</var> coordinates.</dd> |
| <dd><code>z</code> - vector of <var>z</var> values.</dd> |
| <dt>Returns:</dt> |
| <dd>an estimation of the Pearson correlation coefficient. |
| The closer this coefficient is to +1 or -1, the better the fit.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if <var>x</var>, <var>y</var> and <var>z</var> do not have the same length.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fit(org.apache.sis.math.Vector,org.apache.sis.math.Vector,org.apache.sis.math.Vector)"> |
| <h3>fit</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">fit</span><wbr><span class="parameters">(<a href="Vector.html" title="class in org.apache.sis.math">Vector</a> x, |
| <a href="Vector.html" title="class in org.apache.sis.math">Vector</a> y, |
| <a href="Vector.html" title="class in org.apache.sis.math">Vector</a> z)</span></div> |
| <div class="block">Computes the plane's coefficients from the given coordinate values. |
| This method uses a linear regression in the least-square sense, with the assumption that |
| the (<var>x</var>,<var>y</var>) values are precise and all uncertainty is in <var>z</var>. |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html#NaN" title="class or interface in java.lang" class="external-link"><code>Double.NaN</code></a> values are ignored. The result is undetermined if all points are colinear. |
| |
| <p>The default implementation delegates to <a href="#fit(java.lang.Iterable)"><code>fit(Iterable)</code></a>.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>x</code> - vector of <var>x</var> coordinates.</dd> |
| <dd><code>y</code> - vector of <var>y</var> coordinates.</dd> |
| <dd><code>z</code> - vector of <var>z</var> values.</dd> |
| <dt>Returns:</dt> |
| <dd>an estimation of the Pearson correlation coefficient. |
| The closer this coefficient is to +1 or -1, the better the fit.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if <var>x</var>, <var>y</var> and <var>z</var> do not have the same length.</dd> |
| <dt>Since:</dt> |
| <dd>0.8</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fit(int,int,org.apache.sis.math.Vector)"> |
| <h3>fit</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">fit</span><wbr><span class="parameters">(int nx, |
| int ny, |
| <a href="Vector.html" title="class in org.apache.sis.math">Vector</a> z)</span></div> |
| <div class="block">Computes the plane's coefficients from values distributed on a regular grid. Invoking this method |
| is equivalent (except for NaN handling) to invoking <a href="#fit(org.apache.sis.math.Vector,org.apache.sis.math.Vector,org.apache.sis.math.Vector)"><code>fit(Vector, Vector, Vector)</code></a> where all |
| vectors have a length of <code>nx</code> × <code>ny</code> and the <var>x</var> and <var>y</var> vectors have |
| the following content: |
| |
| <blockquote> |
| <table class="compact"> |
| <caption><var>x</var> and <var>y</var> vectors content</caption> |
| <tr> |
| <th><var>x</var> vector</th> |
| <th><var>y</var> vector</th> |
| </tr><tr> |
| <td> |
| 0 1 2 3 4 5 … n<sub>x</sub>-1<br> |
| 0 1 2 3 4 5 … n<sub>x</sub>-1<br> |
| 0 1 2 3 4 5 … n<sub>x</sub>-1<br> |
| …<br> |
| 0 1 2 3 4 5 … n<sub>x</sub>-1<br> |
| </td><td> |
| 0 0 0 0 0 0 … 0<br> |
| 1 1 1 1 1 1 … 1<br> |
| 2 2 2 2 2 2 … 2<br> |
| …<br> |
| n<sub>y</sub>-1 n<sub>y</sub>-1 n<sub>y</sub>-1 … n<sub>y</sub>-1<br> |
| </td> |
| </tr> |
| </table> |
| </blockquote> |
| |
| This method uses a linear regression in the least-square sense, with the assumption that |
| the (<var>x</var>,<var>y</var>) values are precise and all uncertainty is in <var>z</var>. |
| The result is undetermined if all points are colinear.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>nx</code> - number of columns.</dd> |
| <dd><code>ny</code> - number of rows.</dd> |
| <dd><code>z</code> - values of a matrix of <code>nx</code> columns by <code>ny</code> rows organized in a row-major fashion.</dd> |
| <dt>Returns:</dt> |
| <dd>an estimation of the Pearson correlation coefficient. |
| The closer this coefficient is to +1 or -1, the better the fit.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if <var>z</var> does not have the expected length or if a <var>z</var> |
| value is <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html#NaN" title="class or interface in java.lang" class="external-link"><code>Double.NaN</code></a>.</dd> |
| <dt>Since:</dt> |
| <dd>0.8</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fit(java.lang.Iterable)"> |
| <h3>fit</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">fit</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><? extends <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/DirectPosition.html" title="class or interface in org.opengis.geometry" class="external-link">DirectPosition</a>> points)</span></div> |
| <div class="block">Computes the plane's coefficients from the given sequence of points. |
| This method uses a linear regression in the least-square sense, with the assumption that |
| the (<var>x</var>,<var>y</var>) values are precise and all uncertainty is in <var>z</var>. |
| Points shall be three dimensional with coordinate values in the (<var>x</var>,<var>y</var>,<var>z</var>) order. |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html#NaN" title="class or interface in java.lang" class="external-link"><code>Double.NaN</code></a> values are ignored. The result is undetermined if all points are colinear.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>points</code> - the three-dimensional points.</dd> |
| <dt>Returns:</dt> |
| <dd>an estimation of the Pearson correlation coefficient. |
| The closer this coefficient is to +1 or -1, the better the fit.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/MismatchedDimensionException.html" title="class or interface in org.opengis.geometry" class="external-link">MismatchedDimensionException</a></code> - if a point is not three-dimensional.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clone()"> |
| <h3>clone</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Plane.html" title="class in org.apache.sis.math">Plane</a></span> <span class="element-name">clone</span>()</div> |
| <div class="block">Returns a clone of this plane.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>a clone of this plane.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="equals(java.lang.Object)"> |
| <h3>equals</h3> |
| <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/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> object)</span></div> |
| <div class="block">Compares this plane with the specified object for equality.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#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/11/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>object</code> - the object to compare with this plane for equality.</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if both objects are equal.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hashCode()"> |
| <h3>hashCode</h3> |
| <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 plane.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#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/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> |
| <div class="block">Returns a string representation of this plane. |
| The string will contain the plane's equation, as below: |
| |
| <blockquote> |
| <var>z</var>(<var>x</var>,<var>y</var>) = <a href="#slopeX()">sx</a>⋅<var>x</var> |
| + <a href="#slopeY()">sy</a>⋅<var>y</var> + <a href="#z0()">z₀</a> |
| </blockquote></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |