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

kaguyami2isis

Standard View | TOC | Home

Import PDS formatted Kaguya Multiband Imager (MI) image into Isis format

Description
Categories
Groups
History

Description

This program will import a PDS formatted Kaguya MI VIS and NIR level 1 (EDR) or level 2B2 image into an Isis cube.

The user is given the option to specify incoming special pixel values in the PDS file so that they can be 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. The conversion of images from ISIS2 to ISIS follows the same rules as PDS images, except that the label information is propagated to the output file.

The user should note that the Kaguya MI data files will most likely contain a SCALING_FACTOR that is not equal to 1.0. The SCALING_FACTOR is used to scale the pixel values in the PDS file before they are imported to the ISIS file. Before the scaling is done on the pixel values, the special pixel conversions will be applied first. After the special pixel conversions are done, then the scaling factor is applied to those pixels that don't have special pixel values. As a result, you may get results that you weren't expecting.

Categories

Parameter Groups

Files

Name Description
FROM Input PDS formatted Kaguya MI VIS or NIR file
TO Output Isis cube

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

Use this parameter to select the Kaguya MI VIS or NIR level 1 or level 2B2 filename. This file must contain the PDS labels.

Type filename
File Mode input
Filter *.img *.IMG *.lbl *.LBL

Files: TO

Description

Use this parameter to select the output 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

History

Janet Barrett2011-05-09 Original version
Janet Barrett2012-05-02 At this time, there is no camera model for the Kaguya MI data. In order to be able to perform photometry on the Kaguya MI data, the SubSolarLongitude and SubSolarLatitude information needed to be calculated. These calculations are done by using the aaplus library developed by P J Naughter at http://www.naughter.com. This library can only be distributed in binary form, so it has to stay in the local directory of ISIS where it will not be distributed. The formulae used to do the calculations were taken from Meeus "Astronomical Algorithms" (1st Ed). This code can be removed as soon as a camera model is available for the Kaguya MI camera. The start and stop times for these images are very close, so the start time is used to calculate the SubSolar lat/lon information.
Lynn Weller2012-01-23 Application category name changed from Import and Export to Kaguya. Fixes mantis ticket #951.
Janet Barrett2013-06-13 Fixed code so that it sets the NaifFrameCode appropriately according to the base band specified in the labels. Fixes mantis tickets #1167 and #1680.
Janet Barrett2014-02-10 Added parameters (SETNULLRANGE, SETHRSRANGE, SETHISRANGE, ETLRSRANGE, SETLISRANGE) to allow the user to specify special pixel values. Fixes #2033.
Adam Paqeutte2016-08-04 Added a new error message informing the user that the file they are using is not compatible with kaguyami2isis. Fixes #2358.
Kaitlyn Lee2020-03-31 Updated documentation to include level 2B2 support.