Home

Quick Links

Software Manual
GitHub
API Reference

Documentation Versions

Public Release
8.3.0
8.2.0
8.1.0
8.0.0
7.2.0
7.1.0
7.0.0
6.0.0
3.9.0
3.5.0
USGS

ISIS Application Documentation


isis2pds

Standard View | TOC | Home

Convert from ISIS cube to PDS 3 or PDS 4 format

Description
Categories
Groups
Examples
History


Description

Program to convert cubes to PDS3 or PDS4 image files. For PDS4, If available, Instrument and Mapping information will be written to the detached output PDS4 formatted xml label file.

Not all values in the generated PDS4 labels can be determined automatically by ISIS3, and some must be updated by the user (by opening up the xml label output by this application and editing it with a text editor) for the generated label to be PDS4 compliant. The values UNK (unknown) and TBD (to be determined) are used as placeholders in the generated label. TBD values must be replaced by the user for the output label to be PDS4 compliant. Some of these TBDs can only be replaced with one of several specific enumerated values to meet compliancy. These possible values can be found in the PDS 4 Information Model Specification in the Value/Class column of the table for the associated tag or in the index at the end of the document. Searching this page for the name of the field you need to determine a value for is recommended.

For example: For a cube with map-projected data, ISIS will populate planar_coordinate encoding_method with a value on its own, but if it did not and instead had "TBD", we would find at planar_coordinate_coding_method that there are 3 possible values: 'Coordinate Pair', 'Distance and Bearing', 'Row and Column'.

Not everything is in the PDS 4 Information Model Specification at this time, so if the information about a tag is not in there, it may be necessary to find the options in the appropriate schematron file (.sch) available at: PDS4 Released Schema. For the previous example, the same information can be found in the PDS4 Cartography schematron file .

UNK is used as a placeholder if any value can be used and still be a valid PDS4-formatted xml header. UNKs can, but are not required to be, replaced by the user with better information.


Categories


Parameter Groups

Files

Name Description
FROM Input cube to be converted
TO Output pds image

PDS Format Version

Name Description
PDSVERSIONVersion of PDS to output

Output Settings

Name Description
LABTYPELabel type of output file
BITTYPEBit 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.
CHECKSUMGenerates and attaches an MD5 checksum to the labels.

Stretch Options

Name Description
STRETCHType of stretch
MINIMUMMinimum pixel value
MAXIMUMMaximum pixel value
MINPERCENTMinimum Percent
MAXPERCENTMaximum Percent

Output Data Storage Order

Name Description
ENDIANEndianness of the output bytes

Files: FROM

Description

The cube to be converted to pds format.

Type cube
File Mode input
Filter *.cub

Files: TO

Description

The resulting pds file. For PDS4, a detached label of the same name with the file extension .xml will be created in the same directory.

Type filename
File Mode output
Filter *.img

PDS Format Version: PDSVERSION

Description

Changes which version of PDS file format to output in.

Type string
Default PDS3
Option List:
Option Brief Description
PDS3Convert ISIS cube to PDS3 format Convert ISIS cube to PDS3 format.
PDS4Convert ISIS cube to PDS4 format Convert ISIS cube to PDS4 format.

Exclusions

  • LABTYPE
  • CHECKSUM

Output Settings: LABTYPE

Description

Changes the type of pds label exported.

Type string
Default STREAM
Option List:
Option Brief Description
STREAMStreams labels dynamically ISIS default, streams the pds labels out to take up as few bytes as possible.
FIXEDExports fixed labels Exports the pds labels in a fixed label format. This fixed size is derived from the number of bytes in each line of the exported cube.

Output Settings: BITTYPE

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).

Exclusions

  • ENDIAN
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)

Exclusions

  • STRETCH
  • MINPERCENT
  • MAXPERCENT
  • NULL
  • LRS
  • LIS
  • HIS
  • HRS

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

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

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

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

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

Output Settings: CHECKSUM

Description

If set to true, then an MD5 checksum will be generated from the image data and attached to the output image labels.

Type boolean
Default false

Stretch Options: STRETCH

Description

This parameter is used to select one of three ways to stretch (or map) the input pixels. They are NONE, LINEAR, or MANUAL.

Type string
Default NONE
Option List:
Option Brief Description
NONE No stretch No stretch is performed.

Exclusions

  • MINIMUM
  • MAXIMUM
  • MINPERCENT
  • MAXPERCENT
LINEAR Linear stretch A minimum and maximum are automatically computed based on the statistics of the selected input band. A histogram of the band is used to pick the minimum at 0.5% of the data and the maximum at 99.5% of the data. Input pixels less than or equal to the minimum are stretched to black while pixels greater than the or equal to the maximum are stretched to white. A linear mapping occurs between the minimum and maximum.

Exclusions

  • MINIMUM
  • MAXIMUM
MANUAL Manual stretch This option allows you to pick your own stretch. You must enter a value for MINIMUM and MAXIMUM input pixel.

Exclusions

  • MINPERCENT
  • MAXPERCENT

Inclusions

  • MINIMUM
  • MAXIMUM

Stretch Options: MINIMUM

Description

The minimum input pixel value which will be mapped to black.

Type double
Less Than
  • MAXIMUM

Stretch Options: MAXIMUM

Description

The maximum input pixel value which will be mapped to white.

Type double
Greater Than
  • MINIMUM

Stretch Options: MINPERCENT

Description

The percentage of data in the histogram used to compute the minimum pixel value in the stretch.

Type double
Default 0.5
Less Than
  • MAXPERCENT

Stretch Options: MAXPERCENT

Description

The percentage of data in the histogram used to compute the maximum pixel value in the stretch.

Type double
Default 99.5
Greater Than
  • MINPERCENT

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.

Examples


Example 1

convert cube to pds format

Description

Converting a cube to a pds format image.

Command Line

isis2pds from=ab102401.lev2.cub to=ab102401.lev2.img
In this example isis2pds will convert a cube to a pds format image.

GUI Screenshot

isis2pds GUI

Example GUI

Screenshot of GUI with FROM and TO files selected.

Input Image

Input Image

Input cube image

Parameter Name: FROM

This is the input cube for the example of isis2pds.

Output Image

Output pds Image

Output pds image

Parameter Name: TO

This is the exact same image with exact same DNs, but in the pds format.


History

Noah Hilt2008-05-20 Original version
Christopher Austin2008-08-07 Added the Label Type capability (param)
Kristin Berry2014-06-06 Changed to assume that radii without units in the input Isis cube are in meters, map scales without units are in meters/pixel, and map resolutions without units are in pixels/degree.
Makayla Shepherd and Ian Humphrey2017-05-17 Added CHECKSUM parameter to optionally generate and attach an MD5 checksum to the exported image label. This checksum is generated from the image data. Fixes #1013.
Jeannie Backer, Mayayla Shepard, and Kristin Berry2017-10-27 Added PDS4 output option. Previously, this application converted ISIS cubes to PDS3 format only.
Jeannie Backer2017-11-13 Updated to attach *.img extension to pds4 output data file.
Kristin Berry2017-11-26 Updated with very basic documentation about the PDS4 output labels.