1. Introduction to FESTIVAL | 2. The interface | 3. Batch mode | 4. Hardware requirements

TOC > Batch mode > Command line parameters Previous | Next

3.1 Command line parameters

3.1.1 Arguments
3.1.2 Keywords

 

3.1 Command line parameters

The syntax of festival_batch_sequence is :

FESTIVAL_BATCH_SEQUENCE, probe_string, dateMin, dateMax, $
CONFIGURATION_FILE = configurationFile, $
SEQUENCE_DIRECTORY = seqDirectory, $
FILE_BASENAME = fileBaseName, $
ENCODE_MOVIE = encodeMovie, $
ENCODER_OPTIONS = encoderOptions, $
TIME_STAMP = TimeStamp, $
PASTE_ON = Paste, $
PASTE_ORDER = PasteOrder, $
ERASEFRAMES = eraseFrames, $
IMAGE_XSIZE = imageXsize, $
IMAGE_YSIZE = imageYsize, $
IMAGE_SCALE_FACTOR = imageScaleFactor,$
FOCUS_VIEWS_ON_THE_SUN = FocusViewsOnTheSun

3.1.1 Arguments

probe_string

A single string or an array of strings describing which probes should be used. Accepted values are 'STEREOA' (or 'A'), 'STEREOB' or ('B') and 'SOHO' (or 'S'). This parameter is not case sensitive, so 'stereoa', 'StereoA', or 'a' are accepted.

dateMin

The start date of the sequence to be processed, in the a format recognizable by the anytim2utc SSWIDL function. For example:

03-feb-2008 23:59:03
03-feb-2008
02/03/2008

dateMax

The end date of the sequence to be processed, in the a format recognizable by the anytim2utc SSWIDL function. For example:

04-feb-2008 12:29:03
04-feb-2008
02/04/2008

3.1.2. Keywords

CONFIGURATION_FILE

A string containgin the full name of the configuration file to use to create the sequence. If no configuration file is specified, the default configuration file is used.

SEQUENCE_DIRECTORY

A string containing the name of the directory where to save the sequence of images and/or the encoded movie. If no directory is specified, the default FESTIVAL_PROJECT/sequences/ directory is used.

FILE_BASENAME

A string containing the base to use when naming the images of a sequence. The images are named concatenating the base name, their order number, and the extension corresponding to the output file type.

ENCODE_MOVIE

Set this keyword if you want FESTIVAL to automatically encode the sequence of images into a movie. This keyword overrides the flag saved in the configuration file. Note that this requires mencoder to be installed on your machine.

ENCODER_OPTIONS

A string containing the encoding options to be passed to mencoder if the ENCODE_MOVIE keyword was set. This keyword overrides the option saved in the configureation file.

TIME_STAMP

Set this keyword if you want FESTIVAL to automatically add time stamps on the images.

PASTE_ON

Set this keyword if you want FESTIVAL to automatically paste the images from the different probes.

PASTE_ORDER

A string array defining the order used to paste the images. For example, to paste images with STEREOA on the left, SOHO in the middle and STEREOB on the right, use PASTE_ORDER = ['STEREOA', 'SOHO', 'STEREOB'']

ERASEFRAMES

Set this keyword if you want FESTIVAL to erase the individual frames (images) after encoding a sequence. Note that you should not select this option without setting the ENCODE_MOVIE keyword.

IMAGE_XSIZE

The width in pixels of the saved images. If this value is different from the size of the visualization GUI saved in the configuration file, the height of the images is adjusted so that the aspect ratio of the visualization GUI is maintained. This keyword should not be set along with IMAGE_YSIZE or IMAGE_SCALE_FACTOR.

IMAGE_YSIZE

The height in pixels of the saved images. If this value is different from the size of the visualization GUI saved in the configuration file, the width of the images is adjusted so that the aspect ratio of the visualization GUI is maintained. This keyword should not be set along with IMAGE_XSIZE or IMAGE_SCALE_FACTOR.

IMAGE_SCALE_FACTOR

A scale factor to be applied to the size of the visualization GUI saved in the configuration file. For example, if the configuration file has 1024x1024 images, setting this keyword to 0.5 let you save 512x512 images without having to save a new configuration file. This keyword should not be set along with IMAGE_XSIZE or IMAGE_YSIZE.

FOCUS_VIEWS_ON_THE_SUN

Use this keyword to reset the view saved in the configuration file to a position centered on the Sun, with a zoom factor corresponding to the solar radius defined in the system GUI.

 

Back to top