Home
About ISIS
Support
Download

ISIS 3

Documentation
Tutorials
Technical Documents

ISIS 2

Documentation
Tutorials
Technical Documents

Search
USGS

ISIS 3 Application Documentation

hidtmgen

Printer Friendly View | TOC | Home

Generate PDS products from a DTM and four orthographic images.

Overview Parameters

Description

This application is designed to take a DTM and four orthographic images and produce a set PDS products. The two things accomplished by this program are exporting to the PDS format, and modifying the labels to included extra information and to be formatted correctly. The expected files are generally from Socet Set and require some processing before being ready to be exported.

Categories

Related Objects and Documents

Applications

History

Mackenzie Boyd2011-05-13 0riginal Version
Tracie Sucharski2012-12-06 Changed to use TProjection instead of Projection. References #775
Lynn Weller2012-01-22 Application category name changed from Import and Export to Mars Reconnaissance Orbiter. Fixes mantis ticket #951.
Jeannie Backer2013-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.

Parameter Groups

Files

Name Description
DTMThe name of the DTM
ORTHO1First of four orthographic images
ORTHO2Second of four orthographic images
ORTHO3Third of four orthographic images
ORTHO4Last of four orthographic images
DEFAULTNAMES Input names match expected form
OUTPUTDIR Directory for output products
DTMTODTM output filename
ORTHO1TOORTHO1 output filename
ORTHO2TOORTHO2 output filename
ORTHO3TOORTHO3 output filename
ORTHO4TOORTHO4 output filename

Producer and Data Set information

Name Description
PARAMSPVL Pvl formatted file with necessary parameters
PRODUCER_FULL_NAMEName of producer
RATIONALE_DESC The rationale description
PRODUCT_VERSION_ID Version number of the product
DTM_PRODUCT_IDId of the product
ORTHO1_PRODUCT_IDId of the product
ORTHO2_PRODUCT_IDId of the product
ORTHO3_PRODUCT_IDId of the product
ORTHO4_PRODUCT_IDId of the product
SOURCE_PRODUCT_ID Names of source products

DTM Output Settings

Name Description
DTMBITTYPEBit type of output file
NULLDedicates the minimum DN value for null pixels.
LRSDedicates a DN value for LRS pixels.
LISDedicates a DN value for LIS pixels.
HISDedicates a DN value for HIS pixels.
HRSDedicates a DN value for HRS pixels.

Ortho Output Settings

Name Description
ORTHOBITTYPEBit type of output file
ONULLDedicates the minimum DN value for null pixels.
OLRSDedicates a DN value for LRS pixels.
OLISDedicates a DN value for LIS pixels.
OHISDedicates a DN value for HIS pixels.
OHRSDedicates a DN value for HRS pixels.

Output Data Storage Order

Name Description
ENDIANEndianness of the output bytes
X

Files: DTM

Description

This is the name of the DTM from Socet Set. It must contain labels with a mapping group, there are no expectations as to the formatting of its name.

Type cube
File Mode input
Filter *.cub
Close Window
X

Files: ORTHO1

Description

This is one of the four orthographic images. It is expected that the matching cube of a different resolution will be under ORTHO2. If using DEFAULTNAMES=TRUE, the default, the name should be of the form AAA_######_####_... where AAA is letters, e.g. PSP, and the #s are numbers.

Type cube
File Mode input
Filter *.cub
Close Window
X

Files: ORTHO2

Description

This is one of the four orthographic images. It is expected that the matching cube of a different resolution will be under ORTHO1. If using DEFAULTNAMES=TRUE, the default, the name should be of the form AAA_######_####_... where AAA is letters, e.g. PSP, and the #s are numbers.

Type cube
File Mode input
Filter *.cub
Close Window
X

Files: ORTHO3

Description

This is one of the four orthographic images. It is expected that the matching cube of a different resolution will be under ORTHO4. If using DEFAULTNAMES=TRUE, the default, the name should be of the form AAA_######_####_... where AAA is letters, e.g. PSP, and the #s are numbers.

Type cube
File Mode input
Filter *.cub
Close Window
X

Files: ORTHO4

Description

This is one of the four orthographic images. It is expected that the matching cube of a different resolution will be under ORTHO3. If using DEFAULTNAMES=TRUE, the default, the name should be of the form AAA_######_####_... where AAA is letters, e.g. PSP, and the #s are numbers.

Type cube
File Mode input
Filter *.cub
Close Window
X

Files: DEFAULTNAMES

Description

For convenience names of a certian form may be used so that output filenames do not need to be specified. If true/checked, no output filenames are required, and filenames will be built from input names and other cube attributes. Input filenames of a certain form are required if true, see ORTHO 1-4 and DTM parameters for more details. If false, output filenames must be specified as well as a few other values, and no assumptions are made about the input filenames. 

 
          The output filenames used when true are as follows. For all files, the 
          form is aabcd_xxxxxx_xxxx_yyyyyy_yyyy_Vnn, where aa = DT, indicating 
          it's a DTM product
            b = type of data 
              E = areoid elevations 
              R = radii
              1 = orthoimage pixels from first image
              2 = orthoimage pixels from second image 
            c = projection (others are possible but these are the important 
              ones) 
              E = Equirectangular
              P = Polar Stereographic
            d = grid spacing
              A = 0.25 m 
              B = 0.5 m 
              C = 1.0 m 
              etc. 
              Z is used if no match is found, a 10% tolerance on the resolution 
              is value is used to catch values that are close. 
            xxxxxx_xxxx = orbit number and bin from ORTHO1 and ORTHO2.
            yyyyyy_yyyy = orbit number and bin from ORTHO3 and ORTHO4. 
            V = letter indicating producing institution 
              U = USGS 
              A = University of Arizona 
              C = CalTech 
              N = NASA Ames 
              J = JPL 
              O = Ohio State 
              Z = other 
            nn = 2 digit version number

Type boolean
Default TRUE
Exclusions
  • DTMTO
  • ORTHO1TO
  • ORTHO2TO
  • ORTHO3TO
  • ORTHO4TO
  • SOURCE_PRODUCT_ID
  • DTM_PRODUCT_ID
  • ORTHO1_PRODUCT_ID
  • ORTHO2_PRODUCT_ID
  • ORTHO3_PRODUCT_ID
  • ORTHO4_PRODUCT_ID
Inclusions
  • OUTPUTDIR
Close Window
X

Files: OUTPUTDIR

Description

The directory for all output products to go to. Only applies when DEFAULTNAMES is true.

Type string
Default ./
Close Window
X

Files: DTMTO

Description

The file for the DTM to be exported to.

Type filename
File Mode output
Filter *.IMG
Close Window
X

Files: ORTHO1TO

Description

The file for the first orthoimage to be exported to.

Type filename
File Mode output
Filter *.IMG
Close Window
X

Files: ORTHO2TO

Description

The file for the second orthoimage to be exported to.

Type filename
File Mode output
Filter *.IMG
Close Window
X

Files: ORTHO3TO

Description

The file for the third orthoimage to be exported to.

Type filename
File Mode output
Filter *.IMG
Close Window
X

Files: ORTHO4TO

Description

The file for the fourth orthoimage to be exported to.

Type filename
File Mode output
Filter *.IMG
Close Window
X

Producer and Data Set information: PARAMSPVL

Description

This should be a pvl formatted file that contains the following required keywords:

Type filename
Default $mro/templates/labels/hidtmgenDefaults.pvl
Close Window
X

Producer and Data Set information: PRODUCER_FULL_NAME

Description

The full name(s) of the producer(s).

Type string
Default From parameters pvl file
Close Window
X

Producer and Data Set information: RATIONALE_DESC

Description

A text description of the rationale, it is used in the identificaiton information in the labels.

Type string
Close Window
X

Producer and Data Set information: PRODUCT_VERSION_ID

Description

Version number of the product, any number is acceptable. This is used in creating output names if DEFAULTNAMES is true/checked. If so, the number will be used as follows when being put into the output names: if greater than 10, the first two digits will be used, if #.0, the number will be 0#, if #.#, the number will be ##, if less than 1.0, the decimal point will be removed and the number will be: if 0.#, 0#, or, if 0.0#, 0#. Except for the special case of #.0, the most significant digits are used.

Type double
Default 1.0
Close Window
X

Producer and Data Set information: DTM_PRODUCT_ID

Description

Id for the product image. When using default names, this is the same as the output name.

Type string
Close Window
X

Producer and Data Set information: ORTHO1_PRODUCT_ID

Description

Id for the product image. When using default names, this is the same as the output name.

Type string
Close Window
X

Producer and Data Set information: ORTHO2_PRODUCT_ID

Description

Id for the product image. When using default names, this is the same as the output name.

Type string
Close Window
X

Producer and Data Set information: ORTHO3_PRODUCT_ID

Description

Id for the product image. When using default names, this is the same as the output name.

Type string
Close Window
X

Producer and Data Set information: ORTHO4_PRODUCT_ID

Description

Id for the product image. When using default names, this is the same as the output name.

Type string
Close Window
X

Producer and Data Set information: SOURCE_PRODUCT_ID

Description

The names of the source product files. If DEFAULTNAMES is checked, this will be of the form (######_####,######_####), where the numbers come from ortho1 and ortho3 filenames. Otherwise, this can be any string. Only used in the labels of the output files.

Type string
Close Window
X

DTM Output Settings: 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
8BIT8 bit data Pixels are in 8-bit data range (0 to 255).
U16BIT 16 bit unsigned data Pixels are in the 16-bit data range (0 to 65535)
S16BIT 16 bit signed data Pixels are in 16 bit signed data range (-32768 to 32767)
32BIT 32 bit data Pixels are in the 32 bit floating point data range (-3.40282347e+38 to 3.40282347e+38)
Close Window
X

DTM Output Settings: 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
Close Window
X

DTM Output Settings: 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
Close Window
X

DTM Output Settings: 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
Close Window
X

DTM Output Settings: 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
Close Window
X

DTM Output Settings: 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
Close Window
X

Ortho Output Settings: 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
8BIT8 bit data Pixels are in 8-bit data range (0 to 255).
U16BIT 16 bit unsigned data Pixels are in the 16-bit data range (0 to 65535)
S16BIT 16 bit signed data Pixels are in 16 bit signed data range (-32768 to 32767)
32BIT 32 bit data Pixels are in the 32 bit floating point data range (-3.40282347e+38 to 3.40282347e+38)
Close Window
X

Ortho Output Settings: ONULL

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
Close Window
X

Ortho Output Settings: OLRS

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
Close Window
X

Ortho Output Settings: OLIS

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
Close Window
X

Ortho Output Settings: OHIS

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
Close Window
X

Ortho Output Settings: OHRS

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
Close Window
X

Output Data Storage Order: ENDIAN

Description

This parameter is used to select one whether the output will 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
LSBLeast significant byte The least significant byte will be the first byte output.
MSBMost significant byte The most significant byte will be the first byte output.
Close Window