Chapter 5. SRF File Tools

Table of Contents

5.1. download_srf
5.2. batch_preprocess_srf
5.3. preprocess_srf
5.4. srf2sms

5.1. download_srf

5.1.1. Purpose

Download SRF file from HeliScope from command-line.

5.1.2. Parameters

Synopsis:
     download_srf.pl [OPTIONS] COMMON_PARAMETERS [--intermediate=0] FLOWCELL_CHANNEL_SPECIFICATION
     download_srf.pl [OPTIONS] COMMON_PARAMETERS --intermediate=1
     download_srf.pl --help

Required Common Parameters:
   --instrument_name=arg               instrument name (e.g. P3)
   --instrument_domain_name=arg        domain name (or IP address) of instrument system server (e.g. P3.hbsc.local or
                                       122.12.10.103)
   --run_integer_id=arg                run integer id (e.g. 10048)
   --run_id=arg                        the datetime-like run id (e.g. 2009-03-11T17_14_13)

DataSet Specification (for intermediate SRF download):
  Required:
   --intermediate=1                    download intermedite (during run) SRF file consisting of QC imaging positions only
                                       [DEFAULT: 0]

DataSet Specification (for normal SRF download):
  Required:
   --flow_cell_1_barcode=arg           barcode for flowcell 1 [OPTIONAL if only flowcell 2 channels are requested]
   --flow_cell_2_barcode=arg           barcode for flowcell 2 [OPTIONAL if only flowcell 1 channels are requested]
  Optional:
   --flow_cell_1_channels=arg          comma-delimited set of channels for flow cell 1 (if any)
                                       [DEFAULT: all (none if --flow_cell_2_channels specified]
   --flow_cell_2_channels=arg          comma-delimited set of channels for flow cell 2 (if any)
                                       [DEFAULT: all (none if --flow_cell_1_channels specified]

Options:
   --force=[0|1]                       overwrite existing files [DEFAULT: 1]
   --output_directory=arg              output directory for downloaded SRF files [DEFAULT: current working directory]

General Options:
   --verbose=arg                       verbocity level [DEFAULT: 0]
   --debug=arg                         debug flag [0|1] [DEFAULT: 0]

   --help                              print this help message

5.1.3. Output

  • For a midrun analysis (--intermediate=1) output is written to a single file named <output_directory>/<instrument_name>.<run_id>+.intermediate.srf+
  • Otherwise one file per channel is written to files named <output_directory>/<instrument_name>.<run_id>.<barcode>+.fc_+<flow_cell_number(1 or 2)>+.ch_+<channel>+.srf+.