Help for NSYTWKSP
PURPOSE:
NSYTWKSP computes a mask showing the workspace boundaries for the
InSight mission. The boundaries are computed by comparing the XYZ
coordinates with precomputed polygons indicating the edges of the
workspace.
The output is a single-band BYTE image, containing a code 0-5 showing
which polygons the point is inside. See below for values.
This program could easily by multimission-ized.
EXECUTION:
nsytwksp inp=data.xyz out=data.wss -seis
where:
data.xyz is an input 3-band image of type REAL with the X, Y and Z values
at that pixel in meters (the unit is actually irrelevant).
METHOD:
The actual core algorithm was developed by Steven Myint from Section 347.
It was then refactored to meet VICAR standards by Bob Deen.
The algorithm is simple: for each point, it checks if the XY coordinate
is within the boundary specified by the input polygon file. Z is ignored.
The XYZ coordinate is converted to the coordinate system specified in
COORD first.
The files are different based on instrument: HP3 and SEIS (actually a
combination of SEIS and WTS). Selection is made via a parameter.
OUTPUT FORMAT:
The output is a 1-band file in BYTE format.
For HP3 the possible values are:
0 = no data
1 = outside HP3 boundary, or no data
2 = n/a
3 = inside HP3 workspace, outside HP3 grapple point boundary
4 = n/a
5 = inside HP3 grapple point boundary
For SEIS/WTS the possible values are:
0 = no data
1 = outside all SEIS/WTS areas, or no data
2 = inside WTS boundary, outside SEIS boundary
3 = n/a
4 = inside WTS and SEIS boundaries, outside SEIS/WTS grapple point boundary
5 = inside SEIS/WTS grapple point boundary
The assigned numbers max at 5 (where 5 is best) in order to maintain
consistency across all InSight masks. The 1-4 numbers are arbitrary but
were chosen so they would be different between WSH and WSS products.
Note: it is assumed the polygons strictly nest, with higher numbers above
being smaller than previous polygons. If not, the highest number wins
(in other words, polygons are traversed in order from highest to lowest, and
once a number is assigned to a given pixel, no other polyons are checked).
HISTORY:
2015-05-02 rgd Initial version, based on code from Steven Myint (347)
COGNIZANT PROGRAMMER: B. Deen
PARAMETERS:
INP
Input XYZ image.
Must be 1 3-band file
or (x,y,z) triplet.
OUT
Output file.
Must be 1 filename.
NAVTABLE
Corrected navigation
filename.
INST
Instrument to use:
HP3 or SEIS
OUTSIDE_DN
DN to use for outside
all polygons
CONFIG_PATH
Path used to find
configuration/calibration
files.
POINT_METHOD
Specifies a mission-
specific pointing
method to use
NOSITE
Disables coordinate
system sites.
RSF
Rover State File(s) to use.
DEBUG_RSF
Turns on debugging of RSF
parameter.
COORD
Coordinate system to use.
COORD_INDEX
Coordinate system index for
some COORD/mission combos.
FIXED_SITE
Which site is FIXED for
rover missions.
SOLUTION_ID
Solution ID to use for
COORD_INDEX
DATA_SET_NAME
Specifies the full name given
to a data set or a data product.
DATA_SET_ID
Specifies a unique alphanumeric
identifier for a data set or data
product.
RELEASE_ID
Specifies the unique identifier
associated with the release to the
public of all or part of a data set.
The release number is associated with
the data set, not the mission.
PRODUCT_ID
Specifies a permanent, unique
identifier assigned to a data
product by its producer.
PRODUCER_ID
Specifies the unique identifier
of an entity associated with the
production a data set.
PRODUCER_INST
Specifies the full name of the
identity of an entity associated
with the production of a data set.
TARGET_NAME
Specifies a target.
TARGET_TYPE
Specifies the type of a named target.
See Examples:
Cognizant Programmer: