root/MGET/Branches/Jason/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.SpatialAnalysis.Astronomy.Moon.CalculateMoonPhaseForUpdateCursor.html @ 980

Revision 980, 10.3 KB (checked in by jjr8, 13 months ago)

Rebuilt installation packages. This will be merged with the Trunk and released as MGET 0.8a40.
Line 
1<?xml version="1.0" encoding="utf-8"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>CalculateMoonPhaseForUpdateCursor Method</title><link rel="stylesheet" type="text/css" href="lib.css?format=raw" /><style xml:space="preserve">
4            td.metadataTitle { font-size: 80%; font-weight: bold; font-family: avantgarde, sans-serif; }
5            td.metadataValue { padding-left: 0.5em; }
6          </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="CalculateMoonPhaseForArcGISTable Method" href="Method_GeoEco.SpatialAnalysis.Astronomy.Moon.CalculateMoonPhaseForArcGISTable.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="Moon Class" href="Class_GeoEco.SpatialAnalysis.Astronomy.Moon.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="GeoEco.SpatialAnalysis.Diversity Module" href="Module_GeoEco.SpatialAnalysis.Diversity.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.SpatialAnalysis.Astronomy.Moon.CalculateMoonPhaseForArcGISTable.html?format=raw">CalculateMoonPhaseForArcGISTable Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.SpatialAnalysis.Astronomy.Moon.html?format=raw">Moon Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Module_GeoEco.SpatialAnalysis.Diversity.html?format=raw">GeoEco.SpatialAnalysis.Diversity Module</a> </div><hr /></div></div><h1><tt class="member">CalculateMoonPhaseForUpdateCursor</tt> Method</h1><p>Updates all the rows of an update cursor with the specified moon phase property.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.SpatialAnalysis.Astronomy.Moon.html?format=raw">Moon</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue">Recommended for external callers</td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Not exposed by a COM class</td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Not exposed as an ArcGIS geoprocessing tool</td></tr><tr valign="baseline"><td class="metadataTitle">Method type:</td><td class="metadataValue">Classmethod</td></tr></table><h3>Usage</h3><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><tt class="method">Moon.CalculateMoonPhaseForUpdateCursor</tt></b>(</td><td><var>phaseProperty</var><var>, cursor</var><var>, dateField</var><var>, phaseField</var>)</td></tr></table><h3>Arguments</h3><dl><dt><var>phaseProperty</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Allowed values:</td><td class="metadataValue"><code>u'Phase'</code>, <code>u'PhaseName'</code>, <code>u'Illuminated'</code>, <code>u'Age'</code>, <code>u'MoonDistance'</code>, <code>u'SunDistance'</code>, <code>u'MoonAngularDiameter'</code>, <code>u'SunAngularDiameter'</code>, <code>u'NewMoonDate'</code>, <code>u'FirstQuarterDate'</code>, <code>u'FullMoonDate'</code>, <code>u'ThirdQuarterDate'</code>, <code>u'NextNewMoonDate'</code></td></tr></table><p>Moon phase property to calculate from the date field. One of:</p><ul><li>Phase - Numeric phase of the moon ranging from 0 to 0.999999, where
70 is new moon, 0.25 is first quarter, 0.5 is full, and 0.75 is third
8quarter.</li><li>PhaseName - Name of the moon phase: new, waxing crescent, first
9quarter, waxing gibbous, full, waning gibbous, last quarter, or
10waning crescent.</li><li>Illuminated - Fraction of the moon that is illuminated, ranging from
110 (new moon) to 1 (full moon).</li><li>Age - Number of days since the new moon, ranging from 0 to the lunar
12synodic period, approximately 29.53 days.</li><li>MoonDistance - Approximate distance, in km, from the center of the
13Earth to the moon.</li><li>SunDistance - Approximate distance, in km, from the center of the
14Earth to the sun.</li><li>MoonAngularDiameter - Approximate angular diameter, in degrees, of
15the moon as seen from the surface of the Earth.</li><li>SunAngularDiameter - Approximate angular diameter, in degrees, of
16the sun as seen from the surface of the Earth.</li><li>NewMoonDate - Approximate date and time, in UTC, of the new moon in
17the lunar cycle containing the focal date. This date will always be
18on or after the focal date.</li><li>FirstQuarterDate - Approximate date and time, in UTC, of the first
19quarter in the lunar cycle containing the focal date. This may be
20before, on, or after the focal date, depending on where the focal
21date falls in the lunar cycle.</li><li>FullMoonDate - Approximate date and time, in UTC, of the full moon
22in the lunar cycle containing the focal date. This may be before,
23on, or after the focal date, depending on where the focal date falls
24in the lunar cycle.</li><li>ThirdQuarterDate - Approximate date and time, in UTC, of the third
25quarter in the lunar cycle containing the focal date. This may be
26before, on, or after the focal date, depending on where the focal
27date falls in the lunar cycle.</li><li>NextNewMoonDate - Approximate date and time, in UTC, of the new moon
28that follows the focal date. This date will always be after the
29focal date.</li></ul></dd></dl><dl><dt><var>cursor</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">GeoEco.Datasets.UpdateCursor</tt></td></tr></table><p>Update cursor opened to the rows to update.</p></dd></dl><dl><dt><var>dateField</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>Field that specifies the date and optionally the time for which
30the moon phase should be calculated, in the UTC time zone. If a time
31is not included in the date, it is assumed to be 00:00:00.</p></dd></dl><dl><dt><var>phaseField</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>Field should receive the moon phase property calculated from the
32date.</p><p>The data type of this field must be appropriate for the property that
33was requested. For the Phase, Illuminated, Age, MoonDistance,
34SunDistance, MoonAngularDiameter, and SunAngularDiameter properties, a
35floating-point field must be used. For PhaseName, a string or text
36field must be used. For NewMoonDate, FirstQuarterDate, FullMoonDate,
37ThirdQuarterDate, NextNewMoonDate, a date field must be used.</p></dd></dl><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="CalculateMoonPhaseForArcGISTable Method" href="Method_GeoEco.SpatialAnalysis.Astronomy.Moon.CalculateMoonPhaseForArcGISTable.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="Moon Class" href="Class_GeoEco.SpatialAnalysis.Astronomy.Moon.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="GeoEco.SpatialAnalysis.Diversity Module" href="Module_GeoEco.SpatialAnalysis.Diversity.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.SpatialAnalysis.Astronomy.Moon.CalculateMoonPhaseForArcGISTable.html?format=raw">CalculateMoonPhaseForArcGISTable Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.SpatialAnalysis.Astronomy.Moon.html?format=raw">Moon Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Module_GeoEco.SpatialAnalysis.Diversity.html?format=raw">GeoEco.SpatialAnalysis.Diversity Module</a> </div><hr /><span class="release-info">Marine Geospatial Ecology Tools version 0.8</span></div></div></body></html>
Note: See TracBrowser for help on using the browser.