| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (19) --> |
| <title>ElevationAngle (Apache SIS 1.3 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="description" content="declaration: package: org.apache.sis.measure, class: ElevationAngle"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.measure.ElevationAngle class"> |
| <meta name="keywords" content="ZENITH"> |
| <meta name="keywords" content="NADIR"> |
| <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"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.6.0.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="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/ElevationAngle.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Summary:</p> |
| <ul> |
| <li>Nested</li> |
| <li><a href="#field-summary">Field</a></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><a href="#field-detail">Field</a></li> |
| <li><a href="#constructor-detail">Constr</a></li> |
| <li>Method</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><a href="#field-summary">Field</a> | </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><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li>Method</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="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.sis.measure</a></div> |
| <h1 title="Class ElevationAngle" class="title">Class ElevationAngle</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| <div class="inheritance"><a href="Angle.html" title="class in org.apache.sis.measure">Angle</a> |
| <div class="inheritance">ElevationAngle</div> |
| </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/16/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/16/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="Angle.html" title="class in org.apache.sis.measure">Angle</a>></code>, <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Formattable.html" title="class or interface in java.util" class="external-link">Formattable</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">ElevationAngle</span> |
| <span class="extends-implements">extends <a href="Angle.html" title="class in org.apache.sis.measure">Angle</a></span></div> |
| <div class="block">The angular height of an object measured from the horizontal plane. |
| The elevation angle is part of <cite>local topocentric coordinates</cite> together with azimuth and distance. |
| For visible objects the elevation is an angle between 0° and 90°. |
| |
| <div class="note"><b>Note:</b> |
| <cite>Elevation angle</cite> and <cite>altitude angle</cite> may be used interchangeably. |
| Both <cite>altitude</cite> and <cite>elevation</cite> words are also used to describe the |
| height in meters above sea level.</div> |
| |
| <h2>Immutability and thread safety</h2> |
| This final class is immutable and thus inherently thread-safe.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>0.4</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="../referencing/cs/CoordinateSystems.html#angle(org.opengis.referencing.cs.AxisDirection,org.opengis.referencing.cs.AxisDirection)"><code>CoordinateSystems.angle(AxisDirection, AxisDirection)</code></a></li> |
| <li><a href="../../../../serialized-form.html#org.apache.sis.measure.ElevationAngle">Serialized Form</a></li> |
| </ul> |
| </dd> |
| |
| <p><font size="-1">Defined in the <code>sis-utility</code> module</font></p> |
| </dl> |
| </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="ElevationAngle.html" title="class in org.apache.sis.measure">ElevationAngle</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#NADIR" class="member-name-link">NADIR</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">An elevation angle of -90° for an imaginary point directly below a location.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final <a href="ElevationAngle.html" title="class in org.apache.sis.measure">ElevationAngle</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#ZENITH" class="member-name-link">ZENITH</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">An elevation angle of 90° for an imaginary point directly above a location.</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 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(double)" class="member-name-link">ElevationAngle</a><wbr>(double ε)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Constructs a new elevation angle with the specified angular value.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String)" class="member-name-link">ElevationAngle</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Constructs a newly allocated <code>ElevationAngle</code> object that contain the angular value |
| represented by the string.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Angle">Methods inherited from class <a href="Angle.html" title="class in org.apache.sis.measure">Angle</a></h3> |
| <code><a href="Angle.html#compareTo(org.apache.sis.measure.Angle)">compareTo</a>, <a href="Angle.html#degrees()">degrees</a>, <a href="Angle.html#equals(java.lang.Object)">equals</a>, <a href="Angle.html#formatTo(java.util.Formatter,int,int,int)">formatTo</a>, <a href="Angle.html#hashCode()">hashCode</a>, <a href="Angle.html#radians()">radians</a>, <a href="Angle.html#toString()">toString</a></code></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/16/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/16/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/16/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/16/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/16/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/16/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/16/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/16/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/16/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="ZENITH"> |
| <h3>ZENITH</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ElevationAngle.html" title="class in org.apache.sis.measure">ElevationAngle</a></span> <span class="element-name">ZENITH</span></div> |
| <div class="block">An elevation angle of 90° for an imaginary point directly above a location. |
| This is the opposite of <a href="#NADIR"><code>NADIR</code></a> direction.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="NADIR"> |
| <h3>NADIR</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ElevationAngle.html" title="class in org.apache.sis.measure">ElevationAngle</a></span> <span class="element-name">NADIR</span></div> |
| <div class="block">An elevation angle of -90° for an imaginary point directly below a location. |
| This is the opposite of <a href="#ZENITH"><code>ZENITH</code></a> direction.</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>(double)"> |
| <h3>ElevationAngle</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ElevationAngle</span><wbr><span class="parameters">(double ε)</span></div> |
| <div class="block">Constructs a new elevation angle with the specified angular value.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>ε</code> - elevation angle value in decimal degrees.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String)"> |
| <h3>ElevationAngle</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ElevationAngle</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NumberFormatException.html" title="class or interface in java.lang" class="external-link">NumberFormatException</a></span></div> |
| <div class="block">Constructs a newly allocated <code>ElevationAngle</code> object that contain the angular value |
| represented by the string. The string should represent an angle in either fractional degrees |
| (e.g. 45.5°) or degrees with minutes and seconds (e.g. 45°30').</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>string</code> - a string to be converted to an <code>ElevationAngle</code>.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NumberFormatException.html" title="class or interface in java.lang" class="external-link">NumberFormatException</a></code> - if the string does not contain a parsable angle, |
| or represents an elevation angle.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2010–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
