Help for SYSNIMS2

PURPOSE
This procedure will perform systematic processing of NIMS data.  Systematic
processing includes creating the following items:

  a merged mosaic cube               (NIMSCMM2)
  spectral index images, 10 maximum  (NIMSFLOAT and F2)
  spectral plots, 6 maximum          (SPECPLOT)
  a 2-dimensional histogram          (HIST2D)
  an ISIS cube                       (VISIS2)
  a mask to produce a color hardcopy (NIMSMASK) (optional)


The PDS labelled ISIS cube is the main product created by this procedure.  The
ISIS cube consists of the merged mosaic cube, the geometry co-cube, the
spectral index image cube, the spectral plots (0 to 6), and a 2-D histogram.

The output file names are constructed from the parameters OBSNAME, OBSEXT, and 
MOS_NUM as follows:
 filename = "xxDISK::"//"xxDIR:"//OBSNAME//OBSEXT//"_"//INITIALS//seq_no//".ttt"
where "seq_no" is a running 2-digit number (01 to 35) generated from MOS_NUM,
"xx" = "MM" for the VICAR products, and "ISIS" for the ISIS cube, and "ttt" is 
the filetype:
  "ttt" = "CUB" for the VICAR cube (".TUB" if Tube is requested),
  "ttt" = "COC" for the VICAR co-cube (".COT" if Tube),
  "ttt" = "QUB" for the ISIS cube ("VTUB" if Tube), etc.
E.g.:  specifying the following parameters:
  ISISDISK = SCX1:
  ISISDIR = [MIPL]
  OBSNAME = E1WNGMOS05
  OBSEXT = A
  MOS_NUM = 3
will generate the ISIS cube name:  SCX1:[MIPL]E1WNGMOS05A_MSY03.QUB.

If the "xxDISK", "xxDIR" parameteres are not given, the products are placed in 
the directory from which the proc is being run.  

*** NOTE:  Archiving is not part of this procedure.

A color mask is an optional product.

There will be various files (most of them temporary) created by this procedure
and placed in the directory from which this is running.


The following parameters are used to create the merged mosaic cube.

  EDR, PROCESS, OUTTYPE, CALFILE, SOLFILE, DARKFILE, DBMFILE, DSPKFILE,
  TARGET, DELRAD, PHASE, OBSNAME, OBSEXT, MOS_NUM, INITIALS, OBSNOTE, PRODNOTE,
  CALTYPE, RADSCAL, DARKTYPE, PHOTFUNC, PHOTCUT, MINN_EXP, PROJ, TIELAT,
  TIELON, TIELINE, TIESAMP, NORTH, PARALLEL, REFSCLK, REFMP, RADFACT, SCALE,
  OUTSIZ, PRANGE, OLATLON, FILL, FILPAR, BIN, OVERLAP, THRESH, FPNGRID,
  SLEW_TOL, CSOURCE, PCKERNEL, RCKERNEL, SPKERNEL, IKERNEL, DPOINT, DPT_SCLK,
  EPHERR, AACSFILE, SCLK, GOFFSET, INSMODE, NLGP, STOPSLID, MIRROMIT, INS_TEMP,
  INCCUT, EMICUT, SDGEO, and SDBAND.

  The parameters which can not be defaulted are:

    EDR, CALFILE, TARGET, OBSNAME, OBSNOTE, PROJ, and SCLK, and (unless
    PROJection is POV/PERSPECT) either SCALE or OUTSIZ.

  These parameters must be given even if 'NOMM is given.  'NOMM means that 
  CATNIMS2 and NIMSCMM2 will not be run and the file names generated using
  OBSNAME, OBSEXT, and MOS_NUM will be used as the merged mosaic cube and the
  geometry co-cube, which will be used to produce the spectral index image
  cube, spectral plots, 2-D histogram, ISIS cube, and the mask.  'NOMM is
  used in the case where this procedure needs to be restarted after NIMSCMM2.

  EDR is not part of the NIMS request form.  The user will have to find the
  edr file names and put them on disk prior to running this procedure


The following parameters are used to create the spectral index images:

  SII_IMGS, FUNC1, BAND1, FUNC2, BAND2, FUNC3, BAND3, FUNC4, BAND4, FUNC5,
  BAND5, FUNC6, BAND6, FUNC7, BAND7, FUNC8, BAND8, FUNC9, BAND9, FUNC10,
  BAND10, EXCLD, and REPLACE

  Whether or not spectral index images are to be created, SII_IMGS must always
  be given, along with the necessary FUNC's and BAND's.

  The Vicar programs NIMSFLOAT and F2 are used to create the spectral index
  images, and INSERT3D is used to create the spectral index image cube.


The following parameters are used to create the spectral plots:

  PLOTS, BREAK_UM, AREA1, AREA2, AREA3, AREA4, AREA5, AREA6, EXCLUDE, PSAT,
  and CALTYPE

  Note that the mask will always have 6 plots, regardless of what was
  specified for PLOTS;  if fewer than 6 were requested, then the remainder
  will be empty.

  EXCLUDE is not part of the NIMS request form and will probably never need to
  be given.


The following parameters are used to create the 2-D histogram:

  EXCLUDE and CALTYPE

  EXCLUDE is not part of the NIMS request form and will probably never need to
  be given.  


The following parameters are used to create the ISIS cube:

  REQUESTR, ISISDISK, and ISISDIR

  
The following parameters are used to create the color mask:

  MASK, RED_SIID, GRN_SIID, BLU_SIID, ASTRETCH, RSTRETCH, GSTRETCH,
  BSTRETCH, RFORMULA, GFORMULA, BFORMULA, TCA, PSH, BOXCOLOR, MASKDISK, 
  and MASKDIR (for a Tube, also:  PIX_DN, BODY_DN, OTHR_DN, BODCEN,
  MIRR_FP, LIMBINC, BOREINC, and PST)

  If a color mask is to be produced, the following parameters cannot be
  defaulted:

    RED_SIID, GRN_SIID, BLU_SIID, RFORMULA, GFORMULA, and BFORMULA

  and MASK must be set to MASK (NOMASK is the default)

  Also, either ASTRETCH or RSTRETCH, GSTRETCH, and BSTRETCH and TCA really
  should be given.  PSH and BOXCOLOR are not part of the NIMS request form and
  will probably never need to be given.


PROGRAM HISTORY:

SYSNIMS written by: Jan Yoshimizu, 17 October 1990
SYSNIMS2 adapted from SYSNIMS:  L.W.Kamp,  2 March 1995
Cognizant programmer: Lucas Kamp

Changes:
  19apr95 -lwk- remove ISIS "bad values" using F2 before SIZE step to
		avoid contamination of interpolation algorithm
   8aug96 -lwk- changes for phase 2 actual data
   3feb97 -lwk- changes for phase 2 Sys.processing

PARAMETERS:


REQST_ID

ID number of request form

EDR

1-25 input EDR files

PROCESS

Determines amount of systematic processing to complete

MMDISK

Disk on which the merged mosaic will be placed

MMDIR

Directory in which the merged mosaic is placed

OUTTYPE

"G-cube" or "Tube" output?

CALFILE

calibration file(s)

SOLFILE

solar flux file

DARKFILE

dark file

DBMFILE

deboom file

DSPKFILE

despike file

TARGET

Name of the planet or satellite.

DELRAD

Atmospheric height

PHASE

Mission phase

OBSNAME

Observation name

OBSEXT

Observation extension

MOS_NUM

Observation number

INITIALS

Used in constructing PRODUCT_ID & Cube names .VAR OBSNOTE Observation description .VAR PRODNOTE Product description

CALTYPE

Type of calibration

RADSCAL

Controls radiances scaling if RAD

DARKTYPE

Type of dark interpolation

PHOTFUNC

Photometric function used .VAR PHOTCUT Photometric correction cutoff wavelength

MINN_EXP

Parameter for Minnaert photometric function

PROJ

Map projection

TIELAT

Special latitude point

TIELON

Special longitude point

TIELINE

Line of special point

TIESAMP

Sample of special point

NORTH

Output North angle (ORTHO or POV only)

PDIST

S/C-Planet distance (POV/PERSPECT only) .VAR OAXIS Optical axis Line,Sample (POV/PERSPECT only)

PARALLEL

Latitudes of standard parallels (Lambert projection only)

REFSCLK

Reference SCLK (100*RIM+MOD91)

REFMP

MP for REFSCLK

RADFACT

Radius expansion factor for off-planet pixels

SCALE

Number of kilometers each pixel represent; (if POV: factor over nominal scale)

LAT_TYPE

Planetographic/centric lat's?

OUTSIZ

(NL,NS) in the output image

FILL

Fill in sparse data?

FILPAR

(Fill dimension, number of valid points) -- only if FILL

BIN

binning algorithm to use

OVERLAP

what to do with overlapping output pixels

THRESH

threshold weight to use DN (BIN=FOOTPRINT only)

FPNGRID

grid size (BIN=FOOTPRINT only) .VAR INCCUT Cutoff incidence angle .VAR EMICUT Cutoff incidence angle

SLEW_TOL

max. slew rate

CSOURCE

source of pointing angles .VAR PCKERNEL SPICE Platform C-kernel .VAR RCKERNEL SPICE Rotor C-kernel (if Deboom option on) .VAR SPKERNEL SPICE SP-kernel .VAR PCONSTNT SPICE Planet constants kernel

IKERNEL

NIMS Instrument Kernel

EKERNEL

SPICE Event Kernel

DPOINT

(RA,Dec) pointing correction .VAR DPT_SCLK SCLK range for DPOINT .VAR EPHERR time offset to simulate ephemeris error

SCLK

list of SCLK intervals for cube data

GOFFSET

Grating offset

INSMODE

Instrument mode

NLGP

# logical grating positions (FIXED mode only)

STOPSLID

Mode if Stop & Slide

SDGEO

Co-cube band index for std. dev.

SDBAND

Band index for std. dev (default=NB/2) .VAR MIRROMIT discard mirror positions? .VAR INS_TEMP Override instrument temperatures

CATALOG

Update datalog?

SII_IMGS

Spectral index image quantity

FUNC1

Algebraic formula for the first spectral index image

BAND1

List of bands used for the first spectral index image

FUNC2

Algebraic formula for the second spectral index image

BAND2

List of bands used for the second spectral index image

FUNC3

Algebraic formula for the third spectral index image

BAND3

List of bands used for the third spectral index image

FUNC4

Algebraic formula for the fourth spectral index image

BAND4

List of bands used for the fourth spectral index image

FUNC5

Algebraic formula for the fifth spectral index image

BAND5

List of bands used for the fifth spectral index image

FUNC6

Algebraic formula for the sixth spectral index image

BAND6

List of bands used for the sixth spectral index image

FUNC7

Algebraic formula for the seventh spectral index image

BAND7

List of bands used for the seventh spectral index image

FUNC8

Algebraic formula for the eighth spectral index image

BAND8

List of bands used for the eighth spectral index image

FUNC9

Algebraic formula for the ninth spectral index image

BAND9

List of bands used for the ninth spectral index image

FUNC10

Algebraic formula for the tenth spectral index image

BAND10

List of bands used for the tenth spectral index image

EXCLD

List of values to be excluded in the function evaluation of F2

REPLACE

Value to be placed in the output file when an excluded input value is encountered in F2

PLOTS

Number of spectal plots to produce

BREAK_UM

Wavelength in microns at which I/F scale changes to radiance scale

AREA1

The first pixel region (slat,slon,nl,ns)

AREA2

The second pixel region (slat,slon,nl,ns)

AREA3

The third pixel region (slat,slon,nl,ns)

AREA4

The fourth pixel region (slat,slon,nl,ns)

AREA5

The fifth pixel region (slat,slon,nl,ns)

AREA6

The sixth pixel region (slat,slon,nl,ns)

EXCLUDE

Zero exclusion from calculations

MASK

Produce a mask?

NEG

Number of negatives

PRINT

Number of prints

RED_SIID

Summary image to be used in the red plane of the mask

GRN_SIID

Summary image to be used in the green plane of the mask

BLU_SIID

Summary image to be used in the blue plane of the mask

ASTRETCH

Sample and saturation percentages of adaptive stretch for all color planes of the mask

RSTRETCH

Lo and Hi DN for fixed stretch of the red plane of the mask

GSTRETCH

Lo and Hi DN for fixed stretch of the green plane of the mask

BSTRETCH

Lo and Hi DN for fixed stretch of the blue plane of the mask

RFORMULA

Formula used to create the summary image used in the red plane of the mask

GFORMULA

Formula used to create the summary image used in the green plane of the mask

BFORMULA

Formula used to create the summary image used in the blue plane of the mask .VAR PIX_DN boresight: lo/hi DNs (TUBE case only) .VAR BODY_DN limb / latlon: fore/back DNs (TUBE case only) .VAR OTHR_DN mirror / background / specplot DNs (TUBE case only)

BODCEN

Center body in RA-Dec display? (TUBE case only) .VAR MIRR_FP Display mirror footprint? (TUBE case only)

NOGRID

suppress lat/lon grid

NOTERMTR

suppress drawing terminator (POV only)

LIMBINC

Include entire target body limb in RA-Dec display? (TUBE case only)

BOREINC

Include entire boresight footpint in RA-Dec display? (TUBE case only)

TCA

Time to closest approach in the format -DDD HH:MM:SS, (13 char)

PSH

Pseudocolor table number for the 2-dimensional histogram

PST

Pseudocolor table number for the Tube summary image

BOXCOLOR

Color of area boxes on the spatial display of the mask

MASKDISK

Disk the mask is placed on

MASKDIR

Directory the mask is placed on

REQUESTR

Name of processing requestor (info only)

B_PICNO

Starting PICNO of SSI ridealong images (info only)

E_PICNO

Ending PICNO of SSI ridealong images (info only)

ISISDISK

Disk the ISIS cube is placed on

ISISDIR

Directory the ISIS cube is placed on

SUBMTMSK

Submit the mask to the MDA?

QUEUE

MDA queue

TASKNAME

Name of task with cube labels

DOISIS

Produce ISIS cube?

SAVEWTS

Save the weights file?

PSAT

Any saturated pixel causes spec plot to saturate .VAR CATSRV Server for Sybase catalog .VAR CATDB Database for Sybase catalog .VAR CATUSR UserID for Sybase catalog .VAR CATPW Password for Sybase catalog

See Examples:


Cognizant Programmer: