/usr/share/doc/python-astroplan/html/api.html is in python-astroplan-doc 0.4-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Reference/API — astroplan v0.4</title>
<link rel="stylesheet" href="_static/bootstrap-astropy.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.4',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="file:///usr/share/javascript/mathjax/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/sidebar.js"></script>
<link rel="shortcut icon" href="_static/astropy_logo.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="download_IERS_A" href="api/astroplan.download_IERS_A.html" />
<link rel="prev" title="Getting Help & Contributing" href="faq/contribute.html" />
<link href='https://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600' rel='stylesheet' type='text/css'/>
<script type="text/javascript" src="_static/copybutton.js"></script>
</head>
<body>
<div class="topbar">
<a class="brand" title="Documentation Home" href="index.html"><span id="logotext1">astro</span><span id="logotext2">plan</span><span id="logotext3">:docs</span></a>
<ul>
<li><a class="homelink" title="Astropy Homepage" href="http://www.astropy.org"></a></li>
<li><a title="General Index" href="genindex.html">Index</a></li>
<li><a title="Module Index" href="py-modindex.html">Modules</a></li>
<li>
<form action="search.html" method="get">
<input type="text" name="q" placeholder="Search" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</li>
</ul>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right">
<a href="api/astroplan.download_IERS_A.html" title="download_IERS_A">
next »
</a>
</li>
<li class="right">
<a href="faq/contribute.html" title="Getting Help & Contributing">
« previous
</a>
|
</li>
<li>
<a href="index.html">astroplan v0.4</a>
»
</li>
<li>Reference/API</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="reference-api">
<span id="api"></span><h1>Reference/API<a class="headerlink" href="#reference-api" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-astroplan">
<span id="astroplan-package"></span><h2>astroplan Package<a class="headerlink" href="#module-astroplan" title="Permalink to this headline">¶</a></h2>
<p>astroplan is an open source (BSD licensed) observation planning package for
astronomers that can help you plan for everything but the clouds.</p>
<p>It is an in-development <a class="reference external" href="http://www.astropy.org">Astropy</a>
<a class="reference external" href="http://www.astropy.org/affiliated/index.html">affiliated package</a> that
seeks to make your life as an observational astronomer a little less
infuriating.</p>
<ul class="simple">
<li>Code: <a class="reference external" href="https://github.com/astropy/astroplan">https://github.com/astropy/astroplan</a></li>
<li>Docs: <a class="reference external" href="https://astroplan.readthedocs.io/">https://astroplan.readthedocs.io/</a></li>
</ul>
<div class="section" id="functions">
<h3>Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h3>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="api/astroplan.download_IERS_A.html#astroplan.download_IERS_A" title="astroplan.download_IERS_A"><code class="xref py py-obj docutils literal"><span class="pre">download_IERS_A</span></code></a>([show_progress])</td>
<td>Download and cache the IERS Bulletin A table.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="api/astroplan.get_IERS_A_or_workaround.html#astroplan.get_IERS_A_or_workaround" title="astroplan.get_IERS_A_or_workaround"><code class="xref py py-obj docutils literal"><span class="pre">get_IERS_A_or_workaround</span></code></a>()</td>
<td>Get the cached IERS Bulletin A table if one exists.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="api/astroplan.is_always_observable.html#astroplan.is_always_observable" title="astroplan.is_always_observable"><code class="xref py py-obj docutils literal"><span class="pre">is_always_observable</span></code></a>(constraints, observer, …)</td>
<td>A function to determine whether <code class="docutils literal"><span class="pre">targets</span></code> are always observable throughout <code class="docutils literal"><span class="pre">time_range</span></code> given constraints in the <code class="docutils literal"><span class="pre">constraints_list</span></code> for a particular <code class="docutils literal"><span class="pre">observer</span></code>.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="api/astroplan.is_event_observable.html#astroplan.is_event_observable" title="astroplan.is_event_observable"><code class="xref py py-obj docutils literal"><span class="pre">is_event_observable</span></code></a>(constraints, observer, …)</td>
<td>Determines if the <code class="docutils literal"><span class="pre">target</span></code> is observable at each time in <code class="docutils literal"><span class="pre">times</span></code>, given constraints in <code class="docutils literal"><span class="pre">constraints</span></code> for a particular <code class="docutils literal"><span class="pre">observer</span></code>.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="api/astroplan.is_observable.html#astroplan.is_observable" title="astroplan.is_observable"><code class="xref py py-obj docutils literal"><span class="pre">is_observable</span></code></a>(constraints, observer, targets)</td>
<td>Determines if the <code class="docutils literal"><span class="pre">targets</span></code> are observable during <code class="docutils literal"><span class="pre">time_range</span></code> given constraints in <code class="docutils literal"><span class="pre">constraints_list</span></code> for a particular <code class="docutils literal"><span class="pre">observer</span></code>.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="api/astroplan.max_best_rescale.html#astroplan.max_best_rescale" title="astroplan.max_best_rescale"><code class="xref py py-obj docutils literal"><span class="pre">max_best_rescale</span></code></a>(vals, min_val, max_val[, …])</td>
<td>rescales an input array <code class="docutils literal"><span class="pre">vals</span></code> to be a score (between zero and one),</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="api/astroplan.min_best_rescale.html#astroplan.min_best_rescale" title="astroplan.min_best_rescale"><code class="xref py py-obj docutils literal"><span class="pre">min_best_rescale</span></code></a>(vals, min_val, max_val[, …])</td>
<td>rescales an input array <code class="docutils literal"><span class="pre">vals</span></code> to be a score (between zero and one),</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="api/astroplan.months_observable.html#astroplan.months_observable" title="astroplan.months_observable"><code class="xref py py-obj docutils literal"><span class="pre">months_observable</span></code></a>(constraints, observer, targets)</td>
<td>Determines which month the specified <code class="docutils literal"><span class="pre">targets</span></code> are observable for a specific <code class="docutils literal"><span class="pre">observer</span></code>, given the supplied <code class="docutils literal"><span class="pre">constriants</span></code>.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="api/astroplan.moon_illumination.html#astroplan.moon_illumination" title="astroplan.moon_illumination"><code class="xref py py-obj docutils literal"><span class="pre">moon_illumination</span></code></a>(time[, ephemeris])</td>
<td>Calculate fraction of the moon illuminated.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="api/astroplan.moon_phase_angle.html#astroplan.moon_phase_angle" title="astroplan.moon_phase_angle"><code class="xref py py-obj docutils literal"><span class="pre">moon_phase_angle</span></code></a>(time[, ephemeris])</td>
<td>Calculate lunar orbital phase in radians.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="api/astroplan.observability_table.html#astroplan.observability_table" title="astroplan.observability_table"><code class="xref py py-obj docutils literal"><span class="pre">observability_table</span></code></a>(constraints, observer, …)</td>
<td>Creates a table with information about observability for all the <code class="docutils literal"><span class="pre">targets</span></code> over the requested <code class="docutils literal"><span class="pre">time_range</span></code>, given the constraints in <code class="docutils literal"><span class="pre">constraints_list</span></code> for <code class="docutils literal"><span class="pre">observer</span></code>.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="api/astroplan.stride_array.html#astroplan.stride_array" title="astroplan.stride_array"><code class="xref py py-obj docutils literal"><span class="pre">stride_array</span></code></a>(arr, window_width)</td>
<td>Computes all possible sequential subarrays of arr with length = window_width</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="api/astroplan.test.html#astroplan.test" title="astroplan.test"><code class="xref py py-obj docutils literal"><span class="pre">test</span></code></a>([package, test_path, args, plugins, …])</td>
<td>Run the tests using <a class="reference external" href="http://pytest.org/latest">py.test</a>.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="api/astroplan.time_grid_from_range.html#astroplan.time_grid_from_range" title="astroplan.time_grid_from_range"><code class="xref py py-obj docutils literal"><span class="pre">time_grid_from_range</span></code></a>(time_range[, …])</td>
<td>Get linearly-spaced sequence of times.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="classes">
<h3>Classes<a class="headerlink" href="#classes" title="Permalink to this headline">¶</a></h3>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="api/astroplan.AirmassConstraint.html#astroplan.AirmassConstraint" title="astroplan.AirmassConstraint"><code class="xref py py-obj docutils literal"><span class="pre">AirmassConstraint</span></code></a>([max, min, boolean_constraint])</td>
<td>Constrain the airmass of a target.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="api/astroplan.AltitudeConstraint.html#astroplan.AltitudeConstraint" title="astroplan.AltitudeConstraint"><code class="xref py py-obj docutils literal"><span class="pre">AltitudeConstraint</span></code></a>([min, max, …])</td>
<td>Constrain the altitude of the target.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="api/astroplan.AstroplanWarning.html#astroplan.AstroplanWarning" title="astroplan.AstroplanWarning"><code class="xref py py-obj docutils literal"><span class="pre">AstroplanWarning</span></code></a></td>
<td>Superclass for warnings used by astroplan</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="api/astroplan.AtNightConstraint.html#astroplan.AtNightConstraint" title="astroplan.AtNightConstraint"><code class="xref py py-obj docutils literal"><span class="pre">AtNightConstraint</span></code></a>([max_solar_altitude, …])</td>
<td>Constrain the Sun to be below <code class="docutils literal"><span class="pre">horizon</span></code>.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="api/astroplan.Constraint.html#astroplan.Constraint" title="astroplan.Constraint"><code class="xref py py-obj docutils literal"><span class="pre">Constraint</span></code></a></td>
<td>Abstract class for objects defining observational constraints.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="api/astroplan.EclipsingSystem.html#astroplan.EclipsingSystem" title="astroplan.EclipsingSystem"><code class="xref py py-obj docutils literal"><span class="pre">EclipsingSystem</span></code></a>(primary_eclipse_time, …[, …])</td>
<td>Define parameters for an eclipsing system; useful for an eclipsing binary or transiting exoplanet.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="api/astroplan.FixedTarget.html#astroplan.FixedTarget" title="astroplan.FixedTarget"><code class="xref py py-obj docutils literal"><span class="pre">FixedTarget</span></code></a>(coord[, name])</td>
<td>Coordinates and metadata for an object that is “fixed” with respect to the celestial sphere.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="api/astroplan.LocalTimeConstraint.html#astroplan.LocalTimeConstraint" title="astroplan.LocalTimeConstraint"><code class="xref py py-obj docutils literal"><span class="pre">LocalTimeConstraint</span></code></a>([min, max])</td>
<td>Constrain the observable hours.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="api/astroplan.MoonIlluminationConstraint.html#astroplan.MoonIlluminationConstraint" title="astroplan.MoonIlluminationConstraint"><code class="xref py py-obj docutils literal"><span class="pre">MoonIlluminationConstraint</span></code></a>([min, max, ephemeris])</td>
<td>Constrain the fractional illumination of the Earth’s moon.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="api/astroplan.MoonSeparationConstraint.html#astroplan.MoonSeparationConstraint" title="astroplan.MoonSeparationConstraint"><code class="xref py py-obj docutils literal"><span class="pre">MoonSeparationConstraint</span></code></a>([min, max, ephemeris])</td>
<td>Constrain the distance between the Earth’s moon and some targets.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="api/astroplan.NonFixedTarget.html#astroplan.NonFixedTarget" title="astroplan.NonFixedTarget"><code class="xref py py-obj docutils literal"><span class="pre">NonFixedTarget</span></code></a>([name, ra, dec, marker])</td>
<td>Placeholder for future function.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="api/astroplan.Observer.html#astroplan.Observer" title="astroplan.Observer"><code class="xref py py-obj docutils literal"><span class="pre">Observer</span></code></a>([location, timezone, name, …])</td>
<td>A container class for information about an observer’s location and environment.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="api/astroplan.ObservingBlock.html#astroplan.ObservingBlock" title="astroplan.ObservingBlock"><code class="xref py py-obj docutils literal"><span class="pre">ObservingBlock</span></code></a>(target, duration, priority[, …])</td>
<td>An observation to be scheduled, consisting of a target and associated constraints on observations.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="api/astroplan.OldEarthOrientationDataWarning.html#astroplan.OldEarthOrientationDataWarning" title="astroplan.OldEarthOrientationDataWarning"><code class="xref py py-obj docutils literal"><span class="pre">OldEarthOrientationDataWarning</span></code></a></td>
<td>Using old Earth rotation data from IERS</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="api/astroplan.PeriodicEvent.html#astroplan.PeriodicEvent" title="astroplan.PeriodicEvent"><code class="xref py py-obj docutils literal"><span class="pre">PeriodicEvent</span></code></a>(epoch, period[, duration, name])</td>
<td>A periodic event defined by an epoch and period.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="api/astroplan.PhaseConstraint.html#astroplan.PhaseConstraint" title="astroplan.PhaseConstraint"><code class="xref py py-obj docutils literal"><span class="pre">PhaseConstraint</span></code></a>(periodic_event[, min, max])</td>
<td>Constrain observations to times in some range of phases for a periodic event (e.g.~transiting exoplanets, eclipsing binaries).</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="api/astroplan.PlotBelowHorizonWarning.html#astroplan.PlotBelowHorizonWarning" title="astroplan.PlotBelowHorizonWarning"><code class="xref py py-obj docutils literal"><span class="pre">PlotBelowHorizonWarning</span></code></a></td>
<td>Warning for when something is hidden on a plot because it’s below the horizon</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="api/astroplan.PlotWarning.html#astroplan.PlotWarning" title="astroplan.PlotWarning"><code class="xref py py-obj docutils literal"><span class="pre">PlotWarning</span></code></a></td>
<td>Warnings dealing with the plotting aspects of astroplan</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="api/astroplan.PrimaryEclipseConstraint.html#astroplan.PrimaryEclipseConstraint" title="astroplan.PrimaryEclipseConstraint"><code class="xref py py-obj docutils literal"><span class="pre">PrimaryEclipseConstraint</span></code></a>(eclipsing_system)</td>
<td>Constrain observations to times during primary eclipse.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="api/astroplan.PriorityScheduler.html#astroplan.PriorityScheduler" title="astroplan.PriorityScheduler"><code class="xref py py-obj docutils literal"><span class="pre">PriorityScheduler</span></code></a>(*args, **kwargs)</td>
<td>A scheduler that optimizes a prioritized list.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="api/astroplan.Schedule.html#astroplan.Schedule" title="astroplan.Schedule"><code class="xref py py-obj docutils literal"><span class="pre">Schedule</span></code></a>(start_time, end_time[, constraints])</td>
<td>An object that represents a schedule, consisting of a list of <a class="reference internal" href="api/astroplan.Slot.html#astroplan.Slot" title="astroplan.scheduling.Slot"><code class="xref py py-obj docutils literal"><span class="pre">Slot</span></code></a> objects.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="api/astroplan.Scheduler.html#astroplan.Scheduler" title="astroplan.Scheduler"><code class="xref py py-obj docutils literal"><span class="pre">Scheduler</span></code></a>(constraints, observer[, …])</td>
<td>Schedule a set of <a class="reference internal" href="api/astroplan.ObservingBlock.html#astroplan.ObservingBlock" title="astroplan.scheduling.ObservingBlock"><code class="xref py py-obj docutils literal"><span class="pre">ObservingBlock</span></code></a> objects</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="api/astroplan.Scorer.html#astroplan.Scorer" title="astroplan.Scorer"><code class="xref py py-obj docutils literal"><span class="pre">Scorer</span></code></a>(blocks, observer, schedule[, …])</td>
<td>Returns scores and score arrays from the evaluation of constraints on</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="api/astroplan.SecondaryEclipseConstraint.html#astroplan.SecondaryEclipseConstraint" title="astroplan.SecondaryEclipseConstraint"><code class="xref py py-obj docutils literal"><span class="pre">SecondaryEclipseConstraint</span></code></a>(eclipsing_system)</td>
<td>Constrain observations to times during secondary eclipse.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="api/astroplan.SequentialScheduler.html#astroplan.SequentialScheduler" title="astroplan.SequentialScheduler"><code class="xref py py-obj docutils literal"><span class="pre">SequentialScheduler</span></code></a>(*args, **kwargs)</td>
<td>A scheduler that does “stupid simple sequential scheduling”.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="api/astroplan.Slot.html#astroplan.Slot" title="astroplan.Slot"><code class="xref py py-obj docutils literal"><span class="pre">Slot</span></code></a>(start_time, end_time)</td>
<td>A time slot consisting of a start and end time</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="api/astroplan.SunSeparationConstraint.html#astroplan.SunSeparationConstraint" title="astroplan.SunSeparationConstraint"><code class="xref py py-obj docutils literal"><span class="pre">SunSeparationConstraint</span></code></a>([min, max])</td>
<td>Constrain the distance between the Sun and some targets.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="api/astroplan.Target.html#astroplan.Target" title="astroplan.Target"><code class="xref py py-obj docutils literal"><span class="pre">Target</span></code></a>([name, ra, dec, marker])</td>
<td>Abstract base class for target objects.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="api/astroplan.TargetAlwaysUpWarning.html#astroplan.TargetAlwaysUpWarning" title="astroplan.TargetAlwaysUpWarning"><code class="xref py py-obj docutils literal"><span class="pre">TargetAlwaysUpWarning</span></code></a></td>
<td>Target is circumpolar</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="api/astroplan.TargetNeverUpWarning.html#astroplan.TargetNeverUpWarning" title="astroplan.TargetNeverUpWarning"><code class="xref py py-obj docutils literal"><span class="pre">TargetNeverUpWarning</span></code></a></td>
<td>Target never rises above horizon</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="api/astroplan.TimeConstraint.html#astroplan.TimeConstraint" title="astroplan.TimeConstraint"><code class="xref py py-obj docutils literal"><span class="pre">TimeConstraint</span></code></a>([min, max])</td>
<td>Constrain the observing time to be within certain time limits.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="api/astroplan.TransitionBlock.html#astroplan.TransitionBlock" title="astroplan.TransitionBlock"><code class="xref py py-obj docutils literal"><span class="pre">TransitionBlock</span></code></a>(components[, start_time])</td>
<td>Parameterizes the “dead time”, e.g.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="api/astroplan.Transitioner.html#astroplan.Transitioner" title="astroplan.Transitioner"><code class="xref py py-obj docutils literal"><span class="pre">Transitioner</span></code></a>([slew_rate, …])</td>
<td>A class that defines how to compute transition times from one block to another.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="class-inheritance-diagram">
<h3>Class Inheritance Diagram<a class="headerlink" href="#class-inheritance-diagram" title="Permalink to this headline">¶</a></h3>
digraph inheritance848c7d1aac {
rankdir=LR;
size="8.0, 12.0";
"AirmassConstraint" [URL="../api/astroplan.AirmassConstraint.html#astroplan.AirmassConstraint",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Constrain the airmass of a target."];
"AltitudeConstraint" -> "AirmassConstraint" [arrowsize=0.5,style="setlinewidth(0.5)"];
"AltitudeConstraint" [URL="../api/astroplan.AltitudeConstraint.html#astroplan.AltitudeConstraint",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Constrain the altitude of the target."];
"Constraint" -> "AltitudeConstraint" [arrowsize=0.5,style="setlinewidth(0.5)"];
"AstroplanWarning" [URL="../api/astroplan.AstroplanWarning.html#astroplan.AstroplanWarning",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Superclass for warnings used by astroplan"];
"AstropyWarning" -> "AstroplanWarning" [arrowsize=0.5,style="setlinewidth(0.5)"];
"AstropyWarning" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",tooltip="The base warning class from which all Astropy warnings should inherit."];
"AtNightConstraint" [URL="../api/astroplan.AtNightConstraint.html#astroplan.AtNightConstraint",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Constrain the Sun to be below ``horizon``."];
"Constraint" -> "AtNightConstraint" [arrowsize=0.5,style="setlinewidth(0.5)"];
"Constraint" [URL="../api/astroplan.Constraint.html#astroplan.Constraint",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Abstract class for objects defining observational constraints."];
"EclipsingSystem" [URL="../api/astroplan.EclipsingSystem.html#astroplan.EclipsingSystem",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Define parameters for an eclipsing system; useful for an eclipsing binary or"];
"PeriodicEvent" -> "EclipsingSystem" [arrowsize=0.5,style="setlinewidth(0.5)"];
"FixedTarget" [URL="../api/astroplan.FixedTarget.html#astroplan.FixedTarget",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Coordinates and metadata for an object that is \"fixed\" with respect to the"];
"Target" -> "FixedTarget" [arrowsize=0.5,style="setlinewidth(0.5)"];
"LocalTimeConstraint" [URL="../api/astroplan.LocalTimeConstraint.html#astroplan.LocalTimeConstraint",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Constrain the observable hours."];
"Constraint" -> "LocalTimeConstraint" [arrowsize=0.5,style="setlinewidth(0.5)"];
"MoonIlluminationConstraint" [URL="../api/astroplan.MoonIlluminationConstraint.html#astroplan.MoonIlluminationConstraint",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Constrain the fractional illumination of the Earth's moon."];
"Constraint" -> "MoonIlluminationConstraint" [arrowsize=0.5,style="setlinewidth(0.5)"];
"MoonSeparationConstraint" [URL="../api/astroplan.MoonSeparationConstraint.html#astroplan.MoonSeparationConstraint",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Constrain the distance between the Earth's moon and some targets."];
"Constraint" -> "MoonSeparationConstraint" [arrowsize=0.5,style="setlinewidth(0.5)"];
"NonFixedTarget" [URL="../api/astroplan.NonFixedTarget.html#astroplan.NonFixedTarget",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Placeholder for future function."];
"Target" -> "NonFixedTarget" [arrowsize=0.5,style="setlinewidth(0.5)"];
"Observer" [URL="../api/astroplan.Observer.html#astroplan.Observer",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="A container class for information about an observer's location and"];
"ObservingBlock" [URL="../api/astroplan.ObservingBlock.html#astroplan.ObservingBlock",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="An observation to be scheduled, consisting of a target and associated"];
"OldEarthOrientationDataWarning" [URL="../api/astroplan.OldEarthOrientationDataWarning.html#astroplan.OldEarthOrientationDataWarning",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Using old Earth rotation data from IERS"];
"AstroplanWarning" -> "OldEarthOrientationDataWarning" [arrowsize=0.5,style="setlinewidth(0.5)"];
"PeriodicEvent" [URL="../api/astroplan.PeriodicEvent.html#astroplan.PeriodicEvent",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="A periodic event defined by an epoch and period."];
"PhaseConstraint" [URL="../api/astroplan.PhaseConstraint.html#astroplan.PhaseConstraint",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Constrain observations to times in some range of phases for a periodic event"];
"Constraint" -> "PhaseConstraint" [arrowsize=0.5,style="setlinewidth(0.5)"];
"PlotBelowHorizonWarning" [URL="../api/astroplan.PlotBelowHorizonWarning.html#astroplan.PlotBelowHorizonWarning",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Warning for when something is hidden on a plot because it's below the horizon"];
"PlotWarning" -> "PlotBelowHorizonWarning" [arrowsize=0.5,style="setlinewidth(0.5)"];
"PlotWarning" [URL="../api/astroplan.PlotWarning.html#astroplan.PlotWarning",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Warnings dealing with the plotting aspects of astroplan"];
"AstroplanWarning" -> "PlotWarning" [arrowsize=0.5,style="setlinewidth(0.5)"];
"PrimaryEclipseConstraint" [URL="../api/astroplan.PrimaryEclipseConstraint.html#astroplan.PrimaryEclipseConstraint",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Constrain observations to times during primary eclipse."];
"Constraint" -> "PrimaryEclipseConstraint" [arrowsize=0.5,style="setlinewidth(0.5)"];
"PriorityScheduler" [URL="../api/astroplan.PriorityScheduler.html#astroplan.PriorityScheduler",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="A scheduler that optimizes a prioritized list. That is, it"];
"Scheduler" -> "PriorityScheduler" [arrowsize=0.5,style="setlinewidth(0.5)"];
"Schedule" [URL="../api/astroplan.Schedule.html#astroplan.Schedule",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="An object that represents a schedule, consisting of a list of"];
"Scheduler" [URL="../api/astroplan.Scheduler.html#astroplan.Scheduler",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Schedule a set of `~astroplan.scheduling.ObservingBlock` objects"];
"Scorer" [URL="../api/astroplan.Scorer.html#astroplan.Scorer",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Returns scores and score arrays from the evaluation of constraints on"];
"SecondaryEclipseConstraint" [URL="../api/astroplan.SecondaryEclipseConstraint.html#astroplan.SecondaryEclipseConstraint",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Constrain observations to times during secondary eclipse."];
"Constraint" -> "SecondaryEclipseConstraint" [arrowsize=0.5,style="setlinewidth(0.5)"];
"SequentialScheduler" [URL="../api/astroplan.SequentialScheduler.html#astroplan.SequentialScheduler",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="A scheduler that does \"stupid simple sequential scheduling\". That is, it"];
"Scheduler" -> "SequentialScheduler" [arrowsize=0.5,style="setlinewidth(0.5)"];
"Slot" [URL="../api/astroplan.Slot.html#astroplan.Slot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="A time slot consisting of a start and end time"];
"SunSeparationConstraint" [URL="../api/astroplan.SunSeparationConstraint.html#astroplan.SunSeparationConstraint",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Constrain the distance between the Sun and some targets."];
"Constraint" -> "SunSeparationConstraint" [arrowsize=0.5,style="setlinewidth(0.5)"];
"Target" [URL="../api/astroplan.Target.html#astroplan.Target",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Abstract base class for target objects."];
"TargetAlwaysUpWarning" [URL="../api/astroplan.TargetAlwaysUpWarning.html#astroplan.TargetAlwaysUpWarning",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Target is circumpolar"];
"AstroplanWarning" -> "TargetAlwaysUpWarning" [arrowsize=0.5,style="setlinewidth(0.5)"];
"TargetNeverUpWarning" [URL="../api/astroplan.TargetNeverUpWarning.html#astroplan.TargetNeverUpWarning",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Target never rises above horizon"];
"AstroplanWarning" -> "TargetNeverUpWarning" [arrowsize=0.5,style="setlinewidth(0.5)"];
"TimeConstraint" [URL="../api/astroplan.TimeConstraint.html#astroplan.TimeConstraint",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Constrain the observing time to be within certain time limits."];
"Constraint" -> "TimeConstraint" [arrowsize=0.5,style="setlinewidth(0.5)"];
"TransitionBlock" [URL="../api/astroplan.TransitionBlock.html#astroplan.TransitionBlock",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Parameterizes the \"dead time\", e.g. between observations, while the"];
"Transitioner" [URL="../api/astroplan.Transitioner.html#astroplan.Transitioner",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="A class that defines how to compute transition times from one block to"];
}
</div>
</div>
<div class="section" id="module-astroplan.plots">
<span id="astroplan-plots-package"></span><h2>astroplan.plots Package<a class="headerlink" href="#module-astroplan.plots" title="Permalink to this headline">¶</a></h2>
<p><a class="reference internal" href="#module-astroplan.plots" title="astroplan.plots"><code class="xref py py-obj docutils literal"><span class="pre">astroplan.plots</span></code></a> contains functions for making plots of commonly-used
quantities in observation planning (e.g., airmass vs. time), using <a class="reference internal" href="#module-astroplan" title="astroplan"><code class="xref py py-obj docutils literal"><span class="pre">astroplan</span></code></a>
and <a class="reference external" href="http://www.matplotlib.org">Matplotlib</a>.</p>
<div class="section" id="id1">
<h3>Functions<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="api/astroplan.plots.plot_airmass.html#astroplan.plots.plot_airmass" title="astroplan.plots.plot_airmass"><code class="xref py py-obj docutils literal"><span class="pre">plot_airmass</span></code></a>(targets, observer, time[, ax, …])</td>
<td>Plots airmass as a function of time for a given target.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="api/astroplan.plots.plot_finder_image.html#astroplan.plots.plot_finder_image" title="astroplan.plots.plot_finder_image"><code class="xref py py-obj docutils literal"><span class="pre">plot_finder_image</span></code></a>(target[, survey, …])</td>
<td>Plot survey image centered on <code class="docutils literal"><span class="pre">target</span></code>.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="api/astroplan.plots.plot_parallactic.html#astroplan.plots.plot_parallactic" title="astroplan.plots.plot_parallactic"><code class="xref py py-obj docutils literal"><span class="pre">plot_parallactic</span></code></a>(target, observer, time[, …])</td>
<td>Plots parallactic angle as a function of time for a given target.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="api/astroplan.plots.plot_schedule_airmass.html#astroplan.plots.plot_schedule_airmass" title="astroplan.plots.plot_schedule_airmass"><code class="xref py py-obj docutils literal"><span class="pre">plot_schedule_airmass</span></code></a>(schedule[, show_night])</td>
<td>Plots when observations of targets are scheduled to occur superimposed upon plots of the airmasses of the targets.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="api/astroplan.plots.plot_sky.html#astroplan.plots.plot_sky" title="astroplan.plots.plot_sky"><code class="xref py py-obj docutils literal"><span class="pre">plot_sky</span></code></a>(target, observer, time[, ax, …])</td>
<td>Plots target positions in the sky with respect to the observer’s location.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="api/astroplan.plots.plot_sky_24hr.html#astroplan.plots.plot_sky_24hr" title="astroplan.plots.plot_sky_24hr"><code class="xref py py-obj docutils literal"><span class="pre">plot_sky_24hr</span></code></a>(target, observer, time[, …])</td>
<td>Plots target positions in the sky with respect to the observer’s location over a twenty-four hour period centered on <code class="docutils literal"><span class="pre">time</span></code>.</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><h3>Page Contents</h3>
<ul>
<li><a class="reference internal" href="#">Reference/API</a><ul>
<li><a class="reference internal" href="#module-astroplan">astroplan Package</a><ul>
<li><a class="reference internal" href="#functions">Functions</a></li>
<li><a class="reference internal" href="#classes">Classes</a></li>
<li><a class="reference internal" href="#class-inheritance-diagram">Class Inheritance Diagram</a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-astroplan.plots">astroplan.plots Package</a><ul>
<li><a class="reference internal" href="#id1">Functions</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<footer class="footer">
<p class="pull-right">
<a href="_sources/api.rst.txt"
rel="nofollow">Page Source</a>
<a href="#">Back to Top</a></p>
<p>
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.6.6.
Last built January 31, 2018. <br/>
</p>
</footer>
</body>
</html>
|