doc/JavaDoc/ch/epfl/sdp/peakar/points/ElevationMap.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_242-release) on Fri Jun 04 18:15:39 CEST 2021 -->
<title>ElevationMap</title>
<meta name="date" content="2021-06-04">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ElevationMap";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../ch/epfl/sdp/peakar/points/DownloadTopographyTask.html" title="class in ch.epfl.sdp.peakar.points"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../ch/epfl/sdp/peakar/points/Geonames.html" title="interface in ch.epfl.sdp.peakar.points"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?ch/epfl/sdp/peakar/points/ElevationMap.html" target="_top">Frames</a></li>
<li><a href="ElevationMap.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<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="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">ch.epfl.sdp.peakar.points</div>
<h2 title="Class ElevationMap" class="title">Class ElevationMap</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>ch.epfl.sdp.peakar.points.ElevationMap</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">ElevationMap</span>
extends java.lang.Object</pre>
<div class="block">ElevationMap is a class that represents the elevation map of the bounding box sorrounding the user.
The Elevation map is retrieved using the OpenTopography API as an AAIGrid and then converted into
an array of integers representing the height. Using the SRTMGL3 data a precision of 3 arc second
(~90 meter) is obtained.
A method to obtain an updated elevation map is provided.
A method to obtain the altitude at a certain location (using coordinates or indexes is provided).
A method to compute the indexes of coordinates for accessing the topography map is provided.
A method to obtain the map cell size in arcs/s is provided.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/points/ElevationMap.html#ElevationMap-androidx.core.util.Pair-ch.epfl.sdp.peakar.points.UserPoint-android.content.Context-">ElevationMap</a></span>(androidx.core.util.Pair<int[][],java.lang.Double> topography,
<a href="../../../../../ch/epfl/sdp/peakar/points/UserPoint.html" title="class in ch.epfl.sdp.peakar.points">UserPoint</a> userPoint,
android.content.Context context)</code>
<div class="block">Constructor for the ElevationMap.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/points/ElevationMap.html#getAltitudeAtLocation-double-double-">getAltitudeAtLocation</a></span>(double latitude,
double longitude)</code>
<div class="block">This method returns the altitude at a given location.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/points/ElevationMap.html#getAltitudeAtLocation-int-int-">getAltitudeAtLocation</a></span>(int row,
int col)</code>
<div class="block">This method returns the altitude at a given location.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/points/ElevationMap.html#getBoundingBoxNorthLat--">getBoundingBoxNorthLat</a></span>()</code>
<div class="block">Getter for the north latitude of the bounding box</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/points/ElevationMap.html#getBoundingBoxWestLong--">getBoundingBoxWestLong</a></span>()</code>
<div class="block">Getter for the west longitude of the bounding box</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>androidx.core.util.Pair<java.lang.Integer,java.lang.Integer></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/points/ElevationMap.html#getIndexesFromCoordinates-double-double-">getIndexesFromCoordinates</a></span>(double latitude,
double longitude)</code>
<div class="block">Method that converts coordinates into indexes for accessing the topography map matrix.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/points/ElevationMap.html#getMapCellSize--">getMapCellSize</a></span>()</code>
<div class="block">Getter for the map cell size</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int[][]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/points/ElevationMap.html#getTopographyMap--">getTopographyMap</a></span>()</code>
<div class="block">Public method to retrieve the elevation map.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/points/ElevationMap.html#updateElevationMatrix--">updateElevationMatrix</a></span>()</code>
<div class="block">This method handles the updating of the elevation map.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ElevationMap-androidx.core.util.Pair-ch.epfl.sdp.peakar.points.UserPoint-android.content.Context-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ElevationMap</h4>
<pre>public ElevationMap(androidx.core.util.Pair<int[][],java.lang.Double> topography,
<a href="../../../../../ch/epfl/sdp/peakar/points/UserPoint.html" title="class in ch.epfl.sdp.peakar.points">UserPoint</a> userPoint,
android.content.Context context)</pre>
<div class="block">Constructor for the ElevationMap.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>topography</code> - pair with topography map and cell size.</dd>
<dd><code>userPoint</code> - the user point around which the bounding box is computed.</dd>
<dd><code>context</code> - context of the application.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getTopographyMap--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTopographyMap</h4>
<pre>public int[][] getTopographyMap()</pre>
<div class="block">Public method to retrieve the elevation map.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an int[][] array representing the elevation map.</dd>
</dl>
</li>
</ul>
<a name="updateElevationMatrix--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateElevationMatrix</h4>
<pre>public void updateElevationMatrix()</pre>
<div class="block">This method handles the updating of the elevation map. First the distance between the center
of the current bounding box and the current user location is computed.
If less than MINIMUM_DISTANCE_FOR_UPDATE no new map is downloaded, otherwise a new map is
downloaded.</div>
</li>
</ul>
<a name="getAltitudeAtLocation-double-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAltitudeAtLocation</h4>
<pre>public int getAltitudeAtLocation(double latitude,
double longitude)</pre>
<div class="block">This method returns the altitude at a given location.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>latitude</code> - latitude (in degrees).</dd>
<dd><code>longitude</code> - longitude (in degrees).</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>elevation at the given location (in meters).</dd>
</dl>
</li>
</ul>
<a name="getAltitudeAtLocation-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAltitudeAtLocation</h4>
<pre>public int getAltitudeAtLocation(int row,
int col)</pre>
<div class="block">This method returns the altitude at a given location.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>row</code> - row to access</dd>
<dd><code>col</code> - col to access</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>elevation at the given location (in meters).</dd>
</dl>
</li>
</ul>
<a name="getIndexesFromCoordinates-double-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIndexesFromCoordinates</h4>
<pre>public androidx.core.util.Pair<java.lang.Integer,java.lang.Integer> getIndexesFromCoordinates(double latitude,
double longitude)</pre>
<div class="block">Method that converts coordinates into indexes for accessing the topography map matrix.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>latitude</code> - latitude (in degrees).</dd>
<dd><code>longitude</code> - longitude (in degrees).</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>returns a Pair with the first element being the row, the second the column.</dd>
</dl>
</li>
</ul>
<a name="getMapCellSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMapCellSize</h4>
<pre>public double getMapCellSize()</pre>
<div class="block">Getter for the map cell size</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>double representing the size of the cells in arcs/s</dd>
</dl>
</li>
</ul>
<a name="getBoundingBoxWestLong--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBoundingBoxWestLong</h4>
<pre>public double getBoundingBoxWestLong()</pre>
<div class="block">Getter for the west longitude of the bounding box</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>west longitude of the bounding box (in degrees)</dd>
</dl>
</li>
</ul>
<a name="getBoundingBoxNorthLat--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getBoundingBoxNorthLat</h4>
<pre>public double getBoundingBoxNorthLat()</pre>
<div class="block">Getter for the north latitude of the bounding box</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>north latitude of the bounding box (in degrees)</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../ch/epfl/sdp/peakar/points/DownloadTopographyTask.html" title="class in ch.epfl.sdp.peakar.points"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../ch/epfl/sdp/peakar/points/Geonames.html" title="interface in ch.epfl.sdp.peakar.points"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?ch/epfl/sdp/peakar/points/ElevationMap.html" target="_top">Frames</a></li>
<li><a href="ElevationMap.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<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="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>