marine-tracker / docs /analysis.html
narniagooooo's picture
Initial commit: marine mammal tracking dashboard and route prediction
27b6a20
Raw History Blame Contribute Delete
4.74 kB
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Python: module analysis</title>
</head><body>
<table class="heading">
<tr class="heading-text decor">
<td class="title">&nbsp;<br><strong class="title">analysis</strong></td>
<td class="extra"><a href=".">index</a><br><a href="file:/Users/samuelveliveli/Downloads/marine-tracker/src/analysis.py">/Users/samuelveliveli/Downloads/marine-tracker/src/analysis.py</a></td></tr></table>
<p><span class="code">Per-individual&nbsp;and&nbsp;per-study&nbsp;movement&nbsp;analysis.<br>
&nbsp;<br>
Distance/speed/activity-pattern&nbsp;metrics&nbsp;work&nbsp;for&nbsp;any&nbsp;study&nbsp;in&nbsp;the&nbsp;common<br>
event&nbsp;schema&nbsp;(see&nbsp;ingest.py).&nbsp;Dive&nbsp;metrics&nbsp;only&nbsp;apply&nbsp;to&nbsp;studies&nbsp;whose&nbsp;raw<br>
data&nbsp;includes&nbsp;a&nbsp;depth/pressure&nbsp;sensor&nbsp;column&nbsp;--&nbsp;none&nbsp;of&nbsp;this&nbsp;project's&nbsp;three<br>
default&nbsp;studies&nbsp;are&nbsp;depth-instrumented&nbsp;(they're&nbsp;Argos/GPS&nbsp;location-only),&nbsp;so<br>
<a href="#-dive_metrics">dive_metrics</a>()&nbsp;detects&nbsp;that&nbsp;and&nbsp;returns&nbsp;None&nbsp;rather&nbsp;than&nbsp;fabricating&nbsp;numbers.</span></p>
<p>
<table class="section">
<tr class="decor pkg-content-decor heading-text">
<td class="section-title" colspan=3>&nbsp;<br><strong class="bigsection">Modules</strong></td></tr>
<tr><td class="decor pkg-content-decor"><span class="code">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span></td><td>&nbsp;</td>
<td class="singlecolumn"><table><tr><td class="multicolumn"><a href="numpy.html">numpy</a><br>
</td><td class="multicolumn"><a href="pandas.html">pandas</a><br>
</td><td class="multicolumn"></td><td class="multicolumn"></td></tr></table></td></tr></table><p>
<table class="section">
<tr class="decor functions-decor heading-text">
<td class="section-title" colspan=3>&nbsp;<br><strong class="bigsection">Functions</strong></td></tr>
<tr><td class="decor functions-decor"><span class="code">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span></td><td>&nbsp;</td>
<td class="singlecolumn"><dl><dt><a name="-activity_pattern"><strong>activity_pattern</strong></a>(individual_df)</dt><dd><span class="code">Fix&nbsp;count&nbsp;by&nbsp;hour-of-day&nbsp;(0-23,&nbsp;UTC&nbsp;as&nbsp;provided&nbsp;by&nbsp;Movebank),&nbsp;a&nbsp;simple&nbsp;activity&nbsp;proxy.<br>
&nbsp;<br>
Not&nbsp;a&nbsp;true&nbsp;diel&nbsp;activity/dive-behavior&nbsp;classification&nbsp;--&nbsp;just&nbsp;how&nbsp;the<br>
fixes&nbsp;are&nbsp;distributed&nbsp;across&nbsp;the&nbsp;day,&nbsp;which&nbsp;can&nbsp;hint&nbsp;at&nbsp;surfacing<br>
patterns&nbsp;if&nbsp;the&nbsp;tag&nbsp;only&nbsp;reports&nbsp;while&nbsp;at&nbsp;the&nbsp;surface.</span></dd></dl>
<dl><dt><a name="-dive_metrics"><strong>dive_metrics</strong></a>(individual_df)</dt><dd><span class="code">Dive/surface&nbsp;summary&nbsp;if&nbsp;the&nbsp;raw&nbsp;data&nbsp;includes&nbsp;a&nbsp;depth&nbsp;or&nbsp;pressure&nbsp;column,&nbsp;else&nbsp;None.</span></dd></dl>
<dl><dt><a name="-individual_summary"><strong>individual_summary</strong></a>(individual_df)</dt><dd><span class="code">Total&nbsp;distance&nbsp;(km),&nbsp;average&nbsp;speed&nbsp;(km/h),&nbsp;and&nbsp;track&nbsp;span&nbsp;for&nbsp;one&nbsp;individual's&nbsp;fixes.</span></dd></dl>
<dl><dt><a name="-movement_corridor_bins"><strong>movement_corridor_bins</strong></a>(study_df, grid_size_deg=0.5)</dt><dd><span class="code">Aggregate&nbsp;all&nbsp;individuals'&nbsp;fixes&nbsp;into&nbsp;a&nbsp;lat/lon&nbsp;grid&nbsp;for&nbsp;a&nbsp;movement-corridor&nbsp;density&nbsp;overlay.<br>
&nbsp;<br>
Returns&nbsp;a&nbsp;DataFrame&nbsp;of&nbsp;(lat_bin,&nbsp;lon_bin,&nbsp;count),&nbsp;suitable&nbsp;for&nbsp;a&nbsp;heatmap<br>
showing&nbsp;which&nbsp;areas&nbsp;the&nbsp;study's&nbsp;tracked&nbsp;individuals&nbsp;used&nbsp;most,&nbsp;as&nbsp;a<br>
reasonable&nbsp;"movement&nbsp;corridor"&nbsp;proxy&nbsp;without&nbsp;fitting&nbsp;a&nbsp;formal&nbsp;utilization<br>
distribution&nbsp;model.</span></dd></dl>
<dl><dt><a name="-study_summary"><strong>study_summary</strong></a>(study_df)</dt><dd><span class="code">Per-individual&nbsp;summary&nbsp;table&nbsp;for&nbsp;every&nbsp;individual&nbsp;in&nbsp;a&nbsp;study's&nbsp;DataFrame.</span></dd></dl>
</td></tr></table><p>
<table class="section">
<tr class="decor data-decor heading-text">
<td class="section-title" colspan=3>&nbsp;<br><strong class="bigsection">Data</strong></td></tr>
<tr><td class="decor data-decor"><span class="code">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span></td><td>&nbsp;</td>
<td class="singlecolumn"><strong>DEPTH_COLUMN_CANDIDATES</strong> = ['depth', 'pressure', 'argos:depth', 'eobs:pressure']</td></tr></table>
</body></html>