The cacheGetFilenames User Command

All user commands have the form:

ldasJob { -name {} -password {} -email {} } { userCmd -opt1 {} ... }

Which is in the format of a Tcl command, ldasJob, with two required arguments:

1. A Tcl list of user information consisting of username, password, and e-mail address. All fields must be filled or the command will be rejected.
   Client software which would like to receive responses from the LDAS system on a port instead of through email can provide a hostname:port combination as the email argument. A further feature of this method is that the hostname can be replaced with the magic key !host!, and the LDAS system will use the IP address it finds by doing a peername lookup on the connected socket.
2. A user command in the form of a Tcl list, for which there exists a "meta" macro file which can be expanded into Tcl code which can then be evaluated by the LDAS system.
   An argument need not be provided for every option. Some options have default values and these are described below as appropriate.
   Meta macros consist of a prototype declaration of the arguments for the given user command, and a template describing the calling order of API specific blocks of Tcl code which are concatenated into a larger block comprising the complete request, which can then be distributed by the assistant manager for interpretation by the low level API's.
   These API specific blocks are maintained as API specific macro files consisting of immediately interpretable Tcl code.

• cacheGetFilenames

• cacheGetFilenames

  Returns list of absolute paths to frame files.

  An exception is generated if the filename provided (or the calcualted filename when no explicit filename is provided) does not exist or is not readable due to permission problems.

  An e-mail with a URL pointing to the location of the results file is sent (-returnprotocol http or ftp is supported for retrieval of the file by mailcap/mime-types).

  Calling convention (all on a single line):

  ldasJob   { -name   "username"   -password   "********"   -email   "user@foobar.edu"}   {cacheGetFilenames   -ifos   IFO Abbrev   -types   frame type   -times   GPS times   -channels   list of channel names   -framequery   alternate syntax   -allowgaps   {Boolean}  (see dataPipeline) }

  Option Descriptions:

  -ifos:     Valid IFO

  Optional: defaults to best guess based on other options
  The argument of the -ifos option is a list of interferometer (ifo) abbreviations as used in the file naming convention and corresponding to the file name prefix of the frame files created from that interferometer. This option is used together with the -times and -types options.

  The -ifos option is being deprecated in favor of the -channels option, q.v.

  -types:     {}

  Optional: defaults to R
  The argument to the -types option is a list of frame types as used in the frame file naming convention. This corresponds to the second field of the frame file name. This option is used together with the -times and -ifos options to specify a frame file with the desired list of channels.

  -times:     Valid GPS time

  Optional: defaults to most recent file in directory
  The argument to the -time option is a GPS time for which frame data exists. This option is used together with the -frametype and -interferometer options to specify a frame file with the desired list of channels.

  -channels:     list of channel names

  
  The listing of channels is the preferred way of getting interferometer specifications into this command, and any included channel spec will override any explicit ifos spec.

  Alternate Syntax:

  The -framequery syntax is available as an aid to developing proper -framequery options for dataPipeline and other "real" user commands. The frame filenames returned will be identical to the ones made sent to the frame API in a dataPipeline user command using the same option.

  Example Commands (all equivalent):

  cacheGetFilenames -ifos H -types R -times 600000000-600000123
  
  cacheGetFilenames -channels H2:LSC-AS_Q -types R -times 600000000-600000123
  
  cacheGetFilenames -framequery { R H {} 600000000-600000123 Adc(H2:LSC-AS_Q) }
  

  Examples showing use of -allowgaps on frame data with gaps and ldas responses:

  
  cacheGetFilenames -times 693960000-693960032 -ifos H -types R_GAP_TEST -channels {} -allowgaps 1
  
  /scratch/test/frames/gap_test16/H-R_GAP_TEST-693960000-16.gwf
  /scratch/test/frames/gap_test16/H-R_GAP_TEST-693960032-16.gwf
  
  cacheGetFilenames -times 693960000-693960032 -ifos H -types R_GAP_TEST -channels {} -allowgaps 0
  
  returnFilenames.diskcache: cache::find: cache::findByTime:getFrameFiles_t(H R_GAP_TEST 693960000 693960032 0): 
  {{/scratch/test/frames/gap_test16/H-R_GAP_TEST-693960000-16.gwf /scratch/test/frames/gap_test16/H-R_GAP_TEST-693960032-16.gwf} 
  { {Gaps are detected: 693960016 693960032}}}
  
  cacheGetFilenames -framequery {R_GAP_TEST H {} {693960000-693960032} Adc() } -allowgaps 1
  
  /scratch/test/frames/gap_test16/H-R_GAP_TEST-693960000-16.gwf
  /scratch/test/frames/gap_test16/H-R_GAP_TEST-693960032-16.gwf
  
  cacheGetFilenames -framequery {R_GAP_TEST H {} {693960000-693960032} Adc() } -allowgaps 0
  
  returnFilenames.diskcache: cache::find: cache::findByTime:getFrameFiles_t(H R_GAP_TEST 693960000 693960032 0): 
  {{/scratch/test/frames/gap_test16/H-R_GAP_TEST-693960000-16.gwf /scratch/test/frames/gap_test16/H-R_GAP_TEST-693960032-16.gwf} 
  { {Gaps are detected: 693960016 693960032}}}
  

  Return to Top