root/MGET/Trunk/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.DataProducts.HYCOM.HYCOMGOMl0043D.CreateClimatologicalArcGISRasters.html @ 919

Revision 919, 35.7 KB (checked in by jjr8, 15 months ago)

Merged [903-918] from Jason branch into the Trunk. This will be released as MGET 0.8a33.
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>CreateClimatologicalArcGISRasters 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="CreateArcGISRasters Method" href="Method_GeoEco.DataProducts.HYCOM.HYCOMGOMl0043D.CreateArcGISRasters.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="HYCOMGOMl0043D Class" href="Class_GeoEco.DataProducts.HYCOM.HYCOMGOMl0043D.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="InterpolateAtArcGISPoints Method" href="Method_GeoEco.DataProducts.HYCOM.HYCOMGOMl0043D.InterpolateAtArcGISPoints.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.DataProducts.HYCOM.HYCOMGOMl0043D.CreateArcGISRasters.html?format=raw">CreateArcGISRasters Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataProducts.HYCOM.HYCOMGOMl0043D.html?format=raw">HYCOMGOMl0043D Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DataProducts.HYCOM.HYCOMGOMl0043D.InterpolateAtArcGISPoints.html?format=raw">InterpolateAtArcGISPoints Method</a> </div><hr /></div></div><h1><tt class="member">CreateClimatologicalArcGISRasters</tt> Method</h1><p>Creates climatological rasters for a HYCOM GOMl0.04 3D variable</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DataProducts.HYCOM.HYCOMGOMl0043D.html?format=raw">HYCOMGOMl0043D</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">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Method_GeoEco.HYCOMGOMl0043D.CreateClimatologicalArcGISRasters.html?format=raw">CreateClimatologicalArcGISRasters</a> method of COM class <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Class_GeoEco.HYCOMGOMl0043D.html?format=raw">GeoEco.HYCOMGOMl0043D</a></td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../ArcGISReference/HYCOMGOMl0043D.CreateClimatologicalArcGISRasters.html?format=raw">Create Climatological Rasters for HYCOM GOMl0.04 3D Variable</a> 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;"><var>updatedOutputWorkspace</var> = <b><tt class="method">HYCOMGOMl0043D.CreateClimatologicalArcGISRasters</tt></b>(</td><td><var>variableName</var><var>, statistic</var><var>, binType</var><var>, outputWorkspace</var><big>[</big><var>, mode</var><big>[</big><var>, rasterNameExpressions</var><big>[</big><var>, binDuration</var><big>[</big><var>, startDayOfYear</var><big>[</big><var>, spatialExtent</var><big>[</big><var>, linearUnit</var><big>[</big><var>, startDate</var><big>[</big><var>, endDate</var><big>[</big><var>, timeout</var><big>[</big><var>, maxRetryTime</var><big>[</big><var>, cacheDirectory</var><big>[</big><var>, calculateStatistics</var><big>[</big><var>, buildPyramids</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table><h3>Arguments</h3><dl><dt><var>variableName</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'emp'</code>, <code>u'mld'</code>, <code>u'mlp'</code>, <code>u'qtot'</code>, <code>u'ssh'</code>, <code>u'surface_salinity_trend'</code>, <code>u'surface_temperature_trend'</code></td></tr></table><p>HYCOM 3D variable (dimensions x, y, and time), one of:</p><ul><li>emp - Water flux into the ocean, in kg/m2/s.</li><li>mld - Mixed layer thickness, in m, defined as the depth at which the
7temperature change from the surface temperature is 0.02 degrees C.</li><li>mlp - Mixed layer thickness, in m, defined as the depth at which the
8pressure change from the surface pressure is 0.03 kg/m3.</li><li>qtot - Surface downward heat flux, in w/m2.</li><li>ssh - Sea surface height, in m, above the HYCOM reference spheroid.</li><li>surface_salinity_trend - Surface salinity trend, in psu/day.</li><li>surface_temperature_trend - Surface temperature trend, in degrees
9C/day.</li></ul><p>Please see the HYCOM documentation for more information about these
10variables.</p></dd></dl><dl><dt><var>statistic</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'Count'</code>, <code>u'Maximum'</code>, <code>u'Mean'</code>, <code>u'Minimum'</code>, <code>u'Range'</code>, <code>u'Standard Deviation'</code>, <code>u'Sum'</code></td></tr></table><p>Statistic to calculate for each cell, one of:</p><ul><li>Count - number of images in which the cell had data.</li><li>Maximum - maximum value for the cell.</li><li>Mean - mean value for the cell, calculated as the sum divided by the
11count.</li><li>Minimum - minimum value for the cell.</li><li>Range - range for the cell, calculated as the maximum minus the
12minimum.</li><li>Standard Deviation - sample standard deviation for the cell
13(i.e. the standard deviation estimated using Bessel's correction).
14In order to calculate this, there must be at least two images with
15data for the cell.</li><li>Sum - the sum for the cell.</li></ul></dd></dl><dl><dt><var>binType</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'Daily'</code>, <code>u'Monthly'</code>, <code>u'Cumulative'</code></td></tr></table><p>Climatology bins to use, one of:</p><ul><li>Daily - daily bins. Images will be classified into bins according to
16their days of the year. The number of days in each bin is determined
17by the Climatology Bin Duration parameter (which defaults to 1). The
18number of bins is calculated by dividing 365 by the bin duration. If
19there is no remainder, then that number of bins will be created;
20images for the 366th day of leap years will be counted in the bin
21that includes day 365. For example, if the bin duration is 5, 73
22bins will be created. The first will be for days 1-5, the second
23will be for days 5-10, and so on; the 73rd bin will be for days
24361-365 during normal years and 361-366 during leap years. If
25dividing 365 by the bin duration does yield a remainder, then one
26additional bin will be created to hold the remaining days. For
27example, if the bin duration is 8, 46 bins will be created. The
28first will be for days 1-8, the second for days 9-16, and so on; the
2946th will be for days 361-365 during normal years and 361-366 during
30leap years.</li><li>Monthly - monthly bins. Images will be classified into bins according to
31their months of the year. The number of months in each bin is
32determined by the Climatology Bin Duration parameter (which defaults
33to 1). The number of bins is calculated by dividing 12 by the bin
34duration. If there is no remainder, then that number of bins will be
35created. For example, if the bin duration is 3, there will be four
36bins: January-March, April-June, July-September, and
37October-December. If there is a remainder, then one additional bin
38will be created. For example, if the bin duration is 5, 3 bins will
39be created: January-May, June-October, November-December.</li><li>Cumulative - one bin. A single climatology raster will be calculated
40from the entire dataset. The Bin Duration parameter is ignored.</li></ul><p>For Daily and Monthly, to adjust when the bins start (e.g. to center a
414-bin seasonal climatology on solstices and equinoxes), use the Start
42Climatology At This Day Of The Year parameter.</p></dd></dl><dl><dt><var>outputWorkspace</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><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">No</td></tr></table><p>Directory or geodatabase to receive the rasters.</p><p>Unless you have a specific reason to store the rasters in a
43geodatabase, we recommend you store them in a directory because it
44will be much faster and allows the rasters to be organized in a tree.
45If you do store the rasters in a geodatabase, you must change the
46Raster Name Expressions parameter; see below for more
47information.</p></dd></dl><dl><dt><var>mode</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">Default value:</td><td class="metadataValue"><code>u'add'</code></td></tr><tr valign="baseline"><td class="metadataTitle">Allowed values:</td><td class="metadataValue"><code>u'Add'</code>, <code>u'Replace'</code></td></tr></table><p>Overwrite mode, one of:</p><ul><li>Add - create rasters that do not exist and skip those that already
48exist. This is the default.</li><li>Replace - create rasters that do not exist and overwrite those that
49already exist. Choose this option when you want to regenerate the
50climatologies using the latest HYCOM images.</li></ul><p>The ArcGIS Overwrite Outputs geoprocessing setting has no effect on
51this tool. If 'Replace' is selected the rasters will be overwritten,
52regardless of the ArcGIS Overwrite Outputs setting.</p></dd></dl><dl><dt><var>rasterNameExpressions</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">list</tt> of <tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>[</code><code>u'%(VariableName)s'</code><code>, </code><code>u'%(ClimatologyBinType)s_Climatology'</code><code>, </code><code>u'%(VariableName)s_%(ClimatologyBinName)s_%(Statistic)s.img'</code><code>]</code></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>List of expressions specifying how the output rasters should be
53named.</p><p>The default expression assumes you are storing rasters in a file
54system directory and creates them in a tree structure with levels for
55variable and climatology bin type. When storing rasters in a
56directory, the final expression specifies the file name of the raster
57and any preceding expressions specify subdirectories. The extension of
58the final expression determines the output raster format: .asc for
59ArcInfo ASCII Grid, .bmp for BMP, .gif for GIF, .img for an ERDAS
60IMAGINE file, .jpg for JPEG, .jp2 for JPEG 2000, .png for PNG, .tif
61for GeoTIFF, or no extension for ArcInfo Binary Grid. The default
62expression uses .img.</p><p>When storing rasters in a geodatabase, you should provide only one
63expression. That expression specifies the raster's name.</p><p>Each expression may contain any sequence of characters permitted by
64the output workspace. Each expression may optionally contain one or
65more of the following case-sensitive codes. The tool replaces the
66codes with appropriate values when creating each raster:</p><ul><li>%(VariableName)s - HYCOM variable represented in the output raster.</li><li>%(ClimatologyBinType)s - type of the climatology bin, either "Daily"
67if 1-day bins, "Xday" if multi-day bins (X is replaced by the
68duration), "Monthly" if 1-month bins, "Xmonth" if multi-month bins,
69or "Cumulative".</li><li>%(ClimatologyBinName)s - name of the climatology bin corresponding
70represented by the output raster, either "dayXXX" for 1-day bins
71(XXX is replaced by the day of the year), "daysXXXtoYYY" for
72multi-day bins (XXX is replaced by the first day of the bin, YYY is
73replaced by the last day), "monthXX" for 1-month bins (XX is
74replaced by the month), "monthXXtoYY" (XX is replaced by the first
75month of the bin, YY by the last month), or "cumulative".</li><li>%(Statistic)s - statistic that was calculated, in lowercase and with
76spaces replaced by underscores; one of: "count", "maximum", "mean",
77"minimum", "range", "standard_deviation", "Sum".</li></ul><p>If the Bin Type is "Daily", the following additional codes are
78available:</p><ul><li>%(FirstDay)i - first day of the year of the climatology bin
79represented by the output raster.</li><li>%(LastDay)i - last day of the year of the climatology bin
80represented by the output raster. For 1-day climatologies, this will
81be the same as %(FirstDay)i.</li></ul><p>If the Bin Type is "Monthly", the following additional codes are
82available:</p><ul><li>%(FirstMonth)i - first month of the climatology bin represented by
83the output raster.</li><li>%(DayOfFirstMonth)i - first day of the first month of the
84climatology bin represented by the output raster.</li><li>%(LastMonth)i - last month of the climatology bin represented by
85the output raster.</li><li>%(DayOfLastMonth)i - last day of the last month of the climatology
86bin represented by the output raster.</li></ul><p>Note that the additional codes are integers and may be formatted using
87"printf"-style formatting codes. For example, to format the FirstDay
88as a three-digit number with leading zeros:</p><div class="verbatim"><pre xml:space="preserve">%(FirstDay)03i</pre></div></dd></dl><dl><dt><var>binDuration</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">int</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>1</code></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum value:</td><td class="metadataValue"><code>1</code></td></tr></table><p>Duration of each bin, in days or months, when the Bin Type is
89Daily or Monthly, respectively. The default is 1. See the Bin Type
90parameter for more information.</p></dd></dl><dl><dt><var>startDayOfYear</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">int</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>1</code></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum value:</td><td class="metadataValue"><code>1</code></td></tr></table><p>Use this parameter to create bin defintions that deviate from the
91traditional calendar. The interpretation of this parameter depends on
92the Bin Type:</p><ul><li>Daily - this parameter defines the day of the year of the first
93climatology bin. For example, if this parameter is 100 and the Bin
94Duration is 10, the first bin will be numbered 100-109. The bin
95spanning the end of the year will be numbered 360-004. The last bin
96will be numbered 095-099. To define a four-bin climatology with bins
97that are centered approximately on the equinoxes and solstices
98(i.e., a seasonal climatology), set the Bin Duration to 91 and the
99start day to 36 (February 5). This will produce bins with dates
100036-126, 127-217, 218-308, and 309-035.</li><li>Monthly - this parameter defines the day of the year of the first
101climatology bin, and the day of the month of that bin will be used
102as the first day of the month of all of the bins. For example, if
103this parameter is 46, which is February 15, and the Bin Duration is
1041, then the bins will be February 15 - March 14, March 15 - April
10514, April 15 - May 14, and so on. Calculations involving this
106parameter always assume a 365 day year (a non-leap year). To define
107a four-bin climatology using the months traditionally associated
108with spring, summer, fall, and winter in many northern hemisphere
109cultures, set the Bin Duration to 3 and the start day to 60 (March
1101). This will produce bins with months 03-05, 06-08, 09-11, and
11112-02.</li><li>Cumulative - this parameter is ignored.</li></ul></dd></dl><dl><dt><var>spatialExtent</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> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Must match regular expression:</td><td class="metadataValue"><code>([-+]?[0-9]*\.?[0-9]+([eE][-+]?[0-9]+)?)\s+([-+]?[0-9]*\.?[0-9]+([eE][-+]?[0-9]+)?)\s+([-+]?[0-9]*\.?[0-9]+([eE][-+]?[0-9]+)?)\s+([-+]?[0-9]*\.?[0-9]+([eE][-+]?[0-9]+)?)</code></td></tr></table><p>Spatial extent of the outputs, in the units specified by the
112Linear Units parameter.</p><p>If you do not specify a spatial extent, it will default to
113approximately 18 to 32 N, 98 to 76 W. The outputs can only be clipped
114in whole grid cells. The values you provide will be rounded off to the
115closest cell.</p></dd></dl><dl><dt><var>linearUnit</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">Default value:</td><td class="metadataValue"><code>u'Degrees'</code></td></tr><tr valign="baseline"><td class="metadataTitle">Allowed values:</td><td class="metadataValue"><code>u'Degrees'</code>, <code>u'Meters'</code></td></tr></table><p>Specifies the unit of the Spatial Extent parameter, one of:</p><ul><li>Degrees - Decimal degrees.</li><li>Meters - Meters, in the HYCOM coordinate system.</li></ul></dd></dl><dl><dt><var>startDate</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">datetime.datetime</tt> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr></table><p>Start date for the outputs to create.</p><p>Outputs will be created for images that occur on or after the start
116date and on or before the end date. The HYCOM GOMl0.04 dataset
117provides a five-day forecast; its temporal extent ranges from 1
118January 2003 to today's date plus five days. If you do not specify a
119start date, 1 January 2003 will be used.</p><p>The time component of the start date is ignored.</p></dd></dl><dl><dt><var>endDate</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">datetime.datetime</tt> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr></table><p>End date for the outputs to create.</p><p>Outputs will be created for images that occur on or after the start
120date and on or before the end date. The HYCOM GOMl0.04 dataset
121provides a five-day forecast; its temporal extent ranges from 1
122January 2003 to today's date plus five days. If you do not specify an
123end date, the most recent day available will be used (typically
124today's date plus five days).</p><p>The time component of the end date is ignored.</p></dd></dl><dl><dt><var>timeout</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">int</tt> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>600</code></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum value:</td><td class="metadataValue"><code>1</code></td></tr></table><p>Number of seconds to wait for the THREDDS or OPeNDAP server to
125respond before failing with a timeout error.</p><p>If you also provide a Maximum Retry Time and it is larger than the
126timeout value, the failed request will be retried automatically (with
127the same timout value) until it succeeds or the Maximum Retry Time has
128elapsed.</p><p>If you receive a timeout error you should investigate the server to
129determine if it is malfunctioning or just slow. Check the server's
130website to see if the operator has posted a notice about the problem,
131or contact the operator directly. If the server just slow, increase
132the timeout value to a larger number, to give the server more time to
133respond.</p></dd></dl><dl><dt><var>maxRetryTime</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">int</tt> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum value:</td><td class="metadataValue"><code>1</code></td></tr></table><p>Number of seconds to retry requests to the THREDDS or OPeNDAP
134server before giving up.</p><p>Use this parameter to cope with a server that experiences transient
135failures. For example, some servers are rebooted as part of nightly
136maintenance cycles. If you start a long running operation and want it
137to run overnight without failing, set the maximum retry time to a
138duration that is longer than the time that the server is offline
139during the maintenance cycle.</p><p>To maximize performance while minimizing load during failure
140situations, retries are scheduled with progressive delays:</p><ul><li>The first retry is issued immediately.</li><li>Then, so long as fewer than 10 seconds have elapsed since the
141original request was issued, retries are issued every second.</li><li>After that, retries are issued every 30 seconds until the maximum
142retry time is reached or the request succeeds.</li></ul></dd></dl><dl><dt><var>cacheDirectory</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> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">No</td></tr></table><p>Directory to cache OPeNDAP datasets.</p><p>A cache directory can dramatically speed up scenarios that involve
143accessing the same subsets the HYCOM data over and over again. When
144OPeNDAP data is requested from the HYCOM server, the cache directory
145will be checked for data that was downloaded and cached during prior
146requests. If cached data exists that can fulfill part of the current
147request, the request will be serviced by reading from cache files
148rather than the OPeNDAP server. If the entire request can be serviced
149from the cache, the OPeNDAP server will not be accessed at all and the
150request will be completed extremely quickly. Any parts of the request
151that cannot be serviced from the cache will be downloaded from the
152OPeNDAP server and added to the cache, speeding up future requests for
153the same data.</p><p>If you use a cache directory, be aware of these common pitfalls:</p><ul><li>The HYCOM documentation states that HYCOM provides a five day forecast
154and five day hindcast from the current date, although we have
155observed netCDF files on their servers that suggested this window
156may extend seven days in both directions. HYCOM revises the data
157within this time window daily, using the latest ocean observations
158assimilated from buoys, satellites, and other sensors. We recommend
159you do not cache data in this time window. The caching algorithm
160cannot detect whether cached data should be replaced with revised
161versions available on the server.</li><li>The caching algorithm permits the cache to grow to infinite size and
162never deletes any cached data. If you access a large amount of data
163it will all be added to the cache. Be careful that you do not fill
164up your hard disk. To mitigate this, manually delete the entire
165cache or selected directories or files within it.</li><li>The caching algorithm stores data in uncompressed files, so that
166subsets of those files may be quickly accessed. To save space on
167your hard disk, you can enable compression of the cache directory
168using the operating system. On Windows, right click on the directory
169in Windows Explorer, select Properties, click Advanced, and enable
170"Compress contents to save disk space".</li></ul></dd></dl><dl><dt><var>calculateStatistics</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">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>True</code></td></tr></table><p>If True, statistics will be calculated for the output rasters
171using the ArcGIS Calculate Statistics geoprocessing tool. This is
172usually a good idea for most raster formats because ArcGIS will only
173display them with helpful colors and gradients if statistics have been
174calculated. For certain formats, the explicit calculation of
175statistics is not necessary because it happens automatically when the
176rasters are created. If you're using one of those formats, you can set
177this option to False to speed up the creation of the output
178rasters.</p></dd></dl><dl><dt><var>buildPyramids</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">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, pyramids will be built for the output rasters using the
179ArcGIS Build Pyramids tool. Pyramids, also known as overviews, are
180reduced resolution versions of the rasters that can improve the speed
181at which they are displayed in the ArcGIS user interface.</p></dd></dl><h3>Returns</h3><dl><dt><var>updatedOutputWorkspace</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><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">No</td></tr></table><p>Updated output workspace.</p></dd></dl><h3>Remarks</h3><p>This tool produces rasters showing the climatological average
182value (or other statistic) of a HYCOM GLMl0.04 3D variable. Given a
183desired variable, a statistic, and a climatological bin definition,
184this tool downloads daily images for the variable, classifies them
185into bins, and produces a single raster for each bin. Each cell of the
186raster is produced by calculating the statistic on the values of that
187cell extracted from all of the rasters in the bin.</p><p>At the time this tool was developed, the
188<a href="http://www.hycom.org/dataserver/goml0pt04/">HYCOM + NCODA Gulf of Mexico 1/25 Degree Analysis (GLMl0.04)</a>
189consisted of two gridded datasets:</p><ul><li>expt_20.1 - The 20.1 experiment running from 1 January 2003 through
19030 June 2010.</li><li>expt_30.1 - The 30.1 experiment running from 1 July 2010 and running
191to the present day plus five days.</li></ul><p>The datasets have identical spatiotemporal extents and resolutions and
192the same oceanographic variables. This tool treats them as one
193continuous dataset and takes time slices prior to 1 July 2010 from
194expt_20.1 and on or after that date from expt_30.1. (On the HYCOM
195server, the datasets actually overlap slightly, with expt_20.1 ending
196slightly after 30 June 2010 and expt_30.1 starting slightly before 1
197July 2010. The tool ignores the overlapping time slices and
198switches from expt_20.1 to expt_30.1 on 1 July.)</p><p>The grids are in Mercator projection based on a sphere with radius
1996371001 m, with square cells approximately 4.5 km on a side. The
200geographic extent is approximately 18 to 32 N, 98 to 76 W. The time
201step is 1 day, with time slices representing the instantaneous
202condition of the ocean estimated at 00:00 UTC on each day.</p><p>The HYCOM documentation states that HYCOM provides a five day forecast
203and five day hindcast from the current date, although we have observed
204netCDF files on their servers that suggested this window may extend
205seven days in both directions. HYCOM revises the data within this
206window daily, using the latest ocean observations assimilated from
207buoys, satellites, and other sensors. Use caution when working with
208time slices close to the current date, as it appears that time slices
209continue to be revised until they are 7 days older than the current
210date.</p><p>Occasionally, HYCOM fails to generate data for a time slice,
211presumably due to an outage or other problem in their data processing
212infrastructure. For example, in 2004, HYCOM failed to generate data
213for three of the 366 time slices of that year. Although HYCOM omits
214these time slices from their server, this tool represents them as
215grids filled with the No Data value.</p><p>The datasets include both 3D variables (dimensions x, y, and time) and
2164D variables (dimensions x, y, depth, and time). The 4D variables are
217estimated at 40 depth levels: 0, 5, 10, 15, 20, 25, 30, 40, 50, 60,
21870, 80, 90, 100, 125, 150, 200, 250, 300, 400, 500, 600, 700, 800,
219900, 1000, 1100, 1200, 1300, 1400, 1500, 1750, 2000, 2500, 3000, 3500,
2204000, 4500, 5000, and 5500 m.</p><p>This tool accesses the HYCOM datasets using the
221<a href="http://opendap.org/">OPeNDAP</a> protocol, allowing data to be
222retrieved very efficiently. However, during periods of high load, the
223HYCOM OPeNDAP server often requires five to ten minutes to return the
224first slice of data. Please be patient; after the first one is
225returned, the rest will go much faster. During periods of extreme
226load, the tool may fail with a timeout error. If this happens,
227increase the timeout value and try again, or wait until later when the
228server is less busy.</p><p><strong>References</strong></p><p>Chassignet, E.P., Hurlburt, H.E., Metzger, E.J., Smedstad, O.M.,
229Cummings, J.A., Halliwell, G.R., Bleck, R., Baraille, R., Wallcraft.,
230A.J., Lozano, C., Tolman, H.L., Srinivasan, A., Hankin, S., Cornillon,
231P., Weisberg, R., Barth, A., He, R., Werner, F. and Wilkin, J. (2009).
232US GODAE: Global Ocean Prediction with the HYbrid Coordinate Ocean
233Model (HYCOM). Oceanography 22: 64-75.</p><p>The HYCOM User's Guide and many other technical documents are
234available on the
235<a href="http://www.hycom.org/hycom/documentation">HYCOM web site</a>.</p><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="CreateArcGISRasters Method" href="Method_GeoEco.DataProducts.HYCOM.HYCOMGOMl0043D.CreateArcGISRasters.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="HYCOMGOMl0043D Class" href="Class_GeoEco.DataProducts.HYCOM.HYCOMGOMl0043D.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="InterpolateAtArcGISPoints Method" href="Method_GeoEco.DataProducts.HYCOM.HYCOMGOMl0043D.InterpolateAtArcGISPoints.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.DataProducts.HYCOM.HYCOMGOMl0043D.CreateArcGISRasters.html?format=raw">CreateArcGISRasters Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataProducts.HYCOM.HYCOMGOMl0043D.html?format=raw">HYCOMGOMl0043D Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DataProducts.HYCOM.HYCOMGOMl0043D.InterpolateAtArcGISPoints.html?format=raw">InterpolateAtArcGISPoints Method</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.