hidtmgen
Generates PDS products from a DTM and/or orthorectified images.
This application is designed to produce a set of PDS products from an ISIS Digital Terrain Model (DTM) cube and/or a list of MRO HiRISE orthorectified images. The purpose of this program is to:
- Export the input cubes to PDS-formatted images.
- Modify the output label to include extra information.
The input DTM file for this program must have been generated using a set of HiRISE stereo pair images. If both input orthorecitfied files and an input DTM have been provided by the user, they should all have the same original stereo pair source. These files are usually generated using Socet Set and require some processing before they are passed into this program. In some cases, restrictions to the input file names are enforced. See the documentation for the DTM and ORTHOTOLIST parameters for details.
The table below indicates the requirements for program parameters under the indicated conditions.DEFAULTNAMES | Input file type | Required Parameters | Required PARAMSPVL Keywords |
---|---|---|---|
FALSE | Both DTM and ORTHOFROMLIST provided |
The following parameters are enabled:
|
|
DTM provided only |
The following parameters are enabled:
|
|
|
ORTHOFROMLIST provided only |
The following parameters are enabled:
|
|
|
TRUE | Both DTM and ORTHOFROMLIST provided |
The following parameters are enabled:
|
|
DTM provided only |
The following parameters are enabled:
|
|
|
ORTHOFROMLIST provided only |
The following parameters are enabled:
|
|
Categories
Related Objects and Documents
Applications
History
Mackenzie Boyd | 2011-05-13 | 0riginal Version. |
Tracie Sucharski | 2012-12-06 | Changed to use TProjection instead of Projection. References #775. |
Lynn Weller | 2012-01-22 | Application category name changed from Import and Export to Mars Reconnaissance Orbiter. Fixes mantis ticket #951. |
Jeannie Backer | 2013-09-11 | Modified the code to add SOURCE_PRODUCT_ID values individually when they are generated by the program. Otherwise, if the user enters a value for SOURCE_PRODUCT_ID as a string, they must include braces for array values. Fixed code to read the PRODUCT_VERSION_ID from the PARAMSPVL file if the user has not entered a value. Added PRODUCT_VERSION_ID value to params default file. Fixed spelling in error message and user documentation. Changed IString objects to QStrings. Brought code closer to ISIS coding standards. Improved code test coverage. Fixes ticket #757, #946. |
Jeannie Backer | 2015-10-02 | Backwards Compatibility Issue: The command line parameters were changed to generalize this program's capabilities, as requested by the HiRISE mission representatives. This will impact processing scripts/pipelines. Modified the program to be able to process any number of orthorectified input files. Also, a DTM is no longer a required input for this program. Updated the output file names and keyword values generated when DEFAULTNAMES=TRUE. The following parameters were added, removed, or replaced: 1. ORTHO1, ORTHO2, ORTHO3, and ORTHO4 replaced with ORTHOFROMLIST. 2. ORTHO1TO, ORTHO2TO, ORTHO3TO, and ORTHO4TO replaced with ORTHOTOLIST. 3. ORTHO1_PRODUCT_ID, ORTHO2_PRODUCT_ID, ORTHO3_PRODUCT_ID, and ORTHO4_PRODUCT_ID replaced with ORTHOPRODUCTIDLIST. 4. PRODUCER_FULL_NAME, RATIONALE_DESC, and PRODUCT_VERSION_ID removed since they are required in the PARAMSPVL input file. 5. ORTHOSEQUENCENUMBERLIST added to be able to generate default names for orthorectified files. Fixes ticket #801 |
Jeannie Backer | 2016-08-19 | Modified the code so that when DEFAULTNAMES=true, then SOURCE_PRODUCT_ID = (DTM_PRODUCT_ID, pSP_xxxxxx_xxxx) where pSP_xxxxxx_xxxx is the first 15 characters of the ortho product ID described in the documentation. References #801. |
Parameters
Output Options
This parameter is used for convenience so that output file names and PRODUCT_IDs do not need to be specified by the user. If this parameter is selected, then the parameters DTMTO, ORTHOTOLIST, DTM_PRODUCT_ID, and ORTHOPRODUCTIDLIST are disabled since the program will use the default output values for these. See the table in the main description of this program for specific requirements. If this parameter is selected, the names of the output files will match the corresponding PRODUCT_IDs (minus the file path and extension). The values for each PRODUCT_ID is generated using the name of the input cube, the corresponding sequence number (for orthorectified output images), and other cube attributes. For this reason, input orthorectified file names of a certain form are required. See the documentation for the ORTHOFROMLIST parameter for specifications. Also, certain keyword values are provided by the PARAMSPVL file. See the documentation for PARAMSPVL for specifications.
The output PRODUCT_IDs used when DEFAULTNAMES=TRUE are explained below. For DTMs files the form is DTems_xxxxxx_xxxx_xxxxxx_xxxx_vnn e is the code for the type of elevation data E for areoid elevations R for radii (hidtmgen does not currently support this option) m is the map projection code E for equirectangular P for polar stereographic s is the grid spacing (i.e. map scale) code A for 0.25 m B for 0.5 m C for 1.0 m D for 2.0 m etc. Z is used if no match is found, a 10% tolerance on the resolution value is used to catch values that are close. xxxxx_xxxx_yyyyy_yyyy is the orbit (five digit) number and target (four digit) codes for the stereo pairs used to create this DTM v is the code for the producing institution U for USGS A for University of Arizona C for CalTech N for NASA Ames J for JPL O for Ohio State Z for other nn is the 2 digit product version ID number For orthorectified image files, the form is pSP_xxxxxx_xxxx_ccc_s_nn_ORTHO p is the code for the mission phase E for Extended Science Phase P for Primary Science Phase xxxxxx_xxxx is the orbit number and target code for this ORTHO ccc is the color content code RED for visible RED, 1 band image IRB for 3 band enhanced color (IR, RED, BG) s is the grid spacing (i.e. map scale) code A for 0.25 m B for 0.5 m C for 1.0 m D for 2.0 m etc. Z is used if no match is found, a 10% tolerance on the resolution value is used to catch values that are close. nn is a sequence number to distinguish between orthorectified images from the same HiRISE observation that may be created from different DTMs. ORTHO indicates that the image has been orthorectified NOTE: The first 15 characters of the product ID pSP_xxxxxx_xxxx are taken directly from the first 15 characters of the input ortho file name.
Type | boolean |
---|---|
Default | TRUE |
Exclusions |
|
Inclusions |
|
Type | string |
---|---|
Default | ./ |
DTM Parameters
Type | cube |
---|---|
File Mode | input |
Internal Default | None |
Filter | *.cub |
Type | filename |
---|---|
File Mode | output |
Internal Default | Automatic |
Inclusions |
|
Filter | *.IMG |
Type | string |
---|---|
Internal Default | None |
Inclusions |
|
Orthorectified Cube Parameters
Type | filename |
---|---|
File Mode | input |
Internal Default | Automatic |
Filter | *.txt *.lis *.lst |
Type | filename |
---|---|
File Mode | input |
Internal Default | Automatic |
Inclusions |
|
Filter | *.txt *.lis *.lst |
Type | filename |
---|---|
File Mode | input |
Internal Default | Automatic |
Inclusions |
|
Filter | *.txt *.lis *.lst |
Type | filename |
---|---|
File Mode | input |
Internal Default | Automatic |
Inclusions |
|
Filter | *.txt *.lis *.lst |
Label Information
Keywords that are always required:
- DATA_SET_ID
- DATA_SET_NAME
- PRODUCER_INSTITUION_NAME
- PRODUCER_ID
- PRODUCER_FULL_NAME
- PRODUCING_INSTITUTION*
- PRODUCT_VERSION_ID**
- RATIONALE_DESC
- SOFTWARE_NAME
* The PRODUCING_INSTITUTION value must be a single character code: U for USGS A for University of Arizona C for CalTech N for NASA Ames J for JPL O for Ohio State Z for other ** The PRODUCT_VERSION_ID must be a real number (i.e. double precision) value. When DEFAULTNAMES=TRUE this number will be used to generate the 2 digit version ID code used as the last two digits of the output DTM's PRODUCT_ID. Case 1: If the number given is greater than 10, the first two digits will be used for the output code. Case 2: If it is of the form N.0 (where N is between 0 and 9), the output code will be 0N. Case 3: If it is of the form N.M (where N and M are between 0 and 9), the output code will be NM. Case 4: If it is less than 1.0, the output code will be 0N, where N is the first significant digit (i.e the first non-zero from the left). Note that except for the special case of N.0, the most significant digits are used.Keywords that are required under particular circumstances:
- DTM_SOURCE_PRODUCT_ID (required if DTM provided) *
- ORTHO_SOURCE_DTM_ID (required if DTM was not provided) **
* The DTM_SOURCE_PRODUCT_ID is an array that indicates the source of the input DTM. If the user enters a DTM, this value must be an array containing the PRODUCT_IDs of the stereo pair used to generate the DTM. ** The ORTHO_SOURCE_DTM_ID is the PRODUCT_ID of the DTM used to generate the given orthorectified input cubes.
Type | filename |
---|---|
Default | $ISISROOT/appdata/templates/hidtmgen/hidtmgenParamsTemplate.pvl |
Output Data Options
Type | string | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
Default | LSB | |||||||||
Option List: |
|
Type | boolean |
---|---|
Default | true |
Type | boolean |
---|---|
Default | false |
Type | boolean |
---|---|
Default | false |
Type | boolean |
---|---|
Default | false |
Type | boolean |
---|---|
Default | false |
- 8-bit (0=black, 255=white)
- 16-bit unsigned (0=black, 65535=white)
- 16-bit signed (-32767=black, 32768=white)
- 32-bit (1.17549435e-38=black, 3.40282347e+38=white)
Type | string | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Default | 32BIT | |||||||||||||||
Option List: |
|
- 8-bit (0=black, 255=white)
- 16-bit unsigned (0=black, 65535=white)
- 16-bit signed (-32767=black, 32768=white)
- 32-bit (1.17549435e-38=black, 3.40282347e+38=white)
Type | string | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Default | 8BIT | |||||||||||||||
Option List: |
|