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


socetframesettings

Printer Friendly View | TOC | Home

Create a SOCET SET Framing Camera or USGSAstro FrameOffAxis settings file.

Overview Parameters

Description

This is an ISIS to SOCET SET (trademark BAE Systems) translation program for Framing Camera images. It calculates keyword values specific to SOCET SET's Framing Camera Settings files and generates the settings file for input to USGSAstro SOCET SET program 'import_frame.'

The input cube must be a "level1" image with SPICE data attached to the label (see spiceinit).

The following are supported instruments:
       CASSINI ISS
       CLEMENTINE 1 UVVIS
       GALILEO SSI
       MESSENGER NAC
       MESSENGER WAC
       OSIRIS-REX MapCam
       OSIRIS-REX PolyCam
       VIKING ORBITER

    

Categories


Related Objects and Documents

Applications


History

Philip Martinez2010-07-12 Original version
Elpitha Howington-Kraus2010-10-14 Modified documentation in GUI. Changed OUPUTPNAME to INPUT_DATA_PATH, added CAM_CALIB_PATH
O. Thomas2012-08-23 Renamed program from calc_frame_settingsfile to socetframesettings, restructured program to use SpiceRotation class, added Messenger, began modifications to meet ISIS coding standards.
E. Howington-Kraus2013-02-25 Completed modifications to meet ISIS coding standards for formal installation into ISIS. Added check for needed SPICE data (blobs) attached to the cube label. Added parameter TO for user control over output settings file name (previously the program generated the output file name based on the base name of the FROM cube). Temporarily removed support for APOLLO METRIC, MEX-SRC, and THEMIS-VIS sensors until testing can be completed. References #1526.
Raad A. Saleh2013-09-09 Added support for CLEMENTINE1 UVVIS instrument and updated documentation to reflect the changes. Reference #1749.
Jeannie Backer2016-12-24 Added support for OSIRIS-REx instrument and updated documentation to reflect the changes. Fixes #3898.
Brian Carcich2018-03-07 Fixed rotations for OSIRIS-REX instruments. Added documentation and cleaned up variable names. References #5235.
Jesse Mapel2018-10-11 Changes to better match coding standards and clarify documentation. Added OREX test cases. References #5235.

Parameter Groups

Files

Name Description
FROM Filename of a "level 1" frame camera cube
TOSOCET SET Framing Camera Settings file

SOCET SET Parameters

Name Description
SS_PROJECTSOCET SET Project name
SS_IMG_LOC Destination of SOCET SET images as shown in the first column of SOCET SET's location.list file
SS_INPUT_PATH Full path to location of input images and Framing Camera settings files on the SOCET SET machine
SS_CAM_CALIB_PATH Full path to SOCET SET's camera calibration directory
X

Files: FROM


Description

Level 1 input Framing Camera cube with SPICE data attached. Supported instruments are CASSINI SSI, CLEMENTINE 1 UVVIS, GALILEO ISS, MESSENGER NAC, MESSENGER WAC, OSIRIS-REX MapCam, OSIRIS-REX PolyCam, and VIKING ORBITER.

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

Files: TO


Description

Output SOCET SET Framing Camera Settings file. This is a text file that must have a file extension of ".set." This file is one of the input files to USGSAstro SOCET SET program 'import_frame.'

Type filename
File Mode output
Internal Default None
Close Window
X

SOCET SET Parameters: SS_PROJECT


Description

Name of the SOCET SET project that you will be importing this image into. Including the ".prj" extension is optional. As an example, for SOCET SET project named TEST, enter SS_PROJECT=TEST.

Type string
Close Window
X

SOCET SET Parameters: SS_IMG_LOC


Description

The "logical" location of the SOCET images as shown in the first column of SOCET SET internal database file DEVICE/location.list.

Type string
Close Window
X

SOCET SET Parameters: SS_INPUT_PATH


Description

Full path on SOCET SET machine where raw images (*.raw) and Framing Camera settings files (*.set) will reside for import into SOCET SET, with the ending file path delimiter included. This is typically in the SOCET SET project's images directory.

Entering the file path delimiters (forward slash for UNIX systems, backslash for Windows systems) is straight forward when entering your path into the dialog box. However, special handling is required when running this program at the command line or in processing scripts.

          For SOCET SET running on Windows, an example input path would be

          E:\images\test

          To enter a path in the dialog box, enter the path as it normally appears. For this
          example, enter

          E:\images\test\

          To enter a path on the command line, or in a script, use the escape character (which is a
          backslash) to pass the delimiters to the program.  For this example, enter

          SS_INPUT_PATH=E:\\IMAGES\\TEST\\ 

Type string
Close Window
X

SOCET SET Parameters: SS_CAM_CALIB_PATH


Description

Full path to SOCET SET's internal database camera calibration directory, with the ending file path delimiter included.

          For SOCET SET running on Windows, an example path would be

          C:\SOCET_SET_5.6.0\internal_dbs\CAM

          To enter a path in the dialog box, enter the path as it normally appears. For this
          example, enter

          C:\SOCET_SET_5.6.0\internal_dbs\CAM\

          To enter a path on the command line, or in a script, use the escape character (which is a
          backslash) to pass the delimiters to the program.  For this example, enter

          SS_CAM_CALIB_PATH=C:\\SOCET_SET_5.6.0\\internal_dbs\\CAM\\ 

Type string
Close Window