NRAO Home  >  Green Bank  |  Wiki Topic:    GB > Knowledge > ConfigurationAPI > ConfigKeywords
   Readme | Changes | Index | Search | Go

Configuration Keywords

  Main     Usage     Requests     Updates     Examples  

The configuration tool configures the GBT based on the values of keywords supplied by the user. The configuration "through keyword" is an attempt to place the configuration of the gbt into the astronomical dimension instead of that of the gbt hardware device domain. As such, it is our hope that the keywords require little explanation. The tables below briefly describe configuration keywords and thier legal and default values. Table 1 lists the primary keywords that are required and have no default values. Table 2 lists primary keywords for which reasonable default values exist. Note that in many cases, possible values of a keyword depend on the type of backend or observing type. Tables 3 and 4 contain secondary keywords that are specific to particular receivers or back ends. Note that if you specify backends "Spectrometer", "SpectralProcessor", or "BCPM", you must also specify keywords for those backends given in Table 3. Table 5 gives the possible bandwidth choices, which depend on the backend and receiver.

Detailed information concerning the spectrometer mode dependencies on keyword values can be found on the spectrometer mode wiki page

An explanation of how the keywords are used to set up multiple frequency bands may be helpful.

Primary Keywords

Table 1: Primary Keywords with No Default Values

Keyword Description Possible values
receiver Name of GBT Receiver Rcvr_342, Rcvr_450, Rcvr_600, Rcvr_800, Rcvr_1070, Rcvr1_2, Rcvr2_3, Rcvr4_6, Rcvr8_10, Rcvr12_18, Rcvr18_22, Rcvr22_26, Rcvr_26_40, Rcvr40_52, NoiseSource
obstype Observing Type Continuum, Spectroscopy, Pulsar, Radar, VLBI
backend Name of Data Acquisition System DCR, DCR_AF, SpectralProcessor, Spectrometer, VLBA_DAR, Radar, LLRADAR, BCPM, BCPM/SPIGOT, GASP, CGSR2, JPL_RSR
restfreq A list of up to 8 frequencies in MHz. Any frequency supported by the chosen receiver. (Note that the LO1 system can only track one frequency. The first frequency in the list will be tracked.)
bandwidth Band width per backend input, in MHz. The possible values depend on the backend and the receiver -- see Table 5.

Table 2: Primary Keywords with Default Values

Table 2: Primary Keywords with Default Values
Keyword Description Possible values Default
swmode Switching mode tp(total power with cal), tp_nocal, sp(switched power with cal), sp_nocal tp
swtype For switching modes sp and sp_nocal, this is the type of switching. This parameter is not used for tp and tp_nocal modes. none, fsw(frequency switching), bsw(beam switching), psw(polarization switching), tsw(tertiary switching) Depends on Swmode.
swper Switching cycle period. A time in seconds. Depends on Obstype.
swfreq Frequency offsets used for frequency switching. A pair of frequencies in MHz. (-0.25*Bandwidth, +0.25*Bandwidth) for fsw, (0,0) otherwise
tint Back end integration time. A time in seconds. Depends on the Backend.
beam Beam selection: applies to multi-beam receivers. 'B1', 'B2', 'B3', 'B4', 'B12' (both beams 1&2), 'B34', 'B1234' B1
nwin Number of frequency windows 1, 2, 3, 4, 6, 8 1
deltafreq Table of sky frequency offsets for each spectral window. Note these are applied in the topocentric frame (see explanation.) List of Nwin frequencies, in MHz. zero (i.e., no offsets) If specified, it must have nwin elements and be the same size as the restfreq list.
vlow * minimum of all source velocities or Z(if vdef=Red) km/sec 0
vhigh * maximum of all source velocities or Z(if vdef=Red) km/sec 0
vframe Velocity reference frame. topo bary lsrk lsrd galac cmb topo
vdef ** Velocity definition. Optical Radio Relativistic Red Radio
iftarget desired IF power level 0.2 to 9 volts 1 volt for 0-12GHz receivers, 3 otherwise

* Note: "vlow" and "vhigh" give the range of velocities of all sources to be observed. This information is used to set various filters in the system to admit the required range of frequencies. Setting the velocity for each specific source is done later in the GO Table or GO GUI. For galactic sources it is usually best to set both vlow and vhigh to zero. Consult frequency windows introduction for more information.

** Note: if vdef="Red" (i.e., redshift), then you must give the redshift parameter "Z" as the values for "vlow" and "vhigh" instead of velocity. In this case, the velocity definition will be optical.

Secondary Keywords

Secondary keywords specify options that are specific to particular receivers or back ends. If you are not using a backend or receiver that uses a secondary keyword, then it need not be specified.

Table 3: Keywords Dependent on the Back End

Backend Keyword Name Description Possible Values
Spectral Processor sp.mode Parallel or Cross polarization products or both 'Square', 'Cross', 'SqrCross'
Spectral Processor sp.polyco Name of polyco file used for pulsar observing. valid file path
Spectral Processor nchan Number of spectral channels per IF 1024, 512, 256
Spectrometer spect.levels Number of levels 3 or 9
Spectrometer spect.crosspol Turns on/off cross poloraization products Set to 'y' for cross polarization products
Spectrometer nchan Number of spectral channels. Given the bandwidth, number of levels, number of spectral windows, and beams, there are up to 3 choices of the number of spectral channels available. This parameter chooses which of the possibilities are to be used. Refer to the SpectrometerModes page to see the number of channels corresponding to this parameter. 'low', 'medium', or 'high'
Spectrometer spect.numbanks (optional) Requested number of spectrometer banks. In most cases there is only one choice and the config tool chooses the default. There are a few cases in which one may choose an alternate number of banks. Refer to the SpectrometerModes page for details. None(tool choose the default), 1, 2, or 4
BCPM bcpm.submanager The name of the computer controlling the BCPM 'bcpm1', 'bcpm2', or 'bcpm1_and_bcpm2'
BCPM bcpm.hardware Which hardware rack is being used. 'bcpm1', 'bcpm2', or 'bcpm1_and_bcpm2'
BCPM bcpm.ch_bw channel bandwidth 0.5, 0.7, 1.0, 1.4, or 1.74 MHz
BCPM bcpm.sample_time The sample time 'X1', 'X2', or 'X4'
BCPM bcpm.sum_pol Chooses whether to sum the polarizations 'Yes' or 'No'
BCPM bcpm.source_name Name of source to be observed. 'needs_to_be_defined'
VLBI vlbi.phasecal Turn phase cal on or off 'off' 'M1' 'M5'

Table 4: Keywords Dependent on the Receiver

Keyword Receiver(s) Default Possible values
pol Prime Focus, Rcvr1_2, Rcvr2_3, Rcvr4_6 Default is Circular for VLBI or Radar back ends, otherwise Linear 'Linear' or 'Circular'
noisecal All receivers but hi/lo option not available for Rcvr12_18 and higher 'lo-ext', except for BCPM and Radar = 'off' 'off', 'on-mcb', 'on-ext', 'lo-mcb', 'hi-mcb', 'lo-ext', 'hi-ext', 'lo', 'hi'
notchfilter Rcvr1_2 'In' 'In' or 'Out'
xfer Beam transfer switch for Rcvr12_18, Rcvr18_26, and Rcvr40_52 If Swtype is 'bsw', then 'ext', otherwise 'thru' 'ext', 'thru', or 'cross'
polswitch Pol transfer switch for Rcvr1_2 If Swtype is 'psw', then 'ext', otherwise 'thru' 'ext', 'thru', or 'cross'
chopper Rcvr40_52 'off' 'off', or 'on'

Table 5: Choices of backend bandwidth.

Backend Receiver Possible Bandwidths
Spectrometer Any 12.5, 50, 200, 800 MHz
Spectral Processor Any 40, 20, 10, 5, 2.5, 1.25, 0.625, 0.3125, 0.15625, 0.078125 MHz
DCR, BCPM, VLBI, or Radar Prime Focus 20, 40, 80, 240 MHz
DCR, BCPM, VLBI, or Radar Rcvr1_2, Rcvr4_6, Rcvr8_10, Rcvr12_18 20, 80, 320, 1280 MHz
DCR, BCPM, VLBI, or Radar Rcvr2_3, Rcvr18_26, Rcvr40_52 80, 320, 1280 MHz
DCR_AF Any 12.5, 50, 200, 800 MHz

You will be warned if you do not choose one of the specified bandwidths for the Spectrometer, Spectral Processor, or DCR_AF. Otherwise the configuration software will let you set any value for the bandwidth, and will set the appropriate filters for the next larger size that will work. You can specify a bandwidth greater than the maximum (1280 MHz for example) and it will set the IF filters to all pass, so that the full band of the front end LNAs will get through.

-- MelindaMello - 24 Sep 2003

Table 6: Expert Options: override standard settings.

These keywords provide custom settings of frequency conversion and IF bandwidth. Of course you need to be very familiar with the LO/IF system to make good use of these.

Keyword Description
ifbw Total IF bandwidth, in MHz. Sets the bandpass filters in the IF Rack, and also in the receiver, if any
if0freq Frequency (MHz) of center of window #1 after first mixer.
lo1bfreq Frequency (MHz) of 2nd mixer (LO1B) for KA and W band receivers.
lo2freq A list of nwin frequencies (MHz) for the LO2 synthesizers .
if3freq A list of nwin frequencies (MHz): overrides the standard IF3 of the backend.

WebForm
TopicClassification: NoDisclosure
OperatingSystem:
OsVersion:

Topic ConfigKeywords . { Edit | Attach | Ref-By | Printable | Diffs | r1.20 | > | r1.19 | > | r1.18 | More }
Revision r1.20 - 22 Sep 2005 - 19:35 GMT - MelindaMello
Parents: ConfigurationAPI
Content copyright © 1999-2007 by the contributing authors.
All material on this collaboration platform is the property of the contributing authors.

Knowledge.ConfigKeywords moved from Knowledge.KeyWords on 10 Oct 2003 - 15:17 by FrankGhigo - put it back