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

ringsmappt

Printer Friendly View | TOC | Home

Outputs ring radius/longitude at line/sample or reverse

Overview Parameters

Description

The ringsmappt application computes various coordinate formats using a map-projected cube.

The following table shows input parameters and the resulting coordinates that will be computed:

Input Parameters Coordinates Computed
Line and sample Ring radius, ring longitude, X, and Y
Ring radius and ring longitude Line, sample, X, and Y
X and Y Line, sample, ring radius, and ring longitude

The output options are the following:

  • Display to the screen only
  • PVL format text file
  • Comma delimited text file or flat file

The output file (TO) can be used as input to extract keyword values with a script via the getkey program. Below is an example of the command line to execute the program, and the results that show the keywords and the computed values: 

ringsmappt from=W1591159850_1_cal.lev2.cub sample=1024 line=1024 

Group = Results
  Filename			   = W1591159850_1_cal.lev2.cub
  Sample                           = 1024.0
  Line                             = 1024.0
  PixelValue                       = 2.9266113e+11
  X                                = -58752169.950728
  Y                                = -83725336.55945
  RingRadius                       = 102282693.82409

  # Input map direction/domain for ring longitude.
  CounterClockwise360RingLongitude = 234.9416974425
  Clockwise360RingLongitude        = 125.0583025575
  CounterClockwise180RingLongitude = -125.0583025575
  Clockwise180RingLongitude        = 125.0583025575
End_Group

The user can specify how the program interprets the rings longitude domain and rings longitude direction by defining the coordinate system parameters (COORDSYS). The ring longitude direction can be set to clockwise or counterclockwise.

Categories

History

Jeff Anderson2003-02-05 Original version
Stuart Sides2003-11-07 Modified results PVL to not include the results group
Brendan George2005-11-21 Added application test
Elizabeth Miller2006-06-29 Changed name to mappt and made ui look like skypt and campt
Sean Crosby2007-04-12 Changed flatfile output so it duplicates PVL data. User now required to enter a flatfile name.
Steven Lambright2008-05-13 Removed references to CubeInfo
Steven Koechle2008-08-14 Added pixel value to the output group
Mackenzie Boyd2010-01-12 Modified output to include all coordinate systems for latitude and longitude and clearly declare the input files coordinate system. Improved documentation.
Mackenzie Boyd2010-02-16 Added many parameters accessible when inputting a lat and lon, all under coordinate system. These parameters are to select the input coordinate system being used. Updated documentation to match.
Tracie Sucharski2012-12-06 Changed to use TProjection instead of Projection. References #775
Debbie A. Cook2013-02-25 Changed to work for ring plane projections. References #775
Jeannie Backer2013-03-12 Added appTests. Test coverage 96% scope, 94% line, 67% function. Function coverage is low since there are GUI helper methods.
Ella Mae Lee2013-12-24 Updated user documentation, fixes #1934.

Parameter Groups

Files

Name Description
FROM Filename of a projected cube
TOOutput text file
FORMAT Output format
APPEND Append result to output file

Position

Name Description
TYPECoordinate selection
SAMPLE Sample position
LINE Line position
RINGRADIUS Ring Radius value
RINGLONGITUDE Ring Longitude value
X X coordinate
Y Y coordinate

Coordinate System

Name Description
COORDSYS The coordinate system of the ring radius and ring longitude
MAP File containing mapping parameters
RINGLONDIR Ring Longitude direction
RINGLONDOM Ring Longitude domain
X

Files: FROM

Description

Specify an input cube that contains Mapping group keywords in the labels.

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

Files: TO

Description

Output filename that contains the results of ringsmappt. This file can be used in conjunction with the getkey program to pass the results to another program when developing scripts, if the PVL format is selected.

Type filename
File Mode output
Internal Default None
Close Window
X

Files: FORMAT

Description

The format type for the output file. The default is in PVL format.

Type string
Default PVL
Option List:
Option Brief Description
PVL PVL Format Output file in PVL format
FLAT Flat file Format Output file is a comma delimited text file with column headings. This file format can easily be imported into the Microsoft Excel program or other spreadsheets.
Close Window
X

Files: APPEND

Description

If this option is selected, the output from ringsmappt will be appended to the output file. If it is not selected, any information in the TO file will be overwritten.

Type boolean
Default TRUE
Close Window
X

Position: TYPE

Description

This parameter is used to select the type of input coordinate. The options are IMAGE (sample/line), GROUND (ring radius/ring longitude), and PROJECTION (X/Y).

Type string
Default IMAGE
Option List:
Option Brief Description
IMAGEInterprets the coordinate as sample/line This option interprets the coordinate as sample/line and will compute ring radius/ring longitude, and X/Y

Exclusions

  • RINGRADIUS
  • RINGLONGITUDE
  • X
  • Y
  • COORDSYS
  • RINGLONDIR
  • RINGLONDOM
  • MAP

Inclusions

  • SAMPLE
  • LINE
GROUNDInterprets the coordinates as ring radius and ring longitude This option interprets the coordinate as ring radius/ring longitude and will compute sample/line and X/Y

Exclusions

  • SAMPLE
  • LINE
  • X
  • Y

Inclusions

  • RINGRADIUS
  • RINGLONGITUDE
  • COORDSYS
PROJECTIONInterprets the coordinate as X/Y This option interprets the coordinate as X/Y and will compute sample/line and ring radius/ring longitude

Exclusions

  • SAMPLE
  • LINE
  • RINGRADIUS
  • RINGLONGITUDE
  • RINGLONDIR
  • RINGLONDOM
  • MAP
  • COORDSYS

Inclusions

  • X
  • Y
Close Window
X

Position: SAMPLE

Description

This is the sample position used to compute information about the camera state at the pixel level.

Type double
Close Window
X

Position: LINE

Description

This is the line position used to compute information about the camera state at the pixel level.

Type double
Close Window
X

Position: RINGRADIUS

Description

This is the ring radius value to use for the target.

Type double
Minimum 0.0 (inclusive)
Close Window
X

Position: RINGLONGITUDE

Description

This is the ring longitude value. The ring longitude will be interpreted as either CounterClockwise or Clockwise, and as -180° to 180° or 0° to 360° ring longitude domain, depending on the option selected under coordinate system.

Type double
Close Window
X

Position: X

Description

This is the X coordinate value in meters.

Type double
Close Window
X

Position: Y

Description

This is the Y coordinate value in meters.

Type double
Close Window
X

Coordinate System: COORDSYS

Description

This is the coordinate system that the input ring radius and ring longitude will be interpreted in. There are four possible options that include using the input cube settings, the ISIS defaults, user defined settings, or an existing map file template. The values will be interpreted as counterclockwise or clockwise, and -180° to 180° or 0° to 360° rings longitude domain.

Type string
Default INPUTFILESYS
Option List:
Option Brief Description
INPUTFILESYS Use coordinate system of input file This option uses the coordinate system of the input cube; this could be any of four possibilities. This is the default behavior.

Exclusions

  • RINGLONDIR
  • RINGLONDOM
  • MAP
UNIVERSAL ISIS default The ISIS default coordinate system of counterclockwise ring longitude direction and rings longitude domain 0° to 360°.

Exclusions

  • RINGLONDIR
  • RINGLONDOM
  • MAP
USERDEFINED User defined coordinate system The user defines the rings longitude direction and rings longitude domain for the coordinate system.

Exclusions

  • MAP

Inclusions

  • RINGLONDIR
  • RINGLONDOM
MAP Use mapping group from another file Use an existing file (NOT THE INPUT FILE) with Mapping group information to determine the coordinate system for the computations.

Exclusions

  • RINGLONDIR
  • RINGLONDOM

Inclusions

  • MAP
Close Window
X

Coordinate System: MAP

Description

This file can be a cube or a user generated map file template, but not the input file. This file must contain the mapping group and is used to determine the coordinate system, if selected.

Type filename
File Mode input
Filter *.map *.cub
Close Window
X

Coordinate System: RINGLONDIR

Description

This is the ring longitude direction for the projection. The direction can be Counterclockwise or Clockwise. COUNTERCLOCKWISE is the default.

Type string
Default COUNTERCLOCKWISE
Option List:
Option Brief Description
COUNTERCLOCKWISE CounterClockwise Ring Longitude Direction Sets the ring longitude direction of the input to be interpreted as CounterClockwise.
CLOCKWISE Clockwise Ring Longitude Direction Sets the ring longitude direction of the input to be interpreted as Clockwise.
Close Window
X

Coordinate System: RINGLONDOM

Description

The ring longitude domain for the projection can either be 180 or 360. The default setting is 360.

Type string
Default 360
Option List:
Option Brief Description
360 0 to 360 Degree Ring Longitude Domain Sets the ring longitude domain of the input to be interpreted as 0 to 360 degrees.
180 -180 to 180 Degree Ring Longitude Domain Sets the ring longitude domain of the input to be interpreted as -180 to 180 degrees.
Close Window