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

pds2isis

Standard View | TOC | Home

Import PDS or ISIS2 image into ISIS cube format

Description
Categories
Groups
Examples
History

Description

This program converts a PDS or ISIS2 formatted file to an ISIS3 cube format. The standard PDS image is defined in the "FROM" parameter, and not the "IMAGE" parameter. If the PDS file has a detached label file and an image file, both are required to exist in the working directory. If the label is detached, the detached label filename is defined as the input file for the "FROM" parameter. The "IMAGE" parameter does not need to be defined, unless the program fails to find the image file specifed in the label file upon the program's execution. The default settings normally work for most PDS products, but occasionally the user may need to modify the default values in order to obtain an image that meets their specific requirements.

The incoming special pixel values in the PDS file are assigned equivalent values for special pixels in ISIS. The order of precedence for special pixels in ISIS from highest to lowest priority is the following:

  1. NULL
  2. HRS
  3. LRS
  4. HIS
  5. LIS
If any incoming pixel value falls within two different special pixel types, the special pixel with the higher priority is assigned. The user may also specify a range of pixel values to be assigned to the different special pixels. If the range of pixel values defined by the user for the different special pixels overlap, the special pixel with the highest priority is assigned. For example, if NULLMIN=0.0, NULLMAX=3.0, LISMIN=3.0, and LISMAX=5.0, the actual raw value 3.0 can be assigned as a NULL or LIS, but is translated to NULL because NULL has a higher priority than LIS.

It should be noted if any incoming pixel values are equal to one of the ISIS special pixel values for the corresponding bit type, those pixels will be special in the output cube. The special pixel values for each bit type can be found here. This is most commonly an issue with 8-bit data. If you are working with an 8-bit image and need either 0 or 255, either convert the data to 16-bit or use Stretch after ingestion.

The conversion of images from ISIS2 to ISIS3 follows the same rules as PDS images, except that the label information is propagated to the output file.

The best option to convert files from ISIS2 to ISIS is to maintain all the input file settings, and do not change the bit type or change any incoming pixel values to special pixels. When an ISIS2 Level1 image is imported into ISIS3, it is important to note the label information is not propagated from the ISIS2 to the ISIS cube file. For an ISIS2 Level2 image or mosaic file, a limited set of label information is transferred to the ISIS labels that include the "Instrument," "BandBin," and "Mapping" groups.

Categories

Parameter Groups

Files

Name Description
FROM Input PDS, PDS label, or ISIS2 file
IMAGE Detached image file
TO Output cube file

Special Pixels

Name Description
SETNULLRANGEOption to convert pixel values to NULL
NULLMIN Minimum value for NULL
NULLMAX Maximum value for NULL
SETHRSRANGEOption to convert pixel values to HRS
HRSMIN Minimum value for HRS
HRSMAX Maximum value for HRS
SETHISRANGEOption to convert pixel values to HIS
HISMIN Minimum value for HIS
HISMAX Maximum value for HIS
SETLRSRANGEOption to convert pixel values to LRS
LRSMIN Minimum value for LRS
LRSMAX Maximum value for LRS
SETLISRANGEOption to convert pixel values to LIS
LISMIN Minimum value for LIS
LISMAX Maximum value for LIS

Files: FROM

Description

Specify a PDS file, PDS label file, or ISIS2 cube file. If the input file is a PDS detached label file and the companion image file is not in the same directory, use the parameter "IMAGE" to define the location and filename of the image, otherwise just enter the label file name.

Type filename
File Mode input
Filter *.lbl *.img *.qub

Files: IMAGE

Description

Use this parameter if the pointer to the image data in the detached label file (FROM) is incorrrect.

Type filename
File Mode input
Internal Default Cube data embedded with label or file pointer in label file
Filter *.img

Files: TO

Description

Use this parameter to specify the output cube filename.

Type cube
File Mode output
Filter *.cub

Special Pixels: SETNULLRANGE

Description

If this option is set to "yes" or "true", a range of input raw pixels defined by the NULLMIN and NULLMAX parameters are converted to NULL pixels. All other valid pixels that do not fall within the ranges specified for LIS, LRS, HIS, and HRS pixels are transferred to the output file unchanged. If the bit type of the input file is changed, the NULL and HRS special pixels may be incorrectly set to valid pixel values. For example, if a raw 8-bit file is output to 16 or 32-bit, the pixel values "0" and "255" may be converted to actual values instead of retaining the special pixel property. If the output file remains as 8-bit, then "0" stays as NULL and "255" stays as HRS.

Type boolean
Default NO
Inclusions
  • NULLMIN
  • NULLMAX

Special Pixels: NULLMIN

Description

Minimum pixel value to set to NULL. All values greater than or equal to NULLMIN and less than or equal to NULLMAX are converted to NULL.

Type double
Inclusions
  • SETNULLRANGE

Special Pixels: NULLMAX

Description

Maximum pixel value to set to NULL. All values greater than or equal to NULLMIN and less than or equal to NULLMAX are converted to NULL.

Type double
Inclusions
  • SETNULLRANGE

Special Pixels: SETHRSRANGE

Description

If this option is set to "yes" or "true", a range of input raw pixels defined by the HRSMIN and HRSMAX parameters are converted to HRS pixels. All other valid pixels that do not fall within the ranges specified for LIS, LRS, HIS, and NULL pixels are transferred to the output file unchanged. If the bit type of the input file is changed, the NULL and HRS special pixels may be incorrectly set to valid pixel values. For example, if a raw 8-bit file is output to 16 or 32-bit, the pixel values "0" and "255" may be converted to actual values instead of retaining the special pixel property. If the output file remains as 8-bit, then "0" stays as NULL and "255" stays as HRS.

Type boolean
Default NO
Inclusions
  • HRSMIN
  • HRSMAX

Special Pixels: HRSMIN

Description

Minimum pixel value to set to HRS. All values greater than or equal to HRSMIN and less than or equal to HRSMAX are converted to HRS.

Type double
Inclusions
  • SETHRSRANGE

Special Pixels: HRSMAX

Description

Maximum pixel value to set to HRS. All values greater than or equal to HRSMIN and less than or equal to HRSMAX are converted to HRS.

Type double
Inclusions
  • SETHRSRANGE

Special Pixels: SETHISRANGE

Description

If this option is set to "yes" or "true", a range of input raw pixels defined by the HISMIN and HISMAX parameters are converted to HIS pixels. All other valid pixels that do not fall within the ranges specified for LIS, LRS, HRS, and NULL pixels are transferred to the output file unchanged.

Type boolean
Default NO
Inclusions
  • HISMIN
  • HISMAX

Special Pixels: HISMIN

Description

Minimum pixel value to set to HIS. All values greater than or equal to HISMIN and less than or equal to HISMAX are converted to HIS.

Type double
Inclusions
  • SETHISRANGE

Special Pixels: HISMAX

Description

Maximum pixel value to set to HIS. All values greater than or equal to HISMIN and less than or equal to HISMAX are converted to HIS.

Type double
Inclusions
  • SETHISRANGE

Special Pixels: SETLRSRANGE

Description

If this option is set to "yes" or "true", a range of input raw pixels defined by the LRSMIN and LRSMAX parameters are converted to LRS pixels. All other valid pixels that do not fall within the ranges specified for LIS, HIS, HRS, and NULL pixels are transferred to the output file unchanged.

Type boolean
Default NO
Inclusions
  • LRSMIN
  • LRSMAX

Special Pixels: LRSMIN

Description

Minimum pixel value to set to LRS. All values greater than or equal to LRSMIN and less than or equal to LRSMAX are converted to LRS.

Type double
Inclusions
  • SETLRSRANGE

Special Pixels: LRSMAX

Description

Maximum pixel value to set to LRS. All values greater than or equal to LRSMIN and less than or equal to LRSMAX are converted to LRS.

Type double
Inclusions
  • SETLRSRANGE

Special Pixels: SETLISRANGE

Description

If this option is set to "yes" or "true", a range of input raw pixels defined by the LISMIN and LISMAX parameters are converted to LIS pixels. All other valid pixels that do not fall within the ranges specified for LRS, HIS, HRS, and NULL pixels are transferred to the output file unchanged.

Type boolean
Default NO
Inclusions
  • LISMIN
  • LISMAX

Special Pixels: LISMIN

Description

Minimum pixel value to set to LIS. All values greater than or equal to LISMIN and less than or equal to LISMAX are converted to LIS.

Type double
Inclusions
  • SETLISRANGE

Special Pixels: LISMAX

Description

Maximum pixel value to set to LIS. All values greater than or equal to LISMIN and less than or equal to LISMAX are converted to LIS.

Type double
Inclusions
  • SETLISRANGE

Examples

Example 1

Convert PDS file to ISIS format with pds2isis

Description

The example ingests a PDS formatted file, and outputs an ISIS cube file using the default settings for the program.

Command Line

pds2isis from=input.img to=out.cub
This example shows the use of pds2isis to create an ISIS cube file.

GUI Screenshot

Pds2isis GUI

Example GUI

Screenshot shows the pds2isis GUI with the parameter settings.

Data File

The PDS formatted input file This is a PDS image with attached labels.

Output Image

The ISIS image cube after conversion

The ISIS output cube file

Parameter Name: TO

This screenshot displays the ouput of the pds2isis application.

History

Kris Becker1997-05-01 Original version.
Stuart Sides2003-05-15 Wrote for Isis 3.
Stuart Sides2003-05-16 Modified schema location from "astrogeology" to "isis.astrogeology."
Stuart Sides2003-06-04 Fixed Makefile.
Stuart Sides2003-10-10 Converted to use new IsisImport instead of IsisPdsImport.
Stuart Sides2004-02-20 Converted to use the new IsisImportPds class and added import labels to the output cube.
Brendan George2006-09-28 Documentation fixes.
Stuart Sides2007-01-25 Added ability to transfers Isis2 instrument and bandbin information.
Tracie Sucharski2007-04-10 Added LatitudeType2 group to translation table to handle CTX cubes. Additonal changes to projection translation tables for other possible values for Longitude direction, latitude type. If the min or max longitude values are greater than 180, change longitude domain to 360. Only call TranslateIsis2Labels if pds file is an Isis2 cube.
Steven Lambright2007-08-07 Added support for copying some PDS labels, if they exist, into the output.
Steven Koechle2007-08-29 Added special pixel ranges. Added examples.
Steven Lambright2008-05-13 Removed references to CubeInfo.
Christopher Austin2008-09-15 Fixed problem with special pixel range functionality and documentation. Added HIS and LIS range options.
Stuart Sides2012-08-08 Added translations for BAND_BIN_CENTER, BAND_BIN_WIDTH, and BAND_BIN_FILTER_NUMBER from NIMS RDR products fixes #1029.
Ella Mae Lee2012-11-09 Improve the documentation, document capability to import ISIS2 images, fixes #1172.
Kimberly Oyama2012-11-21 Added app tests for BIP and BIL formatted input. References #819.
Tyler Wilson2016-02-25 Added an app test for opening Galileo NIMS qubes saved in VAX format. Modified the filter tag on FROM parameter in this document to also recognize *.qub files. All changes relating to converting VAX to IEEE were made in ProcessImport, ProcessImportPds. References: #2368.
Summer Stapleton2017-06-27 Added conditional to check whether default offsets and multipliers where changed from their default values and log them if so.