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

Revision 316, 43.0 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>CreateMasksAsBinaryRastersList 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="CreateMasksAsBinaryRastersArcGISTable Method" href="Method_GeoEco.DataProducts.NOAA.CoastWatchAVHRR.CoastWatchAVHRR.CreateMasksAsBinaryRastersArcGISTable.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="CreateMasksAsBinaryRastersTable Method" href="Method_GeoEco.DataProducts.NOAA.CoastWatchAVHRR.CoastWatchAVHRR.CreateMasksAsBinaryRastersTable.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.CreateMasksAsBinaryRastersArcGISTable.html?format=raw">CreateMasksAsBinaryRastersArcGISTable 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.CreateMasksAsBinaryRastersTable.html?format=raw">CreateMasksAsBinaryRastersTable Method</a> </div><hr /></div></div><h1><tt class="member">CreateMasksAsBinaryRastersList</tt> Method</h1><p>Creates masks, in binary raster format, for a list of CoastWatch POES AVHRR images.</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.CreateMasksAsBinaryRastersList.html?format=raw">CreateMasksAsBinaryRastersList</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.CreateMasksAsBinaryRastersList</tt></b>(</td><td><var>coastWatchFileList</var><var>, outputFileList</var><big>[</big><var>, maskMissingData</var><big>[</big><var>, maskLand</var><big>[</big><var>, cloudMaskFileList</var><big>[</big><var>, cloudVariable</var><big>[</big><var>, sunZenithFileList</var><big>[</big><var>, sunZenithVariable</var><big>[</big><var>, useDayCloudTest1</var><big>[</big><var>, useDayCloudTest2</var><big>[</big><var>, useDayCloudTest3</var><big>[</big><var>, useDayCloudTest4</var><big>[</big><var>, useDayCloudTest5</var><big>[</big><var>, useDayCloudTest6</var><big>[</big><var>, useDayCloudTest7</var><big>[</big><var>, maskWhenDayCloudMaskExceeds</var><big>[</big><var>, useNightCloudTest1</var><big>[</big><var>, useNightCloudTest2</var><big>[</big><var>, useNightCloudTest3</var><big>[</big><var>, useNightCloudTest4</var><big>[</big><var>, useNightCloudTest5</var><big>[</big><var>, useNightCloudTest6</var><big>[</big><var>, useNightCloudTest7</var><big>[</big><var>, maskWhenNightCloudMaskExceeds</var><big>[</big><var>, minCloudyNeighbors</var><big>[</big><var>, skipExisting</var><big>[</big><var>, overwriteExisting</var><big>[</big><var>, basePath</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><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>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 paths of the CoastWatch POES AVHRR CWF or HDF files.</p><p>Only CoastWatch POES AVHRR files are supported. Other CoastWatch
7files, such as those for the GOES satellite series, will be skipped
8and a warning will be reported.</p><p>Compressed files in a supported compression format will be
9automatically decompressed. Archives (e.g. .zip or .tar) must contain
10exactly one file, which must not be in a subdirectory.</p></dd></dl><dl><dt><var>outputFileList</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 output binary rasters to create.</p><p>The rasters will have the same dimensions as the input CoastWatch
11images. The cells will be ordered left-to-right, top-to-bottom, with
12columns increasing before rows. The upper-left cell is the first cell
13in the file, followed by the cell to its right, and so on to the end
14of the first row. The second row comes next, and so on to the end of
15the file. The lower-right cell is the last cell in the file.</p><p>The cells will be 8-bit signed integers. The value 1 indicates that
16the corresponding pixel of the input image was masked; 0 indicates the
17pixel was not masked.</p></dd></dl><dl><dt><var>maskMissingData</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, pixels that are missing data will be masked.</p><p>The most common cause for missing data is the satellite swath not
18completely covering the region of interest. The pixels that could not
19be seen by the sensor when the satellite flew over will be marked as
20missing data.</p></dd></dl><dl><dt><var>maskLand</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, pixels that are classified as land by the CoastWatch
21graphics variable will be masked.</p><p>The graphics variable is obtained by invoking the CoastWatch Utilities
22cwgraphics program on the input file. I have observed that this
23program does not always produce a land mask that is 100% identical to
24the graphics variable contained by the input file. For example, when I
25executed cwgraphics on 2005_108_1841_n16_er.hdf, I noticed that
26several pixels, mostly near the edges of the images, differed from
27those obtained by viewing the graphics variable in
282005_108_1841_n16_er.hdf using the cdat program.</p><p>I do not know the reason for this discrepancy. My theory is that the
29cwgraphics program does not read the graphics variable from the input
30file at all. Rather, it only reads the geographic extent and then
31produces a new land mask from its database in the installation
32directory of the CoastWatch Utilities. Newer versions of the
33CoastWatch Utilities may include updated land masks that differ from
34those used by CoastWatch in the past. But this is only a theory. In
35any case, the discrepancy seems to be quite insignificant and should
36not affect most users.</p></dd></dl><dl><dt><var>cloudMaskFileList</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> or <tt class="class">None</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">0</td></tr></table><p>List of paths of the CoastWatch POES AVHRR CWF or HDF files that
37contain the cloud masks for the input files.</p><p>If you omit this parameter, this tool will try to obtain the cloud
38mask from the input CoastWatch file instead. This will also occur when
39you do specify a field for this parameter, but a given row contains
40NULL for that field. If no cloud mask can be obtained from whichever
41file is used, cloud masking will not be performed.</p><p>If you're processing only HDFs, you can probably omit this parameter.
42HDFs usually contain all of the variables for a given satellite pass,
43including the cloud mask, so it is not necessary to obtain it from a
44different file. If you're processing CWFs, you must specify a field
45for this parameter if you want cloud masking to be performed. If
46you're processing both HDFs and CWFs, the field can contain NULL for
47the HDFs.</p><p>Compressed files in a supported compression format will be
48automatically decompressed. Archives (e.g. .zip or .tar) must contain
49exactly one file, which must not be in a subdirectory.</p></dd></dl><dl><dt><var>cloudVariable</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"><code>u'cloud'</code></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>Name of the CoastWatch variable to extract from the cloud mask
50file and use as the cloud mask (e.g. "cloud").</p><p>The current implementation of this tool was designed to operate on the
518-bit CLAVR cloud mask represented by the "cloud" variable in
52CoastWatch files. It was not designed to operate on the "cloudx"
53variable, which is a new experimental CLAVR-x cloud mask available in
54recent CoastWatch HDF files. Nonetheless, if you wish to operate on
55the cloudx variable, you can specify it instead of cloud, and pick
56mask options appropriate for it instead.</p></dd></dl><dl><dt><var>sunZenithFileList</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> or <tt class="class">None</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">0</td></tr></table><p>List of paths of the CoastWatch POES AVHRR CWF or HDF files that
57contain the cloud solar zenith images (i.e. the "sun_zenith" variable)
58for the input files.</p><p>If you omit this parameter, this tool will try to obtain the solar
59zenith image from the input CoastWatch file instead. This will also
60occur when you do specify a field for this parameter, but a given row
61contains NULL for that field.</p><p>If you're processing only HDFs, you can probably omit this parameter.
62HDFs usually contain all of the variables for a given satellite pass,
63including the solar zenith (when sun is above the horizon), so it is
64not necessary to obtain it from a different file. If you're processing
65CWFs, you must specify a field for this parameter if you want cloud
66masking to be performed and you're processing images with a day/night
67scene time. If you're processing both HDFs and CWFs, the field can
68contain NULL for the HDFs.</p><p>Compressed files in a supported compression format will be
69automatically decompressed. Archives (e.g. .zip or .tar) must contain
70exactly one file, which must not be in a subdirectory.</p><p>According to CoastWatch researcher Peter Hollemans, when an image's
71scene time is "day", all pixels of the cloud mask use daytime cloud
72tests, and when it is "night", all pixels use nighttime cloud tests.
73When the scene time is "day/night", the decision of which tests to use
74is based on the solar zenith for that pixel.</p><p>According to Peter, for CoastWatch HDF files, pixels with a solar
75zenith &gt; 80 degrees use the nighttime cloud tests, and &lt;= 80 use the
76daytime cloud tests. This tool implements that logic. If you specify
77that cloud masking should be performed for a day/night image but no
78solar zenith image is available, this tool will assume that nighttime
79cloud tests were used for every pixel and a warning will be issued.
80For some reason, CoastWatch occasionally produces day/night images
81with no sun_zenith or other variables that are present in day images.
82My recollection is that Peter said it is safe to assume for these
83images that all pixels are nighttime.</p><p>The solar zenith image is ignored for scene times other than
84"day/night" (e.g. "day" or "night").</p><p>After some investigation, I find that the cloud mask pixels near the
8580 degree solar zenith line are problematic, for two reasons:</p><ul><li>According to Peter, the solar zenith &lt;= 80 cutoff line is not going
86to line up perfectly with the switch from daytime to nighttime cloud
87tests because the solar zenith angles are rounded to the nearest
880.01 when written to the HDF file so a few pixels with values of say
8980.003 will get rounded to 80 even though they underwent processing
90with the nighttime cloud tests. Peter said, "I guess that's the flaw
91with storing angle data in HDF as scaled integers (that decision was
92mainly due to file size concerns)."</li><li>The switch between daytime tests and nighttime tests does not
93manifest as a clean transition in the cloud mask pixels. The daytime
94pixels do not seem to cleanly abut the nighttime pixels. Rather, a
95strip of pixels with strange values raggedly separates the two.
96Peter said: "The apparent unclean transition between day and night
97tests is related to neighborhood functions.  The uniformity tests
98use a 2x2 box of data values to the right and below a given value in
99the array to check for a condition being true, and the results of
100the uniformity test flag all pixels in the 2x2 box with the test
101results, regardless of whether all those pixels are day or
102nighttime.  Both day and nighttime have uniformity tests, so the
103results of uniformity tests at the day/night boundary are mixed. The
104mixing is generally acceptable because the results are intended to
105be used for SST masking not cloud type evaluation and the mixing
106only occurs in cloudy conditions, not clear SST conditions."</li></ul><p>Peter said he did not know what was done for CoastWatch day/night CWF
107files. I examined a few of these from the North East region, and it
108appeared that they also switched from daytime to nighttime cloud tests
109in the middle of the image. But the NOAA distribution site
110(<a href="http://www.class.noaa.gov">http://www.class.noaa.gov</a>) only appeared to have CWFs containing the
111sun_zenith variable for dates after late 1999.</p><p>Peter mentioned that the cwangles program from the CoastWatch
112Utilities could compute the solar zenith, but the values would only be
113approximate beacuse the program assumed that all pixels were obtained
114by the sensor at the same moment in time. I tried this approach but
115the 80 degree solar zenith line did not line up with the line where
116the cloud tests appeared to switch. Because of this, I do not believe
117that day/night CWF files will be useable for users who want to use
118some cloud tests and ignore others.</p></dd></dl><dl><dt><var>sunZenithVariable</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"><code>u'sun_zenith'</code></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>Name of the CoastWatch variable to extract from the solar zenith
119file and use as the solar zenith image (e.g. "sun_zenith").</p></dd></dl><dl><dt><var>useDayCloudTest1</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, daytime pixels that failed the CLAVR-1 Reflective Gross
120Cloud Test (bit 1 of the cloud mask) will be masked. If False, this
121cloud test will be ignored.</p><p>According to CoastWatch researcher Peter Hollemans, the same CLAVR-1
122test is used for both CWF and HDF files, but for HDF files, the
123CLAVR-x thresholds are used instead of than of the CLAVR-1 thresholds.</p><p>This parameter is ignored for nighttime pixels. For a discussion of
124how pixels are classified as daytime or nighttime, please see the
125documentation for the cloud mask file parameter.</p><p>In CoastWatch cloud masks, bit 1 is the least significant bit, and a
126value of 0 for a bit indicates that the cloud test passed, while 1
127indicates it failed. For more details about the cloud tests, please see the
128CoastWatch and CLAVR documentation.</p></dd></dl><dl><dt><var>useDayCloudTest2</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, daytime pixels that failed the CLAVR-1 Reflectance
129Uniformity Test (bit 2 of the cloud mask) will be masked. If False,
130this cloud test will be ignored.</p><p>According to CoastWatch researcher Peter Hollemans, the same CLAVR-1
131test is used for both CWF and HDF files, but for HDF files, the
132CLAVR-x thresholds are used instead of than of the CLAVR-1 thresholds.</p><p>This parameter is ignored for nighttime pixels. For a discussion of
133how pixels are classified as daytime or nighttime, please see the
134documentation for the cloud mask file parameter.</p><p>In CoastWatch cloud masks, bit 1 is the least significant bit, and a
135value of 0 for a bit indicates that the cloud test passed, while 1
136indicates it failed. For more details about the cloud tests, please see the
137CoastWatch and CLAVR documentation.</p></dd></dl><dl><dt><var>useDayCloudTest3</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, daytime pixels that failed the CLAVR-1 Reflectance Ratio
138Cloud Test (bit 3 of the cloud mask) will be masked. If False, this
139cloud test will be ignored.</p><p>According to CoastWatch researcher Peter Hollemans, the same CLAVR-1
140test is used for both CWF and HDF files, but for HDF files, the
141CLAVR-x thresholds are used instead of than of the CLAVR-1 thresholds.</p><p>This parameter is ignored for nighttime pixels. For a discussion of
142how pixels are classified as daytime or nighttime, please see the
143documentation for the cloud mask file parameter.</p><p>In CoastWatch cloud masks, bit 1 is the least significant bit, and a
144value of 0 for a bit indicates that the cloud test passed, while 1
145indicates it failed. For more details about the cloud tests, please see the
146CoastWatch and CLAVR documentation.</p></dd></dl><dl><dt><var>useDayCloudTest4</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, daytime pixels that failed the CLAVR-1 Channel 3 Albedo
147Test (bit 4 of the cloud mask) will be masked. If False, this cloud
148test will be ignored.</p><p>This parameter is ignored for nighttime pixels. For a discussion of
149how pixels are classified as daytime or nighttime, please see the
150documentation for the cloud mask file parameter.</p><p>In CoastWatch cloud masks, bit 1 is the least significant bit, and a
151value of 0 for a bit indicates that the cloud test passed, while 1
152indicates it failed. For more details about the cloud tests, please see the
153CoastWatch and CLAVR documentation.</p></dd></dl><dl><dt><var>useDayCloudTest5</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, daytime pixels that failed the CLAVR-1 Thermal Uniformity
154Test (bit 5 of the cloud mask) will be masked. If False, this cloud
155test will be ignored.</p><p>This parameter is ignored for nighttime pixels. For a discussion of
156how pixels are classified as daytime or nighttime, please see the
157documentation for the cloud mask file parameter.</p><p>In CoastWatch cloud masks, bit 1 is the least significant bit, and a
158value of 0 for a bit indicates that the cloud test passed, while 1
159indicates it failed. For more details about the cloud tests, please see the
160CoastWatch and CLAVR documentation.</p></dd></dl><dl><dt><var>useDayCloudTest6</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, daytime pixels that failed the CLAVR-1 Four Minus Five
161Test (bit 6 of the cloud mask) will be masked. If False, this cloud
162test will be ignored.</p><p>This parameter is ignored for nighttime pixels. For a discussion of
163how pixels are classified as daytime or nighttime, please see the
164documentation for the cloud mask file parameter.</p><p>In CoastWatch cloud masks, bit 1 is the least significant bit, and a
165value of 0 for a bit indicates that the cloud test passed, while 1
166indicates it failed. For more details about the cloud tests, please see the
167CoastWatch and CLAVR documentation.</p></dd></dl><dl><dt><var>useDayCloudTest7</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, daytime pixels that failed the CLAVR-1 Thermal Gross
168Cloud Test (bit 7 of the cloud mask) will be masked. If False, this
169cloud test will be ignored.</p><p>This parameter is ignored for nighttime pixels. For a discussion of
170how pixels are classified as daytime or nighttime, please see the
171documentation for the cloud mask file parameter.</p><p>In CoastWatch cloud masks, bit 1 is the least significant bit, and a
172value of 0 for a bit indicates that the cloud test passed, while 1
173indicates it failed. For more details about the cloud tests, please see the
174CoastWatch and CLAVR documentation.</p></dd></dl><dl><dt><var>maskWhenDayCloudMaskExceeds</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>0</code></td></tr><tr valign="baseline"><td class="metadataTitle">Maximum value:</td><td class="metadataValue"><code>255</code></td></tr></table><p>If a value is provided, daytime pixels with a cloud mask value
175greater than this value will be masked.</p><p>The CoastWatch cloud mask is a bitmask, where each bit represents the
176success (0) or failure (1) of a given CLAVR cloud test. Thus the cloud
177mask values are NOT intended to be interpreted as range, like a
178spectrum, where 0 represents "very clear" and 255 represents "very
179cloudy". Nevertheless, some users of this tool determined that for
180their study the best tradeoff between minimizing SST error and
181minimizing the number of pixels masked by clouds was obtained by
182masking all pixels where the cloud mask exceeded a certain value. This
183option was implemented specifically for those users and is not
184recommended for general use. If you do use this option, be sure to
185study many cloud mask images before selecting a value.</p><p>If a value is provided both for this parameter and for the cloud test
186bits specified by the previous parameters, all of these parameters
187will be effective. In other words, a cloudy pixel can be masked by
188failing a specific cloud test, or by exceeding the minimum cloud mask
189value, or both. .</p><p>This parameter is ignored for nighttime pixels. For a discussion of
190how pixels are classified as daytime or nighttime, please see the
191documentation for the cloud mask file parameter. For more information
192about the cloud tests, please see the CoastWatch and CLAVR
193documentation.</p></dd></dl><dl><dt><var>useNightCloudTest1</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, nighttime pixels that failed the CLAVR-1 Thermal Gross
194Cloud Test (bit 1 of the cloud mask) will be masked. If False, this
195cloud test will be ignored.</p><p>This parameter is ignored for daytime pixels. For a discussion of how
196pixels are classified as daytime or nighttime, please see the
197documentation for the cloud mask file parameter.</p><p>In CoastWatch cloud masks, bit 1 is the least significant bit, and a
198value of 0 for a bit indicates that the cloud test passed, while 1
199indicates it failed. For more details about the cloud tests, please
200see the CoastWatch and CLAVR documentation.</p></dd></dl><dl><dt><var>useNightCloudTest2</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, nighttime pixels that failed the CLAVR-1 Thermal
201Uniformity Test (bit 2 of the cloud mask) will be masked. If False,
202this cloud test will be ignored.</p><p>This parameter is ignored for daytime pixels. For a discussion of how
203pixels are classified as daytime or nighttime, please see the
204documentation for the cloud mask file parameter.</p><p>In CoastWatch cloud masks, bit 1 is the least significant bit, and a
205value of 0 for a bit indicates that the cloud test passed, while 1
206indicates it failed. For more details about the cloud tests, please
207see the CoastWatch and CLAVR documentation.</p></dd></dl><dl><dt><var>useNightCloudTest3</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, nighttime pixels that failed the CLAVR-1 Uniform Low
208Stratus Test (bit 3 of the cloud mask) will be masked. If False, this
209cloud test will be ignored.</p><p>This parameter is ignored for daytime pixels. For a discussion of how
210pixels are classified as daytime or nighttime, please see the
211documentation for the cloud mask file parameter.</p><p>In CoastWatch cloud masks, bit 1 is the least significant bit, and a
212value of 0 for a bit indicates that the cloud test passed, while 1
213indicates it failed. For more details about the cloud tests, please
214see the CoastWatch and CLAVR documentation.</p></dd></dl><dl><dt><var>useNightCloudTest4</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, nighttime pixels that failed the CLAVR-1 Four Minus Five
215Test (bit 4 of the cloud mask) will be masked. If False, this cloud
216test will be ignored.</p><p>This parameter is ignored for daytime pixels. For a discussion of how
217pixels are classified as daytime or nighttime, please see the
218documentation for the cloud mask file parameter.</p><p>In CoastWatch cloud masks, bit 1 is the least significant bit, and a
219value of 0 for a bit indicates that the cloud test passed, while 1
220indicates it failed. For more details about the cloud tests, please
221see the CoastWatch and CLAVR documentation.</p></dd></dl><dl><dt><var>useNightCloudTest5</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, nighttime pixels that failed the CLAVR-1 Cirrus Test (bit
2225 of the cloud mask) will be masked. If False, this cloud test will be
223ignored.</p><p>This parameter is ignored for daytime pixels. For a discussion of how
224pixels are classified as daytime or nighttime, please see the
225documentation for the cloud mask file parameter.</p><p>In CoastWatch cloud masks, bit 1 is the least significant bit, and a
226value of 0 for a bit indicates that the cloud test passed, while 1
227indicates it failed. For more details about the cloud tests, please
228see the CoastWatch and CLAVR documentation.</p></dd></dl><dl><dt><var>useNightCloudTest6</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, nighttime pixels that failed the CLAVR-x Channel 3B
229Albedo Test (bit 6 of the cloud mask) will be masked. If False, this
230cloud test will be ignored.</p><p>According to CoastWatch researcher Peter Hollemans, this test was not
231used for CoastWatch CWF files and thus bit 6 will always be 0,
232indicating success, for CWF nighttime cloud mask pixels.</p><p>This parameter is ignored for daytime pixels. For a discussion of how
233pixels are classified as daytime or nighttime, please see the
234documentation for the cloud mask file parameter.</p><p>In CoastWatch cloud masks, bit 1 is the least significant bit, and a
235value of 0 for a bit indicates that the cloud test passed, while 1
236indicates it failed. For more details about the cloud tests, please
237see the CoastWatch and CLAVR documentation.</p></dd></dl><dl><dt><var>useNightCloudTest7</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, nighttime pixels that failed the CLAVR-x Channel 3B
238Albedo Uniformity Test (bit 7 of the cloud mask) will be masked. If
239False, this cloud test will be ignored.</p><p>According to CoastWatch researcher Peter Hollemans, this test was not
240used for CoastWatch CWF files and thus bit 7 will always be 0,
241indicating success, for CWF nighttime cloud mask pixels.</p><p>This parameter is ignored for daytime pixels. For a discussion of how
242pixels are classified as daytime or nighttime, please see the
243documentation for the cloud mask file parameter.</p><p>In CoastWatch cloud masks, bit 1 is the least significant bit, and a
244value of 0 for a bit indicates that the cloud test passed, while 1
245indicates it failed. For more details about the cloud tests, please
246see the CoastWatch and CLAVR documentation.</p></dd></dl><dl><dt><var>maskWhenNightCloudMaskExceeds</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>0</code></td></tr><tr valign="baseline"><td class="metadataTitle">Maximum value:</td><td class="metadataValue"><code>255</code></td></tr></table><p>If a value is provided, nighttime pixels with a cloud mask value
247greater than this value will be masked.</p><p>The CoastWatch cloud mask is a bitmask, where each bit represents the
248success (0) or failure (1) of a given CLAVR cloud test. Thus the cloud
249mask values are NOT intended to be interpreted as range, like a
250spectrum, where 0 represents "very clear" and 255 represents "very
251cloudy". Nevertheless, some users of this tool determined that for
252their study the best tradeoff between minimizing SST error and
253minimizing the number of pixels masked by clouds was obtained by
254masking all pixels where the cloud mask exceeded a certain value. This
255option was implemented specifically for those users and is not
256recommended for general use. If you do use this option, be sure to
257study many cloud mask images before selecting a value.</p><p>If a value is provided both for this parameter and for the cloud test
258bits specified by the previous parameters, all of these parameters
259will be effective. In other words, a cloudy pixel can be masked by
260failing a specific cloud test, or by exceeding the minimum cloud mask
261value, or both. .</p><p>This parameter is ignored for daytime pixels. For a discussion of
262how pixels are classified as daytime or nighttime, please see the
263documentation for the cloud mask file parameter. For more information
264about the cloud tests, please see the CoastWatch and CLAVR
265documentation.</p></dd></dl><dl><dt><var>minCloudyNeighbors</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><tr valign="baseline"><td class="metadataTitle">Maximum value:</td><td class="metadataValue"><code>8</code></td></tr></table><p>Minimum number of neighbors that a cloudy pixel must have in order
266for that pixel to be masked.</p><p>You can use this option to ignore isolated cloudy pixels that are not
267clumped together. For example, if you specify the value 1, cloudy
268pixels will be ignored and not used in the masking process unless at
269least one of their eight neighbors is also cloudy.</p><p>If a neighbor is not cloudy but it is masked for some other reason
270(e.g. it is land), it does not count as being cloudy.</p><p>This option is ignored when cloud masking is not performed.</p></dd></dl><dl><dt><var>skipExisting</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, conversion will be skipped for output files that already exist.</p></dd></dl><dl><dt><var>overwriteExisting</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 and skipExisting is False, existing output files will be overwritten.</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
271outputs) contained in the lists are relative paths, they will be
272converted to absolute paths prior to processing, as follows:</p><ul><li>If a base path is provided, it will be prepended to the relative
273path.</li><li>Otherwise, if the ArcGIS geoprocessor has been initialized and the
274geoprocessing workspace has been set (i.e. the Workspace property of
275the geoprocessor is not empty), it will be prepended to the relative
276path.</li><li>Otherwise, the current working directory for the executing process
277will be prepended to the path. If you have not explicitly changed
278the working directory, it is usually the directory that contains the
279Python interpreter (e.g., on Windows computers, it would be
280C:Python24, if you're running Python 2.4).</li></ul></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="CreateMasksAsBinaryRastersArcGISTable Method" href="Method_GeoEco.DataProducts.NOAA.CoastWatchAVHRR.CoastWatchAVHRR.CreateMasksAsBinaryRastersArcGISTable.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="CreateMasksAsBinaryRastersTable Method" href="Method_GeoEco.DataProducts.NOAA.CoastWatchAVHRR.CoastWatchAVHRR.CreateMasksAsBinaryRastersTable.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.CreateMasksAsBinaryRastersArcGISTable.html?format=raw">CreateMasksAsBinaryRastersArcGISTable 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.CreateMasksAsBinaryRastersTable.html?format=raw">CreateMasksAsBinaryRastersTable 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.