NAME

dbbuild tables - description of sensor and data logger parameter files for dbbuild

DESCRIPTION

dbbuild(1) uses parameter file descriptions of data loggers and sensors to help interactively build a database from scratch. The user must provide installation information like station (and perhaps channel) names, station location, sensor orientation, and sensor and data logger serial numbers. The user must also choose the data logger and sensor models from the list supported by dbbuild. When a particular model is not already supported, the user must first construct files which describe the data logger and/or sensor, and install these files in the proper directories.

Because the names of these files are saved into the calibration database table, the parameter file names must be less than 32 characters (not counting the .pf suffix).

This document describes the format of the data logger and sensor parameter files.

Sensor Descriptions

Sensor description files must provide the following information:

Data Logger Descriptions

Data logger description files provide the following information:

Equipment Specific Parameters

Some equipment comes with more precise gain information for each instrument. These gains may be used to replace the nominal gains in the instrument parameter files by creating separate parameter file named:

$ANTELOPE/data/instruments/sn/<dfile>/<serial-number>.pf

The dfile portion of the filename comes from a parameter in the default instrument parameter file; the serial number is the manufacturer's serial number for the equipment.

For sensors, this additional parameter file contains one array named sensitivity which has the sensitivity for each sensor output, indexed by the default axis labels in the standard sensor parameter file. For 3-component sensors, this is typically "Z", "N", and "E", so the serial number specific parameter file might be named $ANTELOPE/data/instruments/sn/sts2/sn.pf, and might look something like this:


sensitivity             &Arr{
E 17e-7
N 16e-7
Z 15e-7
}

For dataloggers, the additional parameter file is similar, containing an array named gains which has the gain for each datalogger input, indexed by the names of the leads. You must set up the scheme for identifying the leads. If the leads were named ch1, ch2 and ch3, then the serial number specific datalogger file might be named $ANTELOPE/data/instruments/sn/q730/sn.pf, and might look like:


gains  &Arr{
ch1 500
ch2 600
ch3 700
}

EXAMPLE

This is an example of a sensor parameter file. The response file is contained in the file $ANTELOPE/data/responses/example.

category	Imaginary Sensors
configuration	Neverland Standard

description     a non-existent sensor
dfile  		imaginary

rsptype V       # velocity instrument
band    b       # broad band

gtype           sensor
sensitivity     15e-7  # equivalent to 1500 V/m/sec sensor
iunits          nm/s
ounits          V

orientations    &Tbl{
Z       0       0
N       0       90
E       90      90
}

response        &datafile(responses/sts2)

Here's an example of a data logger parameter file which contains a possible_streams subroutine.

category	Imaginary Dataloggers
configuration	Neverland Standard

description     some non-existent data logger
dfile 		imaginary

streams         200sps 100sps 40sps 20sps 10sps 5sps 1sps

# definitions of streams
200sps  200  cf1 cf2 cf2 cf2 cf2 cf2 cf3
100sps  100  cf1 cf2 cf2 cf2 cf2 cf2 cf3 RT72A_2_f
40sps    40  cf1 cf2 cf2 cf2 cf2 cf2 cf3 RT72A_5_f
20sps    20  cf1 cf2 cf2 cf2 cf2 cf2 cf3 RT72A_5_f RT72A_2_f
10sps    10  cf1 cf2 cf2 cf2 cf2 cf2 cf3 RT72A_5_f RT72A_2_f RT72A_2_f
5sps      5  cf1 cf2 cf2 cf2 cf2 cf2 cf3 RT72A_5_f RT72A_2_f RT72A_2_f RT72A_2_f
1sps      1  cf1 cf2 cf2 cf2 cf2 cf2 cf3 RT72A_5_f RT72A_2_f RT72A_2_f RT72A_2_f RT72A_5_f

possible_streams &Literal{
    my @chosen = @_ ;
    my @ok = () ;
    my %chosen ;
    foreach (@chosen) {
        $chosen{$_} = 1 ;
    }
    if ( defined $chosen{"200sps"}
        || defined $chosen{"40sps"}
        || defined $chosen{"20sps"} ) {
        @ok = qw(200sps 40sps 20sps) ;
    } elsif ( defined $chosen{"100sps"}
        || defined $chosen{"10sps"}
        || defined $chosen{"5sps"}
        || defined $chosen{"1sps"} ) {
        @ok = qw(100sps 10sps 5sps 1sps) ;
    } else {
        @ok = qw(200sps 100sps 40sps 20sps 10sps 5sps 1sps) ;
    }
    return (@ok) ;
}

gains	526315  # in units of counts/volt

# Stages
a/d     &Arr{
samprate        102400
gtype           digitizer
iunits          V
ounits          counts
}

cf1     &Arr{
gtype   FIR_decimator
decifac 8
response        &datafile(responses/cf1)
}

cf2     &Arr{
gtype   FIR_decimator
decifac 2
response        &datafile(responses/cf2)
}

cf3     &Arr{
gtype   FIR_decimator
decifac 2
response        &datafile(responses/cf3)
}

RT72A_5_f       &Arr{
gtype   FIR_decimator
decifac 5
response        &datafile(responses/RT72A_5_f)
}

RT72A_2_f       &Arr{
gtype   FIR_decimator
decifac 2
response        &datafile(responses/RT72A_2_f)
}

SEE ALSO

dbbuild(1)
dbbuild_batch(5)

BUGS AND CAVEATS

If the manufacturer puts blanks in the serial number, this causes odd file names for instrument specific files.

AUTHOR

Daniel Quinlan

Table of Contents
Antelope Release 4.7 Darwin 7.9.0 2005-07-19
Boulder Real Time Technologies, Inc For more information, contact support@brtt.com