Home
About Isis
Support
Download

Isis 3

Documentation
Tutorials
Technical Documents

Isis 2

Documentation
Tutorials
Technical Documents

Search
USGS

Isis 3 Application Documentation

spiceinit

Printer Friendly View | TOC | Home

Determine SPICE kernels for a camera cube

Overview Parameters

Description

Cubes which have supported camera models in the ISIS system require spacecraft position, pointing, body shape and orientation, sun position, and much more information in order to compute ground positions (latitude/longitude) and photometric viewing angles. This information is stored in SPICE kernels. This program attempts to search the ISIS data areas in order to discern the SPICE kernels required for the camera cube.

The program examines the "SpacecraftName", "InstrumentId", "TargetName", "StartTime", and "StopTime" keywords in the cube label to determine the kernels to use. It attempts to find kernels files for the following keywords and writes them to the Kernels group:

  • Leap Second (LS)
  • Spacecraft Clock (SCLK)
  • Target Position (TSPK)
  • Target AttitudeShape (PCK)
  • Instrument (IK)
  • Instrument Addendum (IAK)
  • Frame (FK)
  • Spacecraft Position (SPK)
  • Instrument Pointing (CK)
  • Shape Model (DEM)
If you are unfamilar with SPICE terminology it is recommended you read the NAIF required reading at http://naif.jpl.nasa.gov/naif/doc_C.html

The program modifies the kernels group and writes the name of the SPICE files that need to be loaded by the camera models. It has the option of pre-reading the data from the SPICE kernels and loading it as a binary table attached to the cube. This can faciliate faster load times and allows the instrument pointing to be easily updated.

Please note: Kernel Files specified that reside in the current working directory will not have their paths expanded. This is to allow variables like $msg/ to work correctly.

Categories

Related Applications in Previous Versions of Isis

This application replaces the following applications existing in previous versions of Isis, which have been deprecated from the current version of Isis:
  • levinit
  • naiflab
  • spicelab

History

Debbie A. Cook2000-06-08 Original Version
Stuart Sides2003-11-05 Complete rewrite under Isis 3.0 conversion.
Stuart Sides2004-01-14 Modified to use an existing "Kernels" group instead of creating a new one. This was because the mission specific import program (e.g., moc2isis) was modified to create the "kernels" group and put the "NaifFrameCode" into it.
Stuart Sides2004-01-23 Added new parameter "TEST". This parameter controls the testing of the final kernel list. If false the kernels will not be tested for completness by createing a camera model.
Stuart Sides2004-02-23 Added elevation model DEM capabilities.
Stuart Sides2004-02-24 Completed capabilities to search for kernels of different qualities such as PREDICTED, NADIR, RECONSTRUCTED, and C-SMITHED.
Stuart Sides2005-11-08 Added fix for framing cameras, so they would not need a stop time in the instrument group of the labels.
Elizabeth Miller2005-11-14 Added appTest
Jacob Danton2005-12-22 Added support for multiple files within the kernels
Jacob Danton2005-12-27 Added a progress bar
Jacob Danton2006-01-03 Fixed the xml description
Jacob Danton2006-01-25 Changed the mission translation file name
Jacob Danton2006-01-25 Changed the appTest to comply with changes in the String class.
Jeff Anderson2006-03-27 Modified to write InstrumentPointing, InstrumentPosition, SunPosition, and BodyRotation information to SPICE tables in the cube.
Brendan George2006-09-19 Added call to modify the history of the cube
Brendan George2006-10-19 Modifed to remove label entries for spice tables, if ATTACH is unchecked, and the input cube already has them.
Steven Lambright2007-07-10 Combined Frame and InstrumentPointing. Changed to support new version of KernelDb. Cleaned up the code.
Steven Lambright and Steve Koechle2007-07-10 Fixed problem where the allowed kernels were being set improperly.
Steven Lambright2007-08-10 Fixed so that when no spacecraft pointing is found, but frame kernels are, and Nadir is allowed it still adds the Nadir keyword.
Steven Koechle2007-10-05 Added a check to see if the cube had an existing polygon, if so delete it.
Steven Koechle2007-10-25 Fixed Smithed enum, changed from C-Smithed.
Steven Koechle2007-12-14 Added error handling logic. If the user chose to use Nadir CK and another type, and the system found a file where the image falls in a gap (no pointing is available) Nadir would never be calculated. Fixed.
Steven Lambright2008-02-13 Added time padding options
Steven Lambright2008-02-21 Added additional explanation of time padding options
Steven Lambright2008-02-22 Split the CK parameter into FK and CK, they are still combined in the label as InstrumentPointing.
Steven Lambright2008-04-14 All found CK kernels will now be tested before giving an error
Christopher Austin2008-05-02 Fixed the propagation of the EXTRA Kernel.
Steven Lambright2008-05-12 Removed references to CubeInfo
Steven Lambright2008-05-19 Fixed documentation
Christopher Austin2008-06-03 Furthered documentation.
Steven Koechle2008-06-17 Added CK check and throw more appropriate error

Parameter Groups

Input Files

Name Description
FROM The input file cube to have "kernel" labels added to it
ATTACH Attach SPICE data to cube

Instrument Orientation Kernel (CK) quality

Name Description
CKSMITHED Use smithed pointing kernels if available
CKRECON Use reconstructed pointing kernels if available
CKPREDICTED Use predicted pointing kernels if available
CKNADIR Compute nadir pointing if no other kernels exist

Instrument Position Kernel (SPK) quality

Name Description
SPKSMITHED Use smithed position kernels if available
SPKRECON Use reconstructed position kernels if available
SPKPREDICTED Use predicted pointing kernels if available

User Override of System Kernels

Name Description
LS User defined leap second kernel file.
PCK User defined target attitude and shape kernel file.
TSPK User defined target position kernel file.
IK User defined instrument kernel file.
SCLK User defined spacecraft clock kernel file.
CK User defined spacecraft pointing kernel file.
FK User defined frames kernel file.
SPK User defined spacecraft position kernel file.
IAK User defined instrument addendum kernel file.
EXTRA User defined extra kernel file.

Shape Model Parameters

Name Description
SHAPE Select the definition of the shape model
MODEL User defined ISIS cube shape model.

Time Parameters

Name Description
STARTPAD Time padding (in seconds) to load from the kernels before the start time of the image
ENDPAD Time padding (in seconds) to load from the kernels after the end time of the image
X

Input Files: FROM

Description

The input file which will have a new "kernel" group added to its labels.

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

Input Files: ATTACH

Description

This option attaches tables to the cube which contain the instrument position (SPK) and orientation (CK), as well as the sun position and body/target orientation. This is the prefered initialization option as it allows the pointing to be updated by further programs.

Type boolean
Default TRUE
Close Window
X

Instrument Orientation Kernel (CK) quality: CKSMITHED

Description

Allow the use of pointing kernels marked as c-smithed. If this parameters is turned on, c-smithed kernels may be used to cover the time requirements of the image. At least one of the parameters "CKPREDICTED", "CKNADIR", "CKRECON", "CKSMITHED" must be entered.

Type boolean
Default FALSE
Close Window
X

Instrument Orientation Kernel (CK) quality: CKRECON

Description

Allow the use of pointing kernels marked as reconstructed. If this parameters is turned on, reconstructed kernels may be used to cover the time requirements of the image. At least one of the parameters "CKPREDICTED", "CKNADIR", "CKRECON", "CKSMITHED" must be entered.

Type boolean
Default TRUE
Close Window
X

Instrument Orientation Kernel (CK) quality: CKPREDICTED

Description

Allow the use of pointing kernels marked as predicted. If this parameters is turned on, predicted kernels may be used to cover the time requirements of the image. At least one of the parameters "CKPREDICTED", "CKNADIR", "CKRECON", "CKSMITHED" must be entered.

Type boolean
Default FALSE
Close Window
X

Instrument Orientation Kernel (CK) quality: CKNADIR

Description

This option will create nadir pointing data if the other kernel types do not exist or do not cover the time range of the input cube. At least one of the parameters "CKPREDICTED", "CKNADIR", "CKRECON", "CKSMITHED" must be entered.

Type boolean
Default FALSE
Close Window
X

Instrument Position Kernel (SPK) quality: SPKSMITHED

Description

Allow the use of position kernels marked as smithed. If this parameters is turned on, smithed kernels may be used to( cover the time requirements of the image. At least one of the parameters "SPKPREDICTED", "SPKRECON", "SPKSMITHED" must be entered.

Type boolean
Default FALSE
Close Window
X

Instrument Position Kernel (SPK) quality: SPKRECON

Description

Allow the use of position kernels marked as reconstructed. If this parameters is turned on, reconstructed kernels may be used to cover the time requirements of the image. At least one of the parameters "SPKPREDICTED", "SPKRECON", "SPKSMITHED" must be entered.

Type boolean
Default TRUE
Close Window
X

Instrument Position Kernel (SPK) quality: SPKPREDICTED

Description

Allow the use of position kernels marked as predicted. If this parameters is turned on, predicted kernels may be used to cover the time requirements of the image. At least one of the parameters "SPKPREDICTED", "SPKRECON", "SPKSMITHED" must be entered.

Type boolean
Default FALSE
Close Window
X

User Override of System Kernels: LS

Description

Naif kernel file to be used for the leap second in place of the automated leap second kernel. The LS kernel will be referenced in the keyword LeapSecond by the resulting Kernel group.

Type filename
File Mode input
Default Path $base/kernels/lsk/
Internal Default none
Filter *.tls
Close Window
X

User Override of System Kernels: PCK

Description

Naif kernel file to be used for the target attitude and shape in place of the automated attitude and shape kernel. The PCK kernel will be referenced in the keyword TargetAttitudeShape by the resulting Kernel group.

Type filename
File Mode input
Default Path $BASE/kernels/pck/
Internal Default none
Filter *.tpc
Close Window
X

User Override of System Kernels: TSPK

Description

Naif kernel file to be used for the target position in place of the automated position kernel. The TSPK kernel will be referenced in the keyword TargetPosition by the resulting Kernel group.

Type filename
File Mode input
Default Path $BASE/kernels/spk/
Internal Default none
Filter *.bsp
Close Window
X

User Override of System Kernels: IK

Description

Naif kernel file to be used for the instrument in place of the automated instrument kernel. The IK kernel will be referenced in the keyword Instrument by the resulting Kernel group.

Type filename
File Mode input
Default Path $ISIS3DATA
Internal Default none
Filter *.ti
Close Window
X

User Override of System Kernels: SCLK

Description

Naif kernel file to be used for the spacecraft clock in place of the automated spacecraft clock kernel. The SCLK kernel will be referenced in the keyword Instrument by the resulting Kernel group.

Type filename
File Mode input
Default Path $ISIS3DATA
Internal Default none
Filter *.tsc
Close Window
X

User Override of System Kernels: CK

Description

Naif kernel file to be used for the spacecraft pointing in place of the automated spacecraft pointing kernel. The CK kernel will be referenced in the keyword InstrumentPointing by the resulting Kernel group.

Type filename
File Mode input
Default Path $ISIS3DATA
Internal Default none
Filter *.bc
Close Window
X

User Override of System Kernels: FK

Description

Naif kernel file to be used for the instrument frame in place of the automated frames kernel. The FK kernel will be referenced in the keyword InstrumentPointing by the resulting Kernel group. Note: If you enter a filename for CK some instruments may require a frame kernel as well.

Type filename
File Mode input
Default Path $ISIS3DATA
Internal Default none
Filter *.tf
Close Window
X

User Override of System Kernels: SPK

Description

Naif kernel file to be used for the spacecraft position in place of the automated spacecraft position kernel. The SPK kernel will be referenced in the keyword InstrumentPosition by the resulting Kernel group.

Type filename
File Mode input
Default Path $ISIS3DATA
Internal Default none
Filter *.bsp
Close Window
X

User Override of System Kernels: IAK

Description

Naif formatted kernel file to be used for the ISIS specific instrument addendum kernel, in place of the automated. The IAK kernel will be referenced in the keyword InstrumentAddendum by the resulting Kernel group.

Type filename
File Mode input
Default Path $ISIS3DATA
Internal Default none
Filter *.ti
Close Window
X

User Override of System Kernels: EXTRA

Description

Optional extra naif formatted kernel file. The EXTRA kernel will be referenced in the keyword Extra by the resulting Kernel group.

Type filename
File Mode input
Default Path $ISIS3DATA
Internal Default none
Close Window
X

Shape Model Parameters : SHAPE

Description

ISIS camera models can use a shape model (a projected ISIS cube that defines the radii for a global or regional area). You can choose to select a shape model or to use the definition of the ellipsoid found in the planetary constants (PCK) file.

Type string
Default SYSTEM
Option List:
Option Brief Description
ELLIPSOIDUse triiaxial ellipsoid from PCKThe camera will use the radii defined in the planetary constants file (PCK) when determining intersections of the body surface

Exclusions

  • MODEL
SYSTEMSearch system for a default shape model This option will search the default system data area ($ISIS3DATA/base/dems) for a shape model that matches the target of the input cube. If none are found then no shape model will be used and the default ellipsoid parameters found in the planetary constants (PCK) file define the shape.

Exclusions

  • MODEL
USERUser specified shape model fileThe camera will use shape model defined by the parameter MODEL
Close Window
X

Shape Model Parameters : MODEL

Description

A map projected ISIS cube which contains the radii of the target. The file can cover more than the input cube (FROM) but must minimally cover the data in the input cube.

Type cube
File Mode input
Default Path $base//dems/
Filter *.cub
Close Window
X

Time Parameters: STARTPAD

Description

When the kernels for an image are loaded, by default only what the image requires is loaded. By setting this option, the loaded kernels start at the specified amount of time before the image start time. This option should always be zero for framing cameras.

Type double
Default 0.0
Minimum 0.0 (inclusive)
Close Window
X

Time Parameters: ENDPAD

Description

When the kernels for an image are loaded, by default only what the image requires is loaded. By setting this option, the loaded kernels end at the specified amount of time after the image end time. This option should always be zero for framing cameras.

Type double
Default 0.0
Minimum 0.0 (inclusive)
Close Window