ToBinaryRasterList Method

ToBinaryRasterList Method

Converts a Scientific Data Set (SDS) in each HDF file in a list to a binary raster.

Class:

HDF

Intended use:

Recommended for external callers

COM:

Exposed as the ToBinaryRasterList method of COM class GeoEco.HDF

ArcGIS:

Not exposed as an ArcGIS geoprocessing tool

Method type:

Classmethod

Usage

HDF.ToBinaryRasterList(

inputFileList, outputFileList, sdsName[, transpose[, mirror[, flip[, swapHemispheres[, skipExisting[, overwriteExisting[, basePath]]]]]]])

Arguments

inputFileList

Python type:	`list` of `unicode`
Minimum length:	0

List of paths of the input HDF files.

At the time this tool was written, two major versions of HDF were under continuing development: HDF, which was at release 4.2r1, and HDF5, which was at release 5-1.6.5. This tool can process HDF files but not HDF5 files. It can also process HDF-EOS, a specialized version of HDF, but not HDF5-EOS.

For more information on HDF formats, please see http://www.hdfgroup.org.

If you provide compressed files in a supported compression format, they will be automatically decompressed. If files are compressed in an archive format (e.g. .zip or .tar), each archive must contain exactly one file, which must not be in a subdirectory.

outputFileList

Python type:	`list` of `unicode`
Minimum length:	0

List of paths of the binary raster files to create.

sdsName

Python type:	`unicode`
Minimum length:	1

Name of a Scientific Data Set (SDS) in the HDF file.

If you do not know the name of the SDS, provide your best guess. If an SDS does not exist with that name, a ValueError will be raised. The error message will list the names of all SDSes present in the input file. Select one of these names try again.

You can also use the Extract HDF Header tool to dump the HDF header to a text file. In this file, each SDS will be called a "variable". You can find their names by searching the file for "Variable Name =". For example, the excerpt below from MODIS SST data lists two variables, l3m_data and l3m_qual:

Variable Name = l3m_data
         Index = 0
         Type= 16-bit unsigned integer
         Ref. = 2
         Rank = 2
         Number of attributes = 4
         Dim0: Name=fakeDim0
                 Size = 4320
                 Scale Type = number-type not set
                 Number of attributes = 0
         Dim1: Name=fakeDim1
                 Size = 8640
                 Scale Type = number-type not set
                 Number of attributes = 0
         Attr0: Name = Scaling
                 Type = 8-bit signed char
                 Count= 7
                 Value = linear\\000
         Attr1: Name = Scaling Equation
                 Type = 8-bit signed char
                 Count= 47
                 Value = (Slope*l3m_data) + Intercept = Parameter
                         value\\000
         Attr2: Name = Slope
                 Type = 32-bit floating point
                 Count= 1
                 Value = 0.000717
         Attr3: Name = Intercept
                 Type = 32-bit floating point
                 Count= 1
                 Value = -2.000000

Variable Name = l3m_qual
         Index = 1
         Type= 8-bit unsigned integer
         Ref. = 4
         Rank = 2
         Number of attributes = 1
         Dim0: Name=fakeDim2
                 Size = 4320
                 Scale Type = number-type not set
                 Number of attributes = 0
         Dim1: Name=fakeDim3
                 Size = 8640
                 Scale Type = number-type not set
                 Number of attributes = 0
         Attr0: Name = valid_range
                 Type = 32-bit signed integer
                 Count= 2
                 Value = 0 2

transpose

Python type:	`bool`
Default value:	`False`

If True, the image will be transposed (flipped about the diagonal axis) prior to conversion. Use this option to fix an image that has the east/west axis going up and down instead of left and right.

mirror

Python type:	`bool`
Default value:	`False`

If True, the image will be flipped about the vertical axis prior to conversion. Use this option to fix an image that is the "mirror image" of what it is supposed to be.

flip

Python type:	`bool`
Default value:	`False`

If True, the image will be flipped about the horizontal axis prior to conversion. Use this option to fix an image that is upside-down.

swapHemispheres

Python type:	`bool`
Default value:	`False`

If True, the east and west hemispheres of the image will be swapped. Use this option to change the orientation of a global image from a 0 to 360 orientation centered on the Pacific ocean to a -180 to +180 orientation centered on the Atlantic ocean, or visa versa.

skipExisting

Python type:	`bool`
Default value:	`False`

If True, processing will be skipped for binary raster files that already exist.

overwriteExisting

Python type:	`bool`
Default value:	`False`

If True and skipExisting is False, existing binary raster files will be overwritten.

basePath

Python type:	`unicode` or `None`
Default value:	`None`
Minimum length:	1
Maximum length:	255
Must exist:	No

Base path to prepend to relative paths.

If any of the input paths (or output paths, if this method has outputs) contained in the lists are relative paths, they will be converted to absolute paths prior to processing, as follows:

If a base path is provided, it will be prepended to the relative path.
Otherwise, if the ArcGIS geoprocessor has been initialized and the geoprocessing workspace has been set (i.e. the Workspace property of the geoprocessor is not empty), it will be prepended to the relative path.
Otherwise, the current working directory for the executing process will be prepended to the path. If you have not explicitly changed the working directory, it is usually the directory that contains the Python interpreter (e.g., on Windows computers, it would be C:Python24, if you're running Python 2.4).