HiRISE

HiRISE.HiPlan.PTF
Class Make_NIO_Series

java.lang.Object
  extended by HiRISE.HiPlan.PTF.Make_NIO_Series

public class Make_NIO_Series
extends Object

Version:
1.29
Author:
Christian Schaller, Nicole Baugh - UA/PIRL

Field Summary
static String APPLICATION_GROUP
           
static String BY_ORBIT_COMMENT
           
static String BY_ORBIT_DURATION
           
static String BY_ORBIT_SETUP
           
static String BY_PTF_COMMENT
           
static String BY_PTF_DURATION
           
static String BY_PTF_SETUP
           
static String BY_TIME_COMMENT
           
static String BY_TIME_DURATION
           
static String BY_TIME_SETUP
           
static String CLOBBER_OUTPUT
           
static String DEFAULT_ANCILLARY_DATA
           
static String DEFAULT_BY_ORBIT_COMMENT
           
static double DEFAULT_BY_ORBIT_DURATION
           
static double DEFAULT_BY_ORBIT_SETUP
           
static String DEFAULT_BY_PTF_COMMENT
           
static double DEFAULT_BY_PTF_DURATION
           
static double DEFAULT_BY_PTF_SETUP
           
static String DEFAULT_BY_TIME_COMMENT
           
static double DEFAULT_BY_TIME_DURATION
           
static double DEFAULT_BY_TIME_SETUP
           
static boolean DEFAULT_CLOBBER_OUTPUT
           
static String DEFAULT_COMPRESSION
           
static String DEFAULT_DOWNLINK_BAND
           
static double DEFAULT_MIN_TRIM_DURATION
           
static int DEFAULT_OBSERVATION_TYPE
           
static double DEFAULT_PIGGYBACK_THRESHOLD
           
static double DEFAULT_RAW_DATA_VOLUME
           
static String DEFAULT_REQUEST_CATEGORY
           
static int DEFAULT_REQUEST_PRIORITY
           
static double DEFAULT_ROLL_ANGLE
           
static int FAILURE
          Exit status for an unsuccessful operation.
static String ID
          Class identification name with source code version and date.
static double MAX_DURATION
           
static int MAX_ORBIT
           
static int MAX_SEQUENCE
           
static double MAX_SETUP
           
static double MAX_SHIFT
           
static double MAX_SPACING
           
static double MIN_DURATION
           
static int MIN_NUMBER
           
static int MIN_ORBIT
           
static int MIN_SEQUENCE
           
static double MIN_SETUP
           
static double MIN_SHIFT
           
static double MIN_SPACING
           
static String ORBIT_REPORT_ADDITION
           
static String ORBIT_REPORT_EXTENSION
           
static String OUTPUT_PTF_ADDITION
           
static int SUCCESS
          Exit status for a successful operation.
 
Method Summary
static void main(String[] args)
          Invokes an instance of Make_NIO_Series and processes the command-line arguments.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ID

public static final String ID
Class identification name with source code version and date.

See Also:
Constant Field Values

OUTPUT_PTF_ADDITION

public static final String OUTPUT_PTF_ADDITION
See Also:
Constant Field Values

ORBIT_REPORT_ADDITION

public static final String ORBIT_REPORT_ADDITION
See Also:
Constant Field Values

ORBIT_REPORT_EXTENSION

public static final String ORBIT_REPORT_EXTENSION
See Also:
Constant Field Values

MIN_DURATION

public static final double MIN_DURATION
See Also:
Constant Field Values

MAX_DURATION

public static final double MAX_DURATION
See Also:
Constant Field Values

MIN_SETUP

public static final double MIN_SETUP
See Also:
Constant Field Values

MAX_SETUP

public static final double MAX_SETUP
See Also:
Constant Field Values

MIN_SHIFT

public static final double MIN_SHIFT
See Also:
Constant Field Values

MAX_SHIFT

public static final double MAX_SHIFT
See Also:
Constant Field Values

MIN_SEQUENCE

public static final int MIN_SEQUENCE
See Also:
Constant Field Values

MAX_SEQUENCE

public static final int MAX_SEQUENCE
See Also:
Constant Field Values

MIN_ORBIT

public static final int MIN_ORBIT
See Also:
Constant Field Values

MAX_ORBIT

public static final int MAX_ORBIT
See Also:
Constant Field Values

MIN_SPACING

public static final double MIN_SPACING
See Also:
Constant Field Values

MAX_SPACING

public static final double MAX_SPACING
See Also:
Constant Field Values

MIN_NUMBER

public static final int MIN_NUMBER
See Also:
Constant Field Values

DEFAULT_DOWNLINK_BAND

public static final String DEFAULT_DOWNLINK_BAND
See Also:
Constant Field Values

DEFAULT_OBSERVATION_TYPE

public static final int DEFAULT_OBSERVATION_TYPE
See Also:
Constant Field Values

DEFAULT_REQUEST_PRIORITY

public static final int DEFAULT_REQUEST_PRIORITY
See Also:
Constant Field Values

DEFAULT_RAW_DATA_VOLUME

public static final double DEFAULT_RAW_DATA_VOLUME
See Also:
Constant Field Values

DEFAULT_REQUEST_CATEGORY

public static final String DEFAULT_REQUEST_CATEGORY
See Also:
Constant Field Values

DEFAULT_COMPRESSION

public static final String DEFAULT_COMPRESSION
See Also:
Constant Field Values

DEFAULT_ANCILLARY_DATA

public static final String DEFAULT_ANCILLARY_DATA
See Also:
Constant Field Values

DEFAULT_ROLL_ANGLE

public static final double DEFAULT_ROLL_ANGLE
See Also:
Constant Field Values

DEFAULT_PIGGYBACK_THRESHOLD

public static final double DEFAULT_PIGGYBACK_THRESHOLD
See Also:
Constant Field Values

DEFAULT_MIN_TRIM_DURATION

public static final double DEFAULT_MIN_TRIM_DURATION
See Also:
Constant Field Values

APPLICATION_GROUP

public static final String APPLICATION_GROUP
See Also:
Constant Field Values

BY_ORBIT_SETUP

public static final String BY_ORBIT_SETUP
See Also:
Constant Field Values

DEFAULT_BY_ORBIT_SETUP

public static final double DEFAULT_BY_ORBIT_SETUP
See Also:
Constant Field Values

BY_ORBIT_DURATION

public static final String BY_ORBIT_DURATION
See Also:
Constant Field Values

DEFAULT_BY_ORBIT_DURATION

public static final double DEFAULT_BY_ORBIT_DURATION
See Also:
Constant Field Values

BY_ORBIT_COMMENT

public static final String BY_ORBIT_COMMENT
See Also:
Constant Field Values

DEFAULT_BY_ORBIT_COMMENT

public static final String DEFAULT_BY_ORBIT_COMMENT
See Also:
Constant Field Values

BY_TIME_SETUP

public static final String BY_TIME_SETUP
See Also:
Constant Field Values

DEFAULT_BY_TIME_SETUP

public static final double DEFAULT_BY_TIME_SETUP
See Also:
Constant Field Values

BY_TIME_DURATION

public static final String BY_TIME_DURATION
See Also:
Constant Field Values

DEFAULT_BY_TIME_DURATION

public static final double DEFAULT_BY_TIME_DURATION
See Also:
Constant Field Values

BY_TIME_COMMENT

public static final String BY_TIME_COMMENT
See Also:
Constant Field Values

DEFAULT_BY_TIME_COMMENT

public static final String DEFAULT_BY_TIME_COMMENT
See Also:
Constant Field Values

BY_PTF_SETUP

public static final String BY_PTF_SETUP
See Also:
Constant Field Values

DEFAULT_BY_PTF_SETUP

public static final double DEFAULT_BY_PTF_SETUP
See Also:
Constant Field Values

BY_PTF_DURATION

public static final String BY_PTF_DURATION
See Also:
Constant Field Values

DEFAULT_BY_PTF_DURATION

public static final double DEFAULT_BY_PTF_DURATION
See Also:
Constant Field Values

BY_PTF_COMMENT

public static final String BY_PTF_COMMENT
See Also:
Constant Field Values

DEFAULT_BY_PTF_COMMENT

public static final String DEFAULT_BY_PTF_COMMENT
See Also:
Constant Field Values

CLOBBER_OUTPUT

public static final String CLOBBER_OUTPUT
See Also:
Constant Field Values

DEFAULT_CLOBBER_OUTPUT

public static final boolean DEFAULT_CLOBBER_OUTPUT
See Also:
Constant Field Values

SUCCESS

public static final int SUCCESS
Exit status for a successful operation.

See Also:
Constant Field Values

FAILURE

public static final int FAILURE
Exit status for an unsuccessful operation.

See Also:
Constant Field Values
Method Detail

main

public static void main(String[] args)
Invokes an instance of Make_NIO_Series and processes the command-line arguments.

Usage

Make_NIO_Series [--configuration configuration_pathname] [--template template_id [--svt sequence]] [--duration duration] [--setup setup] [--band band] [--comment comment] [--shift shift] [--relative-timed-sequence] [--piggyback-threshold ] [--only-piggyback] [--do-not-skip-noproc] [--quiet] [--output output_file_pathname] [[--state-file] state_file_pathname] mode_parameters...

Make_NIO_Series --usage

Make_NIO_Series --version

Options are not case-sensitive and may be reduced to their shortest unique form. One or two dashes may be used.

Required Arguments

state_file_pathname
The name of the state file to use for resolving geometry observations. The filename must end with the "nk" extension. If Make_NIO_Series is run with a start time, a template applied, and an SVT sequence, the state file argument may be skipped; if so, observation geometry is not calculated and the output file is not a PTF, but an annotated list of observation IDs.
mode_parameters
The required mode parameters, which may be of one of the following forms:
start_orbit stop_orbit
The start and stop orbits, which are integers.
start_time stop_time spacing
The start time and stop time, which are standard UTC dates in day-of-year format (e.g., 2010-300T12:00:00), and a spacing parameter. The spacing parameter is a duration that includes an s, m, or h for seconds, minutes, or hours, respectively. For example, 495s is 495 seconds, and 1.5h is 1.5 hours.
start_time number spacing
The start time, which is a standard UTC date in day-of-year format, the number of observations (a simple integer), and the spacing parameter (see above).
input_ptf_pathname
An input PTF filename.

The order in which the required arguments appear is not important; they are identified strictly by their format.

Options

--configuration configuration_pathname
Sets the pathname of the configuration file from which to configure the application. See Configuration_Helper.getConfiguration(String,String,String...) for details on the configuration pathname; if this option is not used, the config source argument is null.
--template template_id
Sets the ID of the optional observation template to apply to each observation in the series.
--svt sequence
Sets the observation ID of each observation in the series to an SVT ID with the indicated sequence. The IDs start at 0000 and increment by 10 for each ID in the series; if the ID exceeds 0359, the next sequence is used and the counter resets to 0000. Can only be used with the --template option. Example: --svt 1000 produces SVT_001000_0000, SVT_001000_0010, etc.
--duration duration
Sets the observation duration for each observation in the series, overriding the defaults.
--setup setup
Sets the setup duration for each observation in the series, overriding the defaults.
--band band
Sets downlink band for each observation in the series, overriding the defaults.
--comment comment
Sets the PTF comment for each observation in the series, overriding the defaults.
--shift shift
Shifts each observation in the series by shift degrees. May only be used in by-orbit mode.
--relative-timed-sequence
Shifts each observation in the series by shift degrees. May only be used when combined with the --svt option, which also requires the --template option and which is only applicable to the by-time mode.
--piggyback-threshold duration
Sets the warmup threshold below which piggyback warmups are automatically created. If set to 0, no piggybacks will be created. May only be used with the by-ptf mode.
--only-piggyback
Sets the behavior of Make_NIO_Series to create only piggyback warmups, rather than attempting to create warmups before science images on an orbit. This option cannot be used in conjunction with a template or with the --do-not-skip-noproc option. May only be used with the by-ptf mode.
--do-not-skip-noproc
Creates observations on orbits that already contain a NOPROC target. May only be used with the by-ptf mode.
--quiet
Sets Make_NIO_Series to quiet mode.
--output output_ptf_pathname
Sets the output PTF filename, overriding the default name.
--state-file state_file_pathname
Specifies the optional state file. Note that the B<--state-file> switch is optional if the state filename ends with the ".nk" extension.

Parameters:
args - the command-line arguments.

HiRISE

Copyright (C) Arizona Board of Regents on behalf of the Planetary Image Research Laboratory, Lunar and Planetary Laboratory at the University of Arizona