|
Finds SIR files in a directory and converts them to ArcGIS rasters.
Command line syntax| Expression | Explanation |
|---|---|
| <inputDirectory> | Directory to search. |
| <outputWorkspace> | Workspace to receive the ArcGIS rasters. |
| {wildcard} | UNIX-style "glob" wildcard expression specifying the pathnames to find. The glob syntax supports the following patterns:
seq is one or more characters, such as abc. You may specify character ranges using a dash. For example, a-z0-9 specifies all of the characters in the English alphabet and the decimal digits 0 through 9. You may specify subdirectories in the glob expression. For example, the expression cruise*/sst* will find all paths beginning with sst that are contained in directories beginning with cruise. The operating system determines whether / or \ is used as the directory separator. On Windows, both will work. On most flavors of UNIX, / must be used. The operating system determines if matching is case sensitive. On Windows, matching is case-insensitive. On most flavors of UNIX, matching is case-sensitive. |
| {searchTree} | If True, subdirectories will be searched. |
| {minSize} | Minimum size, in bytes, of files to find. If provided, only files that are this size or larger will be found. |
| {maxSize} | Maximum size, in bytes, of files to find. If provided, only files that are this size or smaller will be found. |
| {minDateCreated} | Minimum creation date, in the local time zone, of the files to find, as reported by the operating system. If provided, only files that were created on or after this date will be found. You may provide a date with or without a time. If you do not provide a time, it is assumed to be midnight. |
| {maxDateCreated} | Maximum creation date, in the local time zone, of the files to find, as reported by the operating system. If provided, only files that were created on or before this date will be found. You may provide a date with or without a time. If you do not provide a time, it is assumed to be midnight. |
| {minDateModified} | Minimum modification date, in the local time zone, of the files to find, as reported by the operating system. If provided, only files that were modified on or after this date will be found. You may provide a date with or without a time. If you do not provide a time, it is assumed to be midnight. |
| {maxDateModified} | Maximum modification date, in the local time zone, of the files to find, as reported by the operating system. If provided, only files that were modified on or before this date will be found. You may provide a date with or without a time. If you do not provide a time, it is assumed to be midnight. |
| {projectedCoordinateSystem} | New coordinate system to project the output raster to. The raster may only be projected to a new coordinate system if the original projection is defined. An error will be raised if you specify a new coordinate system without defining the original coordinate system. The ArcGIS Project Raster tool is used to perform the projection. The documentation for that tool recommends that you also specify a cell size for the new coordinate system. I have noticed that for certain coordinate systems the ArcGIS 9.2 Project Raster tool seems to clip the projected raster to an arbitrary extent that is too small. For example, when projecting a global MODIS Aqua 4 km chlorophyll image in geographic coordinates to Lambert_Azimuthal_Equal_Area with central meridian of -60 and latitude of origin of -63, the resulting image is clipped to show only one-quarter of the planet. This problem does not occur when Project Raster is invoked interactively from the ArcGIS user interface; it only occurs when the tool is invoked programmatically (the ProjectRaster_management method of the geoprocessor). Thus you may not see it when you use Project Raster yourself but it may happen when you use MGET tools that invoke Project Raster as part of their geoprocessing operations. If you encounter this problem, you can work around it like this:
|
| {geographicTransformation} | A transformation method used to convert between the original coordinate system and the new coordinate system. This parameter is a new option introduced by ArcGIS 9.2. You must have ArcGIS 9.2 to use this parameter. This parameter is only needed when you specify that the raster should be projected to a new coordinate system and that new system uses a different datum than the original coordinate system, or there is some other difference between the two coordinate systems that requires a transformation. To determine if a transformation is needed, I recommend the following procedure:
|
| {NEAREST | BILINEAR | CUBIC} | The resampling algorithm to be used to project the original raster to a new coordinate system. The ArcGIS Project Raster tool is used to perform the projection and accepts the following values:
You must specify one of these algorithms to project to a new coordinate system. An error will be raised if you specify a new coordinate system without selecting an algorithm. |
| {projectedCellSize} | The cell size of the projected coordinate system. Although this parameter is optional, to receive the best results, the ArcGIS documentation recommends you always specify it when projecting to a new coordinate system. |
| {registrationPoint} | The x and y coordinates (in the output space) used for pixel alignment. This parameter is a new option introduced by ArcGIS 9.2. You must have ArcGIS 9.2 to use this parameter. It is ignored if you do not specify that the raster should be projected to a new coordinate system. |
| {clippingRectangle} | Rectangle to which the raster should be clipped. If a projected coordinate system was specified, the clipping is performed after the projection and the rectangle's coordinates should be specified in the new coordinate system. If no projected coordinate system was specified, the coordinates should be specified in the original coordinate system. The ArcGIS Clip tool is used to perfom the clip. The clipping rectangle must be passed to this tool as a string of four numbers separated by spaces. The ArcGIS user interface automatically formats the string properly; when invoking this tool from the ArcGIS UI, you need not worry about the format. But when invoking it programmatically, take care to provide a properly-formatted string. The numbers are ordered LEFT, BOTTOM, RIGHT, TOP. For example, if the raster is in a geographic coordinate system, it may be clipped to 10 W, 15 S, 20 E, and 25 N with the string:
Integers or decimal numbers may be provided. |
| {mapAlgebraExpression} | Map algebra expression to execute on the output raster. WARNING: The ArcGIS Geoprocessing Model Builder may randomly and silently delete the value of this parameter. This is a bug in ArcGIS. Before running a model that you have saved, open this tool and validate that the parameter value still exists. The expression is executed after the converted raster is projected and clipped (if those options are specified). Use the case-sensitive string inputRaster to represent the raster that you now want to perform map algebra upon. For example, to convert the raster to an integer raster and add 1 to all of the cells, use this expression:
The string inputRaster is case-sensitive. Prior to executing the map algebra expression, the string is replaced with the path to a temporary raster that represents the output raster being generated. The final expression must be less than 4000 characters long or ArcGIS will report an error. The ArcGIS Single Output Map Algebra tool is used to execute the map algebra expression. You must have a license for the ArcGIS Spatial Analyst extension in order to perform map algebra. Map algebra syntax can be very picky. Here are some tips that will help you succeed with this tool:
|
| {buildPyramids} | If True, pyramids will be built for the output raster, which will improve its display speed in the ArcGIS user interface. This is the last step performed in post-conversion processing. |
| {outputRasterPythonExpression} | Python expression used to calculate the absolute path of an output raster. The expression may be any Python statement appropriate for passing to the eval function and must return a Unicode string. The expression may reference the following variables:
The default expression:
stores the raster in the output workspace in nested subdirectories according to the product type, region name, and year. For example, the file C:SIRqusv-a-Aus00-153-156.sir with output workspace C:Rasters would be stored as C:RastersqusvAus2000qusv2000153a. Note that the default expression extracts parts of the file name so it may not work with files that are named using a different scheme. The expression also assumes that the output workspace is a directory in the file system (rather than an Arc SDE database, for example). The following keys are available in the metadata dictionary. The Python data type of the value for the key appears in parentheses. Remember that if the value is not a string, you must convert it to one before you can use it in Python's os.path function:
For more information on Python syntax, please see the Python documentation <http://www.python.org/doc/> |
| {modulesToImport;modulesToImport...} | Python modules to import prior to evaluating the expression. If you need to access Python functions or classes that are provided by a module rather than being built-in to the interpreter, list the module here. For example, to be able to use the datetime class in your expression, list the datetime module here. In your expression, you must refer to the class using its fully-qualified name, datetime.datetime. |
| {skipExisting} | If True, conversion will be skipped for output rasters that already exist. |
Scripting syntax| Expression | Explanation |
|---|---|
| Directory to search (Required) | Directory to search. |
| Output workspace (Required) | Workspace to receive the ArcGIS rasters. |
| Wildcard expression (Optional) | UNIX-style "glob" wildcard expression specifying the pathnames to find. The glob syntax supports the following patterns:
seq is one or more characters, such as abc. You may specify character ranges using a dash. For example, a-z0-9 specifies all of the characters in the English alphabet and the decimal digits 0 through 9. You may specify subdirectories in the glob expression. For example, the expression cruise*/sst* will find all paths beginning with sst that are contained in directories beginning with cruise. The operating system determines whether / or \ is used as the directory separator. On Windows, both will work. On most flavors of UNIX, / must be used. The operating system determines if matching is case sensitive. On Windows, matching is case-insensitive. On most flavors of UNIX, matching is case-sensitive. |
| Search directory tree (Optional) | If True, subdirectories will be searched. |
| Minimum size (Optional) | Minimum size, in bytes, of files to find. If provided, only files that are this size or larger will be found. |
| Maximum size (Optional) | Maximum size, in bytes, of files to find. If provided, only files that are this size or smaller will be found. |
| Minimum creation date (Optional) | Minimum creation date, in the local time zone, of the files to find, as reported by the operating system. If provided, only files that were created on or after this date will be found. You may provide a date with or without a time. If you do not provide a time, it is assumed to be midnight. |
| Maximum creation date (Optional) | Maximum creation date, in the local time zone, of the files to find, as reported by the operating system. If provided, only files that were created on or before this date will be found. You may provide a date with or without a time. If you do not provide a time, it is assumed to be midnight. |
| Minimum modification date (Optional) | Minimum modification date, in the local time zone, of the files to find, as reported by the operating system. If provided, only files that were modified on or after this date will be found. You may provide a date with or without a time. If you do not provide a time, it is assumed to be midnight. |
| Maximum modification date (Optional) | Maximum modification date, in the local time zone, of the files to find, as reported by the operating system. If provided, only files that were modified on or before this date will be found. You may provide a date with or without a time. If you do not provide a time, it is assumed to be midnight. |
| Project to new coordinate system (Optional) | New coordinate system to project the output raster to. The raster may only be projected to a new coordinate system if the original projection is defined. An error will be raised if you specify a new coordinate system without defining the original coordinate system. The ArcGIS Project Raster tool is used to perform the projection. The documentation for that tool recommends that you also specify a cell size for the new coordinate system. I have noticed that for certain coordinate systems the ArcGIS 9.2 Project Raster tool seems to clip the projected raster to an arbitrary extent that is too small. For example, when projecting a global MODIS Aqua 4 km chlorophyll image in geographic coordinates to Lambert_Azimuthal_Equal_Area with central meridian of -60 and latitude of origin of -63, the resulting image is clipped to show only one-quarter of the planet. This problem does not occur when Project Raster is invoked interactively from the ArcGIS user interface; it only occurs when the tool is invoked programmatically (the ProjectRaster_management method of the geoprocessor). Thus you may not see it when you use Project Raster yourself but it may happen when you use MGET tools that invoke Project Raster as part of their geoprocessing operations. If you encounter this problem, you can work around it like this:
|
| Geographic transformation (Optional) | A transformation method used to convert between the original coordinate system and the new coordinate system. This parameter is a new option introduced by ArcGIS 9.2. You must have ArcGIS 9.2 to use this parameter. This parameter is only needed when you specify that the raster should be projected to a new coordinate system and that new system uses a different datum than the original coordinate system, or there is some other difference between the two coordinate systems that requires a transformation. To determine if a transformation is needed, I recommend the following procedure:
|
| Projection resampling technique (Optional) | The resampling algorithm to be used to project the original raster to a new coordinate system. The ArcGIS Project Raster tool is used to perform the projection and accepts the following values:
You must specify one of these algorithms to project to a new coordinate system. An error will be raised if you specify a new coordinate system without selecting an algorithm. |
| Cell size for projected coordinate system (Optional) | The cell size of the projected coordinate system. Although this parameter is optional, to receive the best results, the ArcGIS documentation recommends you always specify it when projecting to a new coordinate system. |
| Registration point for projected coordinate system (Optional) | The x and y coordinates (in the output space) used for pixel alignment. This parameter is a new option introduced by ArcGIS 9.2. You must have ArcGIS 9.2 to use this parameter. It is ignored if you do not specify that the raster should be projected to a new coordinate system. |
| Clip to rectangle (Optional) | Rectangle to which the raster should be clipped. If a projected coordinate system was specified, the clipping is performed after the projection and the rectangle's coordinates should be specified in the new coordinate system. If no projected coordinate system was specified, the coordinates should be specified in the original coordinate system. The ArcGIS Clip tool is used to perfom the clip. The clipping rectangle must be passed to this tool as a string of four numbers separated by spaces. The ArcGIS user interface automatically formats the string properly; when invoking this tool from the ArcGIS UI, you need not worry about the format. But when invoking it programmatically, take care to provide a properly-formatted string. The numbers are ordered LEFT, BOTTOM, RIGHT, TOP. For example, if the raster is in a geographic coordinate system, it may be clipped to 10 W, 15 S, 20 E, and 25 N with the string:
Integers or decimal numbers may be provided. |
| Execute map algebra expression (Optional) | Map algebra expression to execute on the output raster. WARNING: The ArcGIS Geoprocessing Model Builder may randomly and silently delete the value of this parameter. This is a bug in ArcGIS. Before running a model that you have saved, open this tool and validate that the parameter value still exists. The expression is executed after the converted raster is projected and clipped (if those options are specified). Use the case-sensitive string inputRaster to represent the raster that you now want to perform map algebra upon. For example, to convert the raster to an integer raster and add 1 to all of the cells, use this expression:
The string inputRaster is case-sensitive. Prior to executing the map algebra expression, the string is replaced with the path to a temporary raster that represents the output raster being generated. The final expression must be less than 4000 characters long or ArcGIS will report an error. The ArcGIS Single Output Map Algebra tool is used to execute the map algebra expression. You must have a license for the ArcGIS Spatial Analyst extension in order to perform map algebra. Map algebra syntax can be very picky. Here are some tips that will help you succeed with this tool:
|
| Build pyramids (Optional) | If True, pyramids will be built for the output raster, which will improve its display speed in the ArcGIS user interface. This is the last step performed in post-conversion processing. |
| Output ArcGIS raster Python expression (Optional) | Python expression used to calculate the absolute path of an output raster. The expression may be any Python statement appropriate for passing to the eval function and must return a Unicode string. The expression may reference the following variables:
The default expression:
stores the raster in the output workspace in nested subdirectories according to the product type, region name, and year. For example, the file C:SIRqusv-a-Aus00-153-156.sir with output workspace C:Rasters would be stored as C:RastersqusvAus2000qusv2000153a. Note that the default expression extracts parts of the file name so it may not work with files that are named using a different scheme. The expression also assumes that the output workspace is a directory in the file system (rather than an Arc SDE database, for example). The following keys are available in the metadata dictionary. The Python data type of the value for the key appears in parentheses. Remember that if the value is not a string, you must convert it to one before you can use it in Python's os.path function:
For more information on Python syntax, please see the Python documentation <http://www.python.org/doc/> |
| Python modules to import (Optional) | Python modules to import prior to evaluating the expression. If you need to access Python functions or classes that are provided by a module rather than being built-in to the interpreter, list the module here. For example, to be able to use the datetime class in your expression, list the datetime module here. In your expression, you must refer to the class using its fully-qualified name, datetime.datetime. |
| Skip existing outputs (Optional) | If True, conversion will be skipped for output rasters that already exist. |