Official websites use .gov
A .gov website belongs to an official government organization in the United States.

Secure .gov websites use HTTPS
A lock ( ) or https:// means you’ve safely connected to the .gov website. Share sensitive information only on official, secure websites.

ISIS Documentation

csminit

Attach a CSM model isd or state to a cube.

This program takes either Instrument Support Data (ISD) or a state file 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

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.
Adam Paquette2025-05-23 Updated documentation providing examples for running csminit with an ISD or a state file

Parameters

Input Files

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

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. It should be noted that you do not need to pass a state file if you use an ISD.
Type filename
File Mode input
Internal Default none

A file containing a Community Sensor Model (CSM) state string that will be used to create the model for the input cube. It should be noted that you do not need to pass an ISD if you use a state file.
Type filename
File Mode input
Internal Default none

Target Specification

The name of the body observed by the image.
Type string
Internal Default Current TargetName in input label or Unknown if not present.

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

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

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

Example 1

Running csminit with an ISD

This example uses a calibrated MRO CTX image and an ISD generated using ALE or Abstraction Layer for Ephemerides.

Command Line

Running csminit with an ISD file
csminit from= F02_036648_2021_XN_22N022W.cal.csm.cub isd= F02_036648_2021_XN_22N022W.cal.csm.json

Example 2

Running csminit with a state file

This example uses a calibrated MRO CTX image and a state file. The CSMState string was extracted from a cube using blobbump and saved into a file. This cube was from example 1, having attached the state from an ISD.

Command Line

Running csminit with a state file
csminit from= F02_036648_2021_XN_22N022W.cal.csm.cub state= F02_036648_2021_XN_22N022W.cal.csm.state.json