Home

User Documentation

Getting Started
Learn More
Explore in Detail
Get Inspired

Contributor Documentation

Getting Started
Learn More
Explore in Detail
Get Inspired

Quick Links

Software Manual
AstroDiscuss
GitHub
API Reference

Documentation Versions

ISIS 2

Documentation
Tutorials
Technical Documents
USGS

ISIS Application Documentation

hirdrgen

Standard View | TOC | Home

Converts HiRISE RDR cubes into PDS standard format

Description
Categories
Groups
History

Description

Takes an input Isis cube with HiRISE RDR specific labels, and outputs a PDS compatible file. The DN values are NOT assumed to be between 0.0 and 1.0. All DN values between MINPER and MAXPER will be stretched to an unsigned integer with a size equal to the number of bits specified by BITS, excluding the special pixels.

NOTE: This program does not generate the final PDS HiRISE product. The output from this program is converted to a JPEG 2000 in the HiRISE pipeline processing.

For NBITS=8, two values are reserved for special pixels. For NBITS=9 through 16, five values are reserved for special pixels.

RDR special pixel mapping
Special Pixel 8 Bit Output Value 9-16 Bit Output Value
NULL 0 0
LRS 0 1
LIS 0 2
HIS 255 (2**BITS)-2
HRS 255 (2**BITS)-1

Categories

Parameter Groups

Files

Name Description
FROM The input cube
TO The ouput file

Stretch

Name Description
TYPE Select the type of stretch
MIN Lower bound of the stretch
MAX Upper bound of the stretch
MINPER Minimum DN valid percentage
MAXPER Mazimum DN valid percentage

Output Controls

Name Description
BITS Number of bits for the output DN
ENCODING_TYPE Determine if data is to be encoded as JPEG2000

Special Keyword

Name Description
VERSION Value for the output PDS keyword PRODUCT_VERSION_ID
RATIONALE_DESC Value for the output PDS keyword RATIONALE_DESC

Files: FROM

Description

This is the Isis cube to be exported to PDS format. All bands of the cube will be exported to the PDS file.

Type cube
File Mode input
Filter *.cub

Files: TO

Description

This is the destination file, where the input cube data will be written in PDS format. This file will have unsigned 16 bit DN values in the PDS IMAGE object no matter what type the input file is. All valid data from the input cube will be converted to unsigned, 16 bit, most significant byte first (Big Endian).

Type filename
File Mode output

Stretch: TYPE

Description

This parameter is used to select one of two ways to stretch output pixels. The are AUTOMATIC or MANUAL.

Type string
Default AUTOMATIC
Option List:
Option Brief Description
AUTOMATICAutomatically calculate stretchAutomatically calculate stretch

Exclusions

  • MIN
  • MAX
MANUALUser defined stretchUser defined stretch

Exclusions

  • MINPER
  • MAXPER

Stretch: MIN

Description

Lower bound for the manually specified stretch.

Type double

Stretch: MAX

Description

Upper bound for the manually specified stretch.

Type double

Stretch: MINPER

Description

The cumulative percentage value to be mapped to the minimum valid pixel for the specified number of bits. For example: With BITS=10 and MINPER=1.0, the DN which corresponds to the cummulative percent of 1.0 will be mapped to 3, where 0 represents NULL, 1 represents LRS and 2 represents LIS.

Type double
Default 0.0
Minimum 0.0 (inclusive)
Maximum 100.0 (inclusive)
Less Than or Equal
  • MAXPER

Stretch: MAXPER

Description

The cumulative percentage value to be mapped to the maximum valid pixel for the specified number of bits. For example: With BITS=10 and MINPER=99.0, the DN which corresponds to the cummulative percent of 99.0 will be mapped to 1021, 1021=(2**bits)-1-2. Where 1023 represents HIS and 1022 represents HRS.

Type double
Default 100.0
Minimum 0.0 (inclusive)
Maximum 100.0 (inclusive)
Greater Than or Equal
  • MINPER

Output Controls: BITS

Description

The number of bits to compress the input data to. The valid data as well as the five special pixel values (NULL, LIS, LRS, HIS, HRS) will be compressed into this number of bits. The output data type will be automaticity choosen using this value. A value of 8 will create unsigned byte output files. Values from 9 to 16 will create unsigned word output files. Unused bits in the unsigned word output file will be set to zero.

Type integer
Default 10
Minimum 8 (inclusive)
Maximum 16 (inclusive)

Output Controls: ENCODING_TYPE

Description

This parameter is used to determine if the output data will encoded using JPEG2000. The options are NONE or JP2.

Type string
Default NONE
Option List:
Option Brief Description
NONENo encoding is performedNo encoding is performed
JP2Encode as JPEG2000The data is encoded as JPEG2000

Special Keyword: VERSION

Description

This parameter allows the user to specify the value of the standard PDS keyword PRODUCT_VERSION_ID within the output PDS label. This keyword will be located in the Root of the PDS PVL label.

Type string
Default 1.0

Special Keyword: RATIONALE_DESC

Description

This parameter allows the user to specify the value of the standard PDS keyword RATIONALE_DESC within the output PDS label. This keyword will be located in the Root of the PDS PVL label.

Type string
Internal Default Preserve Original Rationale Description

History

Stuart Sides2006-09-11 Original Version
Stuart Sides2006-12-14 Modified labels to meet PDS standards and add new keywords.
Stuart Sides2007-01-10 Modified to output 8-bit products.
Stuart Sides2007-02-21 Modified with new keywords (NBITS, MINPER, MAXPER). Remove the OUTTYPE keyword. It is now infered by NBITS.
Kris Becker2007-07-24 Modified to convert FILTER_NAME from BLUEGREEN to BLUE-GREEN and NEARINFRARED to NEAR-INFRARED to comply with PDS.
Steven Koechle2007-12-07 Added parameters to allow for a user specified manual stretch.
Steven Lambright2008-05-13 Removed references to CubeInfo
Stuart Sides2008-06-06 Changed output keyword PRODUCT_VERSION_ID from an automatic translation to a user input parameter
Steven Lambright2008-07-10 Added Rationale Description option
Janet Barrett2010-02-17 Added ability to write output file in JPEG2000 format.
Christopher Austin2010-03-01 Fixed an error which misplaced the proper SCALING_FACTOR and OFFSET keyword values.
Jeannie Backer2012-11-21 Changed bandwidth units from nm to NM. Fixed bug so that the program no uses the default MAXPER=100 value correctly. References #678 PROG: [Changed ProcessExportPds::SetDetached() method call to correct spelling. Added g_ to global variables to meet Isis standards.]
Tracie Sucharski2012-12-06 Changed to use TProjection instead of Projection. References #775
Tracie Sucharski2012-12-06 Changed to use TProjection instead of Projection. References #775