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


csminit

Standard View | TOC | Home

Attach a CSM model state to a cube.

Description
Categories
Groups
History


Description

This program takes Instrument Support Data (ISD) and attempts to create a valid Community Sensor Model (CSM) state string using models from the loaded CSM Libraries. If a single state string can be created, it is attached to the cube in the CSMState BLOB for later use. If there are multiple models that create valid state strings, then this program will error and return a list of possible models. The user will then have to re-run this program using the PLUGINNAME and/or MODELNAME parameters to select a specific model.

Information about the CSM model will also be added to the CsmInfo group on the cube label. The group includes names, units, and types for model parameters.

Group = CsmInfo
CSMPlatformID       = Mars_Reconnaissance_Orbiter
CSMInstrumentId     = "CONTEXT CAMERA"
ReferenceTime       = 2014-05-21T15:48:56Z
ModelParameterNames = ("IT Pos. Bias   ", "CT Pos. Bias   ",
                        "Rad Pos. Bias  ", "IT Vel. Bias   ",
                        "CT Vel. Bias   ", "Rad Vel. Bias  ",
                        "Omega Bias     ", "Phi Bias       ",
                        "Kappa Bias     ", "Omega Rate     ",
                        "Phi Rate       ", "Kappa Rate     ",
                        "Omega Accl     ", "Phi Accl       ",
                        "Kappa Accl     ", "Focal Bias     ")
ModelParameterUnits = (m, m, m, m, m, m, m, m, m, m, m, m, m, m, m, m)
ModelParameterTypes = (REAL, REAL, REAL, REAL, REAL, REAL, REAL, REAL,
                        REAL, REAL, REAL, REAL, REAL, REAL, REAL, REAL)
End_Group
    

The ModelParameter keywords contain information that can be used when running jigsaw. This information is unique for each model. For more detail, see the CSMSOLVELIST parameter in the jigsaw documentation.

This program can be run on any Cube file, but if the Cube has spice data from spiceinit then it will be removed so that there is no ambiguity between the ISIS and CSM model.

See the Plugins group in the IsisPreferences file for information about how to load CSM Libraries for use with this and other ISIS applications.


Categories


Parameter Groups

Input Files

Name Description
FROM The input cube that the state string will be attached to.
ISD The Instrument Support Data (ISD) file that will be used.
STATE A Community Sensor Model (CSM) state string

Target Specification

Name Description
TARGETNAME The name of the body observed by the image.
SHAPEMODEL The shapemodel to represent the surface of the observed body.

Model Specification

Name Description
PLUGINNAME The name of the plugin to use.
MODELNAME The name of the model to use.

Input Files: FROM

Description

The input cube that the state string will be attached to. Any kernels specified in the kernels group and any attached SPICE tables will be removed when the model state is attached.

Type cube
File Mode input
Filter *.cub

Input Files: ISD

Description

The Instrument Support Data (ISD) file that will be used to create the model state string. The ISD can be just a filename ISD or a NITF2.1 ISD.

Type filename
File Mode input
Internal Default none

Input Files: STATE

Description

A file containing a Community Sensor Model (CSM) state string that will be used to create the model for the input cube.

Type filename
File Mode input
Internal Default none

Target Specification: TARGETNAME

Description

The name of the body observed by the image.

Type string
Internal Default Current TargetName in input label or Unknown if not present.

Target Specification: SHAPEMODEL

Description

The shapemodel to represent the surface of the observed body. If none is entered, then a bi-axial ellipsoid is used. The radii are defined by the CSM model.

Type filename
Internal Default none

Model Specification: PLUGINNAME

Description

The name of the plugin to use. The loaded CSM Libraries will be searched for a plugin that has this name. If no such plugin is found an error will be returned.

Type string
Internal Default none

Model Specification: MODELNAME

Description

The name of the model to use. The loaded CSM Libraries will be searched for a model that has this name. If no such model is found an error will be returned.

Type string
Internal Default none

History

Jesse Mapel2020-11-18 Original Version
Jesse Mapel and Stuart Sides2021-02-03 Modified to always add a TargetName and Instrument group to the label for the camera model.
Kristin Berry and Stuart Sides2021-02-10 Modified to revert label and Cube changes on failure.
Kristin Berry and Stuart Sides2021-02-12 Added the ability to take a state string instead of an ISD.