|
|
ldasJob { -name {} -password {} -email {} } { userCmd -opt1 {} ... }
Which is in the format of a Tcl command, ldasJob, with two required arguments:
Returns reduced data set of requested frames.
Note that when resampling of an Adc channel is requested, the resultant output structure will be of Proc type. When resampling is not requested for a given Adc channel, the channel will remain an Adc and will be unmodified, with all channel metadata intact.
Calling convention (all on a single line):
ldasJob { -name "username" -password "********" -email "user@foobar.edu"} {createRDS -times { time_range } -ifo interferometer i.d. -type frame file type -channels {Tcl list} -framequery {Tcl list of lists} -usertype string -outputdir output_directory -usejobdirs use per-job subdirectories -compressiontype type_of_compression to perform -compressionlevel level_of_compression -framesperfile number_of_frames_per_RDS_frame_file -secperframe dt_of_each_RDS_frame -filechecksum Bool -framechecksum Bool -frametimecheck Bool -framedatavalid Bool -allowshortframes Bool -generatechecksum Bool -fillmissingdatavalid Bool -metadatacheck Bool -md5sumregexp sed-like substitution to get md5sum directory from output directory }
Option Descriptions:
-times: { 600000000-600000015 }
-ifo: L and H are common examples
-type: R for raw data. See frame naming
convention.
-channels: { H2:SUS-MC1_COIL_UL!2 H1:LSC-AS_Q }
This option is a space-separated list of frame channel names which
should be retrieved. Each channel can have optional resample factor
using the ! syntax:
H2:SUS-MC1_COIL_UL!2
Allowed resample factors:
1 (no resampling), 2, 4, 8, 16.
Note that resampled Adc channels will be represented as Proc
channels in the output frames!
-framequery: { R H {} t1-t2 Chan(H1_F00!4,H1_B4R) }
This option takes as it's argument a Tcl list-of-lists five elements long.
With succeeding channels seperated by commas, and channels supporting
resampling using the '!' operator as described above.
The actual channels contained in the output frames will be the union of
channels matched by the channel spec in combination with the list of
ifos and frame_types. This means that if, for example, raw and reduced
frames both from a single site are specified by the combination of
ifos and types, then the output frames will have two sets of the
channels common to both.
The -framequery option is intended to supercede the -times, -type, and
-ifo options. Please do not mix the two options in your user command.
Simply do not declare the options that you do not intend to use.
-usertype: string
Allows the user to specify a type to be used in constructing
the output frame names. The specified type will be supplemented with
an integer value representing the level of the RDS data (RDS data
created from raw frames has a level of 1, RDS data created
from RDS level 1 data has a level of 2, and so on).
For example, specifying -usertype foobar and using raw frames
for input will result in an output type of foobar1. Specifying
-usertype foobar and using the previously created foobar1
frames as input will result in an output type of foobar2.
If the type specified by the -usertype option ends in a numeric,
then the numeric will be used as the level. Using foobar1 from the
previous example and specifying -usertype foobar3, results in an
output type of foobar3.
If the -usertype and the -type options have the same base
(another words they only differ only by level), then the level specified
by -usertype must be greater than the level specified by
type.
A request that would result in the overwriting of existing data will
raise an exception and no output will result.
Default: NONE, use default RDS output type.
Note: Specifying a unique type will help ensure that LDAS finds
the intended frames in a -framequery option of an LDAS job.
This option is very useful when creating merged RDS frames (i.e. frames
containing multiple IFO data). It will help LDAS find the correct
multi-IFO RDS frames and not other single-IFO RDS frames which may
otherwise be named similarly.
-outputdir: output_directory
This option applies when the user desires
result frames to be written to a special directory provided
for the purpose of collecting reduced data sets.
Default: job directory.
-usejobdirs: 0 or 1
When this flag is set to 1, there will be a new
subdirectory created under the outputdir for each new job
when the -outputdir option is also specified.
Default: 0
-compressiontype: {raw, gzip, gzip_diff,
zero_suppress_short, zero_suppress_int_float,
or zero_suppress_otherwise_gzip}
This option allows the user to specify the type of compression
to perform on all FrVect structures of the generated frame.
Default:gzip
This option allows the user to specify the level of compression
for compression types that support multiple levels.
Gzip and gzip_diff support comprssion levels 1-6,
"raw" does not support any levels. If a compression type does
not support multiple levels, this option is quietly ignored.
Default: 1
-framesperfile: integer number of frames
This option allows the user to specify the number of frames in each
output RDS frame file.
Default: 1
-secperframe: dt of output frames
This option allows the user to specify the dt of RDS output frames.
Default: same dt as inout frames
-filechecksum: Bool
This option is used to validate frame files by comparing the internal
frame file checksum and validating it against a calculated checksum.
If -filechecksum is set to '1', and the calculated checksum does not
match the internal checksum (or if the internal checksum is missing),
a fatal exception will result, causing the user command to abort.
Default: 0
-framechecksum: Bool
This option is used to validate frame files by comparing the individual
contained frame checksums and validating each against a calculated
checksum.
Default: 0
-frametimecheck: Bool
This option is used to verify that the times represented by all
Adc data sets contained within a frame file are represented properly
by the frame file name. The timestamp and dt components of the
frame file name must properly bound or contain the time ranges
of all contained frame objects or a fatal exception will result,
causing the user command to be aborted.
Default: 1
-framedatavalid: Bool
This option controls the querying of the data validity flag for all
accessed frame data structures. When this option is set to '1'
(the default) and the data validity flag of any referenced data
in a frame file is found to be set to '0', a fatal exception will
occur, resulting in the user command being aborted.
Default: 1
-fillmissingdatavalid: Bool
The new degrees of freedom available for the creation of RDS frames
with time durations differing from their input frames created a need
for fine-grained reporting of data run validation.
Default: 0
-metadatacheck: Bool
This flag controls the checking of the frame's metadata (leap second,
conformance to the frame naming convention, etc.). If set to 1 (true),
then the additional checks will be performed.
Default: 0
-allowshortframes: Bool
This option can be used to allow a createRDS command to generate
short frames to work around a gap in the input frame data.
Default: 0
This option is a gps time range of requested frame data, i.e.
600000000-600000015 represents 16 seconds of data.
If channel resampling is requested, two extra frames will be provided by
the diskcacheAPI: at the beginning and at the end of the requested time range.
These frames will be gps seconds alligned. The very first frame is used
by the frameAPI to initialize the resampling state. The suffix frame
is used to fill in missing data due to the time offset caused by the
resampling. If supplied, these two extra frames do not contribute to the
total number of result frames.
The interferometer is implicit in the channel name, and LDAS now
extracts the interferometer spec from the channel names, so this
option is no longer required.
This option is the type of the frames which
should be retrieved. The type refers to the frame attribute
referenced by the second field in the proposed frame spec.
The elements are, in order:
frame_types ifos filenames timerange channels
Where the channels element is not used as a list, but is a
specially formatted string using the key 'Chan', like this:
Chan(H1_F00!4,H1_B4R)
-compressionlevel: dependent on -compressiontype option
Compression Name Description raw The data is not compressed. gzip The data is compressed using the gzip algorithm diff_gzip The data is differentiated and then gzipped zero_suppress_short Data which is composed of 2 byte
integers is differentiated and then zero suppressed.
All other data types are left uncompressed.
This mode does not imply zero_suppress_int_float.
zero_suppress_int_float For 4 byte integers or float data,
the data is differentiated and then zero suppressed.
If the data is 2 byte integers, the compression mode is modified to
be zero_suppress_short.
All other data types are left uncompressed.
zero_suppress_otherwise_gzip
All data types that support zero suppress compression are compressed
using that method.
All other data types are compressed using gzip.
Note that this is the checksum for the overall file that is being
opened, not the checksum of the individual contained frames.
The default is '0' because there are a large number of frame files
which are missing checksums or which have incorrectly calculated
checksums.
The default value is controlled via the frame API resource variable
::FRAMEFILECHECKSUM_FLAG.
If -framechecksum is set to '1', and the calculated checksums do not all
match the internal checksums (or if an internal checksum is missing),
a fatal exception will result, causing the user command to abort.
The default is '0' because there are a large number of frame files
which are missing checksums or which have incorrectly calculated
checksums.
The default value is controlled via the frame API resource variable
::FRAMECHECKSUM_FLAG.
The default value is controlled via the frame API resource variable
::FRAMETIMECHECK_FLAG.
Note that contained Proc data sets are NOT checked.
The default value is controlled via the frame API resource variable
::FRAMEDATAVALID_FLAG.
The current model utilizes a bit array with a validity flag for each
1/16th second of data in each channel with a sample rate greater than
or equal to 16 Hz.
This option controls whether datavalid bit vectors are generated for the
channels in output frames.
The default value is controlled via the frame API resource variable
::FRAMEFILLDATAVALID_FLAG.
The default value is controlled via the frame API resource variable
::FRAMEMETADATACHECK_FLAG.
The default value is controlled via the frame API resource variable
::FRAMEALLOWSHORT_FLAG.
Return to Top