ISIS Application Documentation
Generates PDS products from a DTM and/or orthorectified images.
Description
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:
- DTMTO (required)
- DTM_PRODUCT_ID (required)
- ORTHOTOLIST (required)
- ORTHOPRODUCTIDLIST (required)
- PARAMSPVL (required)
|
- DATA_SET_ID
- DATA_SET_NAME
- PRODUCER_INSTITUION_NAME
- PRODUCER_ID
- PRODUCER_FULL_NAME
- PRODUCING_INSTITUTION
- PRODUCT_VERSION_ID
- RATIONALE_DESC
- SOFTWARE_NAME
- DTM_SOURCE_PRODUCT_ID
|
DTM provided only |
The following parameters are enabled:
- DTMTO (required)
- DTM_PRODUCT_ID (required)
- PARAMSPVL (required)
|
- DATA_SET_ID
- DATA_SET_NAME
- PRODUCER_INSTITUION_NAME
- PRODUCER_ID
- PRODUCER_FULL_NAME
- PRODUCING_INSTITUTION
- PRODUCT_VERSION_ID
- RATIONALE_DESC
- SOFTWARE_NAME
- DTM_SOURCE_PRODUCT_ID
|
ORTHOFROMLIST provided only |
The following parameters are enabled:
- ORTHOTOLIST (required)
- ORTHOPRODUCTIDLIST (required)
- PARAMSPVL (required)
|
- DATA_SET_ID
- DATA_SET_NAME
- PRODUCER_INSTITUION_NAME
- PRODUCER_ID
- PRODUCER_FULL_NAME
- PRODUCING_INSTITUTION
- PRODUCT_VERSION_ID
- RATIONALE_DESC
- SOFTWARE_NAME
- ORTHO_SOURCE_DTM_ID
|
TRUE |
Both DTM and ORTHOFROMLIST provided |
The following parameters are enabled:
- OUTPUTDIR (optional - defaults to current working directory)
-
Ortho input file name requirements - each file must have orbit/target IDs for
itself, as described in the documentation for the ORTHOFROMLIST parameter.
- OUTPUTDIR (optional - defaults to current working directory)
- ORTHOSEQUENCENUMBERLIST (required)
- PARAMSPVL (required)
|
- DATA_SET_ID
- DATA_SET_NAME
- PRODUCER_INSTITUION_NAME
- PRODUCER_ID
- PRODUCER_FULL_NAME
- PRODUCING_INSTITUTION
- PRODUCT_VERSION_ID
- RATIONALE_DESC
- SOFTWARE_NAME
- DTM_SOURCE_PRODUCT_ID
|
DTM provided only |
The following parameters are enabled:
- OUTPUTDIR (optional - defaults to current working directory)
- PARAMSPVL (required)
|
- DATA_SET_ID
- DATA_SET_NAME
- PRODUCER_INSTITUION_NAME
- PRODUCER_ID
- PRODUCER_FULL_NAME
- PRODUCING_INSTITUTION
- PRODUCT_VERSION_ID
- RATIONALE_DESC
- SOFTWARE_NAME
- DTM_SOURCE_PRODUCT_ID
|
ORTHOFROMLIST provided only |
The following parameters are enabled:
-
File name requirements - input orthorectified file names must have orbit/target IDs for
itself, as described in the documentation for the ORTHOFROMLIST parameter.
- OUTPUTDIR (optional - defaults to current working directory)
- ORTHOSEQUENCENUMBERLIST (required)
- PARAMSPVL (required)
|
- DATA_SET_ID
- DATA_SET_NAME
- PRODUCER_INSTITUION_NAME
- PRODUCER_ID
- PRODUCER_FULL_NAME
- PRODUCING_INSTITUTION
- PRODUCT_VERSION_ID
- RATIONALE_DESC
- SOFTWARE_NAME
- ORTHO_SOURCE_DTM_ID
|
Categories
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.
|
|
Parameter Groups
Output Options
Name
|
Description
|
DEFAULTNAMES |
Indicates whether the program will generate the output file names and PRODUCT_IDs.
Input names must match expected form.
|
OUTPUTDIR |
Directory for output products.
|
DTM Parameters
Name
|
Description
|
DTM | The name of the input DTM file. |
DTMTO | DTM output file name. |
DTM_PRODUCT_ID | User specified ID for the output DTM product. |
Orthorectified Cube Parameters
Name
|
Description
|
ORTHOFROMLIST |
A list file names for input orthorectified cubes.
|
ORTHOTOLIST |
An ordered list of output file names for PDS products corresponding to the list of input orthorectified cubes.
|
ORTHOPRODUCTIDLIST |
An ordered list of user specified PRODUCT_ID values corresponding to each of the
orthorectified input images given in the ORTHOFROMLIST.
|
ORTHOSEQUENCENUMBERLIST |
An ordered list of user specified sequence numbers corresponding to each of the
orthorectified input images given in the ORTHOFROMLIST.
|
Label Information
Name
|
Description
|
PARAMSPVL |
PVL-formatted file containing required keyword values.
|
Output Data Options
Name
|
Description
|
ENDIAN | Endianness of the output bytes for all output files. |
NULL | Dedicates a DN value for null pixels in output DTM product. |
LRS | Dedicates a DN value for LRS pixels in output DTM product. |
LIS | Dedicates a DN value for LIS pixels in output DTM product. |
HIS | Dedicates a DN value for HIS pixels in output DTM product. |
HRS | Dedicates a DN value for HRS pixels in output DTM product. |
DTMBITTYPE | Bit type of output DTM file. |
ORTHOBITTYPE | Bit type of orthorectified output files. |
|
Output Options:
DEFAULTNAMES
Description
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
|
- DTMTO
- ORTHOTOLIST
- DTM_PRODUCT_ID
- ORTHOPRODUCTIDLIST
|
Inclusions
|
- OUTPUTDIR
- ORTHOSEQUENCENUMBERLIST
|
Output Options:
OUTPUTDIR
Description
The directory where output image files will be written. This parameter only applies when
DEFAULTNAMES=TRUE. The default is the current working directory.
DTM Parameters:
DTM
Description
The name of the DTM file to be exported. The given file must be an ISIS cube
whose label contains a mapping group. This DTM, usually created using Socet Set, must be
generated from a stereo pair of MRO HiRISE images. The user may specify the corresponding
output file name using the DTMTO parameter. Otherwise, the output file name can
be generated by hidtmgen by setting DEFAULTNAMES=TRUE.
Note: DTM is not a required parameter. The user may choose to only export a list
orthorectified images.
Type
| cube |
File Mode
| input |
Internal Default
| None |
Filter
|
*.cub
|
DTM Parameters:
DTMTO
Description
The name of the exported DTM file.
This parameter is required when DTM has been provided and DEFAULTNAMES=FALSE.
Type
| filename |
File Mode
| output |
Internal Default
| Automatic |
Inclusions
|
|
Filter
| *.IMG |
DTM Parameters:
DTM_PRODUCT_ID
Description
The PRODUCT_ID for the output DTM product.
This parameter is required when DTM has been provided and DEFAULTNAMES=FALSE.
Type
| string |
Internal Default
| None |
Inclusions
|
|
Orthorectified Cube Parameters:
ORTHOFROMLIST
Description
A list of orthorectified images to be exported. The given files in this list must be ISIS
cubes from the MRO HiRISE camera that have been orthorectified to the input DTM, if
provided. The user may specify the corresponding output file names using the ORTHOTOLIST
parameter. Otherwise, these output file names can be generated by hidtmgen by setting
DEFAULTNAMES=TRUE. In this case, the name of each input image file in this list must
begin with the prefix pSP_######_####_ where p is the code for the mission phase and
the #'s represent the orbit number followed by the target code for this image.
Type
| filename |
File Mode
| input |
Internal Default
| Automatic |
Filter
|
*.txt *.lis *.lst
|
Orthorectified Cube Parameters:
ORTHOTOLIST
Description
An ordered list of output PDS file names. It is expected that the order of the file
names in this list will correspond to the orthorectified cubes in the ORTHOFROMLIST.
Each file in this list should have a full path to the output location where the PDS
file will be created.
Note that the DEFAULTNAMES and OUTPUTDIR options may be
selected instead of ORTHOTOLIST if the user prefers to specify only the location of the
output PDS files (and not the file names).
This parameter is required when ORTHOFROMLIST has been provided and DEFAULTNAMES=FALSE.
Type
| filename |
File Mode
| input |
Internal Default
| Automatic |
Inclusions
|
|
Filter
|
*.txt *.lis *.lst
|
Orthorectified Cube Parameters:
ORTHOPRODUCTIDLIST
Description
An ordered list of strings representing the PRODUCT_ID values that correspond to each of the
input orthorectified images given in the ORTHOFROMLIST. This parameter is required when
ORTHOFROMLIST has been provided and DEFAULTNAMES=FALSE.
Type
| filename |
File Mode
| input |
Internal Default
| Automatic |
Inclusions
|
|
Filter
|
*.txt *.lis *.lst
|
Orthorectified Cube Parameters:
ORTHOSEQUENCENUMBERLIST
Description
An ordered list of two digit sequence numbers that correspond to each of the input images
given in the ORTHOFROMLIST. These sequence numbers are used to distinguish between
orthorectified images from the same HiRISE observation that may be created from different
DTMs. This parameter is required when ORTHOFROMLIST has been provided and
DEFAULTNAMES=TRUE.
Type
| filename |
File Mode
| input |
Internal Default
| Automatic |
Inclusions
|
|
Filter
|
*.txt *.lis *.lst
|
Output Data Options:
ENDIAN
Description
This parameter is used to select the output data storage order. The output can be
streamed starting with the most significant byte (MSB) or starting
with the least significant bytes (LSB). The choice should be made by
the user depending upon the format read by the system architecture
from which they plan to read the raw data.
Type
| string |
Default
|
LSB
|
Option List:
|
Option |
Brief |
Description |
LSB | Least significant byte. |
The least significant byte will be the first byte output.
|
MSB | Most significant byte. |
The most significant byte will be the first byte output.
|
|
Output Data Options:
NULL
Description
If set to true, the minimum value of the raw output data will be
reserved for null pixels. The actual value used for null pixels will
be denoted in the print.prt file as well as displayed onscreen.
Type
| boolean |
Default
| true |
Output Data Options:
LRS
Description
If set to true, then an output DN value is set aside for the LRS input pixels.
The actual DN value used for LRS pixels will be denoted in the print.prt
file as well as displayed onscreen.
Type
| boolean |
Default
| false |
Output Data Options:
LIS
Description
If set to true, then an output DN value is set aside for the LIS input pixels.
The actual DN value used for LIS pixels will be denoted in the print.prt
file as well as displayed onscreen.
Type
| boolean |
Default
| false |
Output Data Options:
HIS
Description
If set to true, then an output DN value is set aside for the HIS input pixels.
The actual DN value used for HIS pixels will be denoted in the print.prt
file as well as displayed onscreen.
Type
| boolean |
Default
| false |
Output Data Options:
HRS
Description
If set to true, then an output DN value is set aside for the HRS input pixels.
The actual DN value used for HRS pixels will be denoted in the print.prt
file as well as displayed onscreen.
Type
| boolean |
Default
| false |
Output Data Options:
DTMBITTYPE
Description
Bit type of output:
- 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:
|
Option |
Brief |
Description |
8BIT | Output 8-bit data in DTM product. |
Pixels are in 8-bit data range (0 to 255).
|
U16BIT | Output 16-bit unsigned data in DTM product. |
Pixels are in the 16-bit data range (0 to 65535).
|
S16BIT | Output 16-bit signed data in DTM product. |
Pixels are in 16-bit signed data range (-32768 to 32767).
|
32BIT | Output 32-bit data in DTM product. |
Pixels are in the 32-bit floating point data range
(-3.40282347e+38 to 3.40282347e+38).
|
|
Output Data Options:
ORTHOBITTYPE
Description
Bit type of output:
- 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:
|
Option |
Brief |
Description |
8BIT | Output 8-bit data in orthorectified PDS products. |
Pixels are in 8-bit data range (0 to 255).
|
U16BIT | Output 16-bit unsigned data in orthorectified PDS products. |
Pixels are in the 16-bit data range (0 to 65535).
|
S16BIT | Output 16-bit signed data in orthorectified PDS products. |
Pixels are in 16-bit signed data range (-32768 to 32767).
|
32BIT | Output 32-bit data in orthorectified PDS products. |
Pixels are in the 32-bit floating point data range
(-3.40282347e+38 to 3.40282347e+38).
|
|