root/MGET/Branches/Jason/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.DataProducts.NOAA.CoastWatchAVHRR.CoastWatchAVHRR.CopyNavigationOffsetsList.html @ 316

Revision 316, 12.1 KB (checked in by jjr8, 5 years ago)

Built MGET 0.7a1. Forgot to mention that the checkin before the last one also fixed #308: When a GAM uses the loess function (lo) and is fitted with the R gam package, Predict GAM fails when rasters include NODATA values.

This will be merged into Trunk and released as MGET 0.7a1.
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>CopyNavigationOffsetsList 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="CopyNavigationOffsetsArcGISTable Method" href="Method_GeoEco.DataProducts.NOAA.CoastWatchAVHRR.CoastWatchAVHRR.CopyNavigationOffsetsArcGISTable.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="CoastWatchAVHRR Class" href="Class_GeoEco.DataProducts.NOAA.CoastWatchAVHRR.CoastWatchAVHRR.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="CopyNavigationOffsetsTable Method" href="Method_GeoEco.DataProducts.NOAA.CoastWatchAVHRR.CoastWatchAVHRR.CopyNavigationOffsetsTable.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.NOAA.CoastWatchAVHRR.CoastWatchAVHRR.CopyNavigationOffsetsArcGISTable.html?format=raw">CopyNavigationOffsetsArcGISTable Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataProducts.NOAA.CoastWatchAVHRR.CoastWatchAVHRR.html?format=raw">CoastWatchAVHRR Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DataProducts.NOAA.CoastWatchAVHRR.CoastWatchAVHRR.CopyNavigationOffsetsTable.html?format=raw">CopyNavigationOffsetsTable Method</a> </div><hr /></div></div><h1><tt class="member">CopyNavigationOffsetsList</tt> Method</h1><p>Copies navigation offsets from a source variable to destination variables in CoastWatch POES AVHRR CWF or HDF files in a list.</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.NOAA.CoastWatchAVHRR.CoastWatchAVHRR.html?format=raw">CoastWatchAVHRR</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.CoastWatchAVHRR.CopyNavigationOffsetsList.html?format=raw">CopyNavigationOffsetsList</a> method of COM class <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Class_GeoEco.CoastWatchAVHRR.html?format=raw">GeoEco.CoastWatchAVHRR</a></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">CoastWatchAVHRR.CopyNavigationOffsetsList</tt></b>(</td><td><var>coastWatchFileList</var><var>, sourceVariable</var><big>[</big><var>, destVariables</var><big>[</big><var>, basePath</var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table><h3>Arguments</h3><dl><dt><var>coastWatchFileList</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">Minimum length:</td><td class="metadataValue">0</td></tr></table><p>List of CoastWatch POES AVHRR CWF or HDF files.</p><p>Navigation offsets will be extracted from the files in this list that
7contain the source variable and applied to the files that contain any
8of the destination variables, providing that the source file and
9destination file are for the same satellite image. If a file contains
10both the source variable and one or more destination variables, it
11will serve as both a source and destination file.</p><p>To determine of two given files are for the same satellite image, this
12function compares the image time, satellite, sensor, center
13coordinates, cell size, number of rows and columns, projection, and
14spheroid. If all are the same, the files are assumed to be for the
15same satellite image.</p><p>Only CoastWatch POES AVHRR files are supported. Other CoastWatch
16files, such as those for the GOES satellite series, will be skipped
17and a warning will be reported.</p></dd></dl><dl><dt><var>sourceVariable</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>CoastWatch variable in the source file from which navigation
18offsets should be copied.</p></dd></dl><dl><dt><var>destVariables</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'avhrr_ch1'</code><code>, </code><code>u'avhrr_ch2'</code><code>, </code><code>u'avhrr_ch3'</code><code>, </code><code>u'avhrr_ch3a'</code><code>, </code><code>u'avhrr_ch4'</code><code>, </code><code>u'avhrr_ch5'</code><code>, </code><code>u'cloud'</code><code>, </code><code>u'cloudx'</code><code>, </code><code>u'sst'</code><code>]</code></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>CoastWatch variables in the destination file to which the
19navigation offsets should be applied. In general, navigation offsets
20should only be applied to variables that are derived from sensor data.
21At the time of this writing, the variables derived from sensor data
22included:</p><div class="verbatim"><pre xml:space="preserve">avhrr_ch1
23avhrr_ch2
24avhrr_ch3
25avhrr_ch3a
26avhrr_ch4
27avhrr_ch5
28cloud
29cloudx
30sst</pre></div><p>Peter Hollemans, one of the lead CoastWatch researchers at NOAA,
31suggested that navigation offsets should not be applied to the
32graphics, rel_azimuth, sat_zenith, and sun_zenith variables. With
33respect to the last three, he said:</p><p>"I've thought about it for a while and my inclination is to say
34don't correct the angle data.  It's not a perfect solution -- ie:
35if we knew the satellite's position and orientation perfectly and
36recomputed the angle data, we would find <em>very</em> small
37discrepancies compared with the navigation-corrected version."</p></dd></dl><dl><dt><var>basePath</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>Base path to prepend to relative paths.</p><p>If any of the input paths (or output paths, if this method has
38outputs) contained in the lists are relative paths, they will be
39converted to absolute paths prior to processing, as follows:</p><ul><li>If a base path is provided, it will be prepended to the relative
40path.</li><li>Otherwise, if the ArcGIS geoprocessor has been initialized and the
41geoprocessing workspace has been set (i.e. the Workspace property of
42the geoprocessor is not empty), it will be prepended to the relative
43path.</li><li>Otherwise, the current working directory for the executing process
44will be prepended to the path. If you have not explicitly changed
45the working directory, it is usually the directory that contains the
46Python interpreter (e.g., on Windows computers, it would be
47C:Python24, if you're running Python 2.4).</li></ul></dd></dl><h3>Remarks</h3><p>The navigation offsets are the e and f coefficients of the
48navigation affine attribute of each variable (the HDF nav_affine
49attribute). Prior to setting the navigation offsets in the destination
50file, the entire navigation affine is reset by invoking the cwnavigate
51utility with the -R option.</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="CopyNavigationOffsetsArcGISTable Method" href="Method_GeoEco.DataProducts.NOAA.CoastWatchAVHRR.CoastWatchAVHRR.CopyNavigationOffsetsArcGISTable.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="CoastWatchAVHRR Class" href="Class_GeoEco.DataProducts.NOAA.CoastWatchAVHRR.CoastWatchAVHRR.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="CopyNavigationOffsetsTable Method" href="Method_GeoEco.DataProducts.NOAA.CoastWatchAVHRR.CoastWatchAVHRR.CopyNavigationOffsetsTable.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.NOAA.CoastWatchAVHRR.CoastWatchAVHRR.CopyNavigationOffsetsArcGISTable.html?format=raw">CopyNavigationOffsetsArcGISTable Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataProducts.NOAA.CoastWatchAVHRR.CoastWatchAVHRR.html?format=raw">CoastWatchAVHRR Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DataProducts.NOAA.CoastWatchAVHRR.CoastWatchAVHRR.CopyNavigationOffsetsTable.html?format=raw">CopyNavigationOffsetsTable Method</a> </div><hr /><span class="release-info">Marine Geospatial Ecology Tools version 0.7a1</span></div></div></body></html>
Note: See TracBrowser for help on using the browser.