CLI - V1

CLI, from the Astronomer's perspective
v.2

Primary Keywords

Primary Keyword Options Req. Setups Description
Receiver Rcvr_342
Rcvr_450
Rcvr_600
Rcvr_800
PF2
Rcvr1_2
Rcvr2_3
Rcvr4_6
Rcvr8_10
Rcvr12_18
Rcvr18_22
Rcvr22_26
Rcvr40_52
Holography Receiver
LO1
IFRack
Converter Rack
Analog Filter Rack
Backend Chooses the front-end of the system
Obs Type/Backend DCR_IF
DCR_AF
DCR_PF
SP
SP/PT
SP/PS
ACS
VLBI
Radar
BCPM
Viable combinations can also be used
(e.g. DCR+ACM, BCPM+SP)
IF Rack
Converter Rack
Analog Filter Rack
Backend Chooses the spectrometer, Spectral Processor, BCPM, VLBI, radar, or viable combinations of these.
Also sets the observing type (e.g. pulsar timing, spectroscopy) when applicable.
Note that the DCR has three input modes: the IF rack, the analog filter rack, and the Prime Focus receivers. The default should be the DCR_IF option.
Bandwidth(s)
Spectrometer, DCR_AF: 800, 200, 50, 12.5
Spectral processor: 40, 20, 10, 5, 2.5,
1.25, 0.625, 0.312, 0.156, 0.078
VLBA:any multiple of 4MHz,
up to 500MHz.
Radar:20MHz (no options)
BCPM:192 MHz (no options)
DCRF_IF options are:
PF1,PF2: 20,40,80,240
Rcvr1_2,Rcvr4_6,Rcvr8_10,
Rcvr12_15: 20,80,320,1280
All other Rcvrs: 80,320,1280
IF Rack
Converter Rack
Analog Filter Rack
Backend This would choose both the desired total bandwidth and the appropriate IF filters (This can be an array if more than 1 spectral window is called.)
Number of Spectral Windows [1],2,3,4 IF Rack
Converter Rack
Analog Filter
Backend This simply lists the number of spectral windows available for observing. The number available is dependent on the backend and the bandwidth, according to the following:
Spectrometer, DCR_AF at <10GHz, w/ slow samp.: max=8;
Spectrometer, DCR_AF at >10GHz, w/ slow samp.: max=4;
Spectrometer, DCR_AF w/ fast samp.: max=4;
Spectral Processor: max=4;
DCR_IF:1

Rest Frequenc(ies) An array of frequencies LO1 This is an array of frequencies, with one frequency for each spectral window. If more spectral windows are requested than frequencies given, the last frequency should be repeated to fill the windows. E.g. if No_windows=4 and rest_freq=[1420.5048] then each spectral window ends up with a center freq. of 1420.4058. The default should be one number equal to the center of the band for each receiver.


Primary Keywords

Primary Keyword	Options	Req. Setups	Description
Receiver	Rcvr_342 Rcvr_450 Rcvr_600 Rcvr_800 PF2 Rcvr1_2 Rcvr2_3 Rcvr4_6 Rcvr8_10 Rcvr12_18 Rcvr18_22 Rcvr22_26 Rcvr40_52 Holography	Receiver LO1 IFRack Converter Rack Analog Filter Rack Backend	Chooses the front-end of the system
Obs Type/Backend	DCR_IF DCR_AF DCR_PF SP SP/PT SP/PS ACS VLBI Radar BCPM Viable combinations can also be used (e.g. DCR+ACM, BCPM+SP)	IF Rack Converter Rack Analog Filter Rack Backend	Chooses the spectrometer, Spectral Processor, BCPM, VLBI, radar, or viable combinations of these. Also sets the observing type (e.g. pulsar timing, spectroscopy) when applicable. Note that the DCR has three input modes: the IF rack, the analog filter rack, and the Prime Focus receivers. The default should be the DCR_IF option.
Bandwidth(s)	Spectrometer, DCR_AF: 800, 200, 50, 12.5 Spectral processor: 40, 20, 10, 5, 2.5, 1.25, 0.625, 0.312, 0.156, 0.078 VLBA:any multiple of 4MHz, up to 500MHz. Radar:20MHz (no options) BCPM:192 MHz (no options) DCRF_IF options are: PF1,PF2: 20,40,80,240 Rcvr1_2,Rcvr4_6,Rcvr8_10, Rcvr12_15: 20,80,320,1280 All other Rcvrs: 80,320,1280	IF Rack Converter Rack Analog Filter Rack Backend	This would choose both the desired total bandwidth and the appropriate IF filters (This can be an array if more than 1 spectral window is called.)
Number of Spectral Windows	[1],2,3,4	IF Rack Converter Rack Analog Filter Backend	This simply lists the number of spectral windows available for observing. The number available is dependent on the backend and the bandwidth, according to the following: Spectrometer, DCR_AF at <10GHz, w/ slow samp.: max=8; Spectrometer, DCR_AF at >10GHz, w/ slow samp.: max=4; Spectrometer, DCR_AF w/ fast samp.: max=4; Spectral Processor: max=4; DCR_IF:1
Rest Frequenc(ies)	An array of frequencies	LO1	This is an array of frequencies, with one frequency for each spectral window. If more spectral windows are requested than frequencies given, the last frequency should be repeated to fill the windows. E.g. if No_windows=4 and rest_freq=[1420.5048] then each spectral window ends up with a center freq. of 1420.4058. The default should be one number equal to the center of the band for each receiver.

Secondary Keywords

Secondary Keyword Options
Req. Set-ups Description
Balance/Prepare T or F Receiver
LO1
IF Rack
Converter Rack
Analog Filter Rack
Backend When called, this would balance all of the powers
Beams [1], 2, 3, 4,
12, 34, 1234 Receiver
IF Rack
Converter Rack
Analog Filter Rack
Backend This is only applicable to the KU, K, and Q band receivers.
Velocity One number LO1
IF Rack
Converter Rack
Analog Filter Rack
Backend This is one number which determines the velocity info for the observation and sets the LOs/filters up accordingly. It is applied equally to all spectral windoew. The default should be 0.
Number of Polarizations X, Y, [XY] IF Rack
Converter Rack
Analog Filter Rack
Backend Chooses the number of polarizations for the observing.
Number of channels For spectrometer:
65536, 32768, 16384,
8192, 4096, 2048
For spectral processor:
1024, 512, 256
IF Rack
Converter Rack
Analog Filter Rack
Backend Applicable only for the spectrometer and spectral processor. The default should be the max. number available for the desired bandwidth, backend, and sampling level and number of beams.
IF Filters all, 3/20
3/80
3/320
3/1280
6/80
6/320
6/1280 IF Rack
Converter Rack
Analog Filter Rack
Backend This should be sure to check that (1) the desired bandpass fits within the chosen filter, and (2) The filter center matches the chosen receiver. The default should be chosen to be the minimum width for the desired bandwidth (+ some small amount based off the filter fall-off).
Cal Switching off
on-ext
lo-mcb
lo-ext
hi-mcb
hi-ext Receiver
Backend Turns on and off the various noise cals, and set the cal control. Cefault is 'off' for the BCPM and Radar and 'lo-ext' for all others. The "ext" vs. "mcb" options control wether the switching is controlled externally or if the cal is simply turned on.
Filters PF1 (Rcvr_342, Rcvr_450,
Rcvr_600, Rcvr_800):i
20, 40, 60, 80, 240
Rcvr1_2: Notch - in or out
PF2, Rcvr2_3, Rcvr4_6 : N/A
Rcvr8_10, Rcvr12_18: 500, 2400
Rcvr18_22, Rcvr22_26,
Rcvr40_52, Holography : N/A
Receiver Bandpass/notched filters available for each receiver. Default should be figured out from the receiver, bandwidth, and frequencies of interest
Polarization Type Linear
Circular Receiver Chooes the polarization type for the observing. Note that only the PF1, PF2, Rcvr1_2, Rcvr2_3, and Rcvr4_6 receviers have a choice (all other are circular). The default is circular for the BCPM, VLBI, and Radar backends, otherwise it is linear.
Cal [High]
Low
None Receiver Chooses the noise diode, when applicible
Frequency Offset(s) An array of frequencies LO 1 This is an array of offsets for the various spectral windows. As with the rest frequencies array, if more spectral windows are requested than frequency offsets given, the last offset should be repeated to fill the windows. The default is 0.
Velocity definition Radio
[Optical]
Relativistic LO1 This defines the velocity definition.
Rest Frame Local
Barycentric
Heliocentric
[LSR]
LSRD
Galactocentric LO1 This defines the rest frame of the system.
Converter Rack Switch [A],B,AB Converter Rack This just sets the converter rack switch
Switching mode/type [tp]
tp_nocal
fsw
fsw_nocal
bsw
bsw_nocal
psw
psw_nocal
tsw
tsw_nocal
bsw_thru
bsw_cross psw_cross Backend This defines the switching mode of the system, with the options being: Total Power, Total Power with no cal, frequency switched, frequency switched with no cal, beam switched, beam switched with no cal, polarization switched, polarization switched with no cal, tertiary switched, tertiary with no cal, and the last four options just set the switch for beam and polarization switching.
Sampling Level [9-] or 3-level Backend Applicable only for spectrometer, with the slow samplers. The options depend on bandwidth, # channels.
Integration Time Spectrometer:
1 quadrant: 0.5s - 40s
2 quadrant: 0.7s - 40s
3 quadrant: 1.0s - 40s
4 quadrant: 1.2s - 40s

SPS:1s-10s?
SPPT:?
SPPS:?
DCR: 0.01s - 60s
VLBI: ?
Radar: ?
BCPM: ?
Backend In spectral line or continuum mode, the default could be set to 1s. The pulsar, radar, and vlbi modes should demand and answer.
Cross Polarization Cross
[Parallel]
Both Backend Currently only applicable to the Spectral Processor. Eventually, the spectrometer will also do the cross products
Switching period A time in seconds Backend This defines the switching cycle period. The default depends on observing type:
Spectroscopy: 1s;
Continuum: 0.2s;
Pulsar: 0.04s;
Anything Else: 1s;

Switching Frequency An array Backend The frequency offsets for frequency switching mode


Secondary Keywords

Secondary Keyword	Options Req. Set-ups	Description
Balance/Prepare	T or F	Receiver LO1 IF Rack Converter Rack Analog Filter Rack Backend	When called, this would balance all of the powers
Beams	[1], 2, 3, 4, 12, 34, 1234	Receiver IF Rack Converter Rack Analog Filter Rack Backend	This is only applicable to the KU, K, and Q band receivers.
Velocity	One number	LO1 IF Rack Converter Rack Analog Filter Rack Backend	This is one number which determines the velocity info for the observation and sets the LOs/filters up accordingly. It is applied equally to all spectral windoew. The default should be 0.
Number of Polarizations	X, Y, [XY]	IF Rack Converter Rack Analog Filter Rack Backend	Chooses the number of polarizations for the observing.
Number of channels	For spectrometer: 65536, 32768, 16384, 8192, 4096, 2048 For spectral processor: 1024, 512, 256	IF Rack Converter Rack Analog Filter Rack Backend	Applicable only for the spectrometer and spectral processor. The default should be the max. number available for the desired bandwidth, backend, and sampling level and number of beams.
IF Filters	all, 3/20 3/80 3/320 3/1280 6/80 6/320 6/1280	IF Rack Converter Rack Analog Filter Rack Backend	This should be sure to check that (1) the desired bandpass fits within the chosen filter, and (2) The filter center matches the chosen receiver. The default should be chosen to be the minimum width for the desired bandwidth (+ some small amount based off the filter fall-off).
Cal Switching	off on-ext lo-mcb lo-ext hi-mcb hi-ext	Receiver Backend	Turns on and off the various noise cals, and set the cal control. Cefault is 'off' for the BCPM and Radar and 'lo-ext' for all others. The "ext" vs. "mcb" options control wether the switching is controlled externally or if the cal is simply turned on.
Filters	PF1 (Rcvr_342, Rcvr_450, Rcvr_600, Rcvr_800):i 20, 40, 60, 80, 240 Rcvr1_2: Notch - in or out PF2, Rcvr2_3, Rcvr4_6 : N/A Rcvr8_10, Rcvr12_18: 500, 2400 Rcvr18_22, Rcvr22_26, Rcvr40_52, Holography : N/A	Receiver	Bandpass/notched filters available for each receiver. Default should be figured out from the receiver, bandwidth, and frequencies of interest
Polarization Type	Linear Circular	Receiver	Chooes the polarization type for the observing. Note that only the PF1, PF2, Rcvr1_2, Rcvr2_3, and Rcvr4_6 receviers have a choice (all other are circular). The default is circular for the BCPM, VLBI, and Radar backends, otherwise it is linear.
Cal	[High] Low None	Receiver	Chooses the noise diode, when applicible
Frequency Offset(s)	An array of frequencies	LO 1	This is an array of offsets for the various spectral windows. As with the rest frequencies array, if more spectral windows are requested than frequency offsets given, the last offset should be repeated to fill the windows. The default is 0.
Velocity definition	Radio [Optical] Relativistic	LO1	This defines the velocity definition.
Rest Frame	Local Barycentric Heliocentric [LSR] LSRD Galactocentric	LO1	This defines the rest frame of the system.
Converter Rack Switch	[A],B,AB	Converter Rack	This just sets the converter rack switch
Switching mode/type	[tp] tp_nocal fsw fsw_nocal bsw bsw_nocal psw psw_nocal tsw tsw_nocal bsw_thru bsw_cross psw_cross	Backend	This defines the switching mode of the system, with the options being: Total Power, Total Power with no cal, frequency switched, frequency switched with no cal, beam switched, beam switched with no cal, polarization switched, polarization switched with no cal, tertiary switched, tertiary with no cal, and the last four options just set the switch for beam and polarization switching.
Sampling Level	[9-] or 3-level	Backend	Applicable only for spectrometer, with the slow samplers. The options depend on bandwidth, # channels.
Integration Time	Spectrometer: 1 quadrant: 0.5s - 40s 2 quadrant: 0.7s - 40s 3 quadrant: 1.0s - 40s 4 quadrant: 1.2s - 40s SPS:1s-10s? SPPT:? SPPS:? DCR: 0.01s - 60s VLBI: ? Radar: ? BCPM: ?	Backend	In spectral line or continuum mode, the default could be set to 1s. The pulsar, radar, and vlbi modes should demand and answer.
Cross Polarization	Cross [Parallel] Both	Backend	Currently only applicable to the Spectral Processor. Eventually, the spectrometer will also do the cross products
Switching period	A time in seconds	Backend	This defines the switching cycle period. The default depends on observing type: Spectroscopy: 1s; Continuum: 0.2s; Pulsar: 0.04s; Anything Else: 1s;
Switching Frequency	An array	Backend	The frequency offsets for frequency switching mode

Functions

Function Options Req. Set-ups Description
Spectral Processor Pulsar Mode
polyco.dat
Pulsar Period
Phase Duration
Phase Start
state
Spectral Processor Sets the info used in pulsar mode with the spectral processor
BCPM Set-up
bcpm1, bcpm2, bcpm1&bcpm2
0.5, 0.7, 1.0, 1.4, 1.74 [MHz - res.]
X1, X2, X4 [sample time]
yes, no [sum polarizations ? ]
BCPM Sets the mode for the BCPM (should be able to call with any combination of keywords.
VLBI Cal on, off, ext VLBI Backend Runs the cal for the VLBI backend
Test Tone on, off Receiver Turns on and off the test tone
Receiver prepare P, A, O N/A Prepares the in-use receiver, turns on "auto-prepare" for the receiver, or turns off "auto-prepare" for the receiver
LO1 power balance A, O N/A Turns on or off "auto-level" for the LO1
IF rack balance B, P, A, O N/A Balances, prepares, turns on "auto-prepare", or turns off "auto-prepare" for I.F. Rack
Converter rack prepare P, A, O N/A Prepares, turns on "auto-prepare", or turns off "auto-prepare" for Converter Rack
Analog Filter Rack prepare P, A, O N/A Prepares, turns on "auto-prepare", or turns off "auto-prepare" for Analog Filter Rack
Backend prepare B, NB, P, A, O N/A Turns on & off balance [spectrometer, spectral processor], prepares, turns on "auto-prepare", or turns off "auto-prepare" for chosen backend
Bad Hardware Any peice of hardware can be listed All systems potentially affected This allows the user to list (for his/her project only a piece of hardware which should be avoided in the signal path. If doing so block the ability to configure the system, and gigantic warning should be sent.
Active Surface on, off Active Surface Affected Only This just turns on and off the active surface. The default should be based off the receiver being used (e.g. its off for low frequencies and on for high frequencies)

Functions


Function	Options	Req. Set-ups	Description
Spectral Processor Pulsar Mode	polyco.dat Pulsar Period Phase Duration Phase Start state	Spectral Processor	Sets the info used in pulsar mode with the spectral processor
BCPM Set-up	bcpm1, bcpm2, bcpm1&bcpm2 0.5, 0.7, 1.0, 1.4, 1.74 [MHz - res.] X1, X2, X4 [sample time] yes, no [sum polarizations ? ]	BCPM	Sets the mode for the BCPM (should be able to call with any combination of keywords.
VLBI Cal	on, off, ext	VLBI Backend	Runs the cal for the VLBI backend
Test Tone	on, off	Receiver	Turns on and off the test tone
Receiver prepare	P, A, O	N/A	Prepares the in-use receiver, turns on "auto-prepare" for the receiver, or turns off "auto-prepare" for the receiver
LO1 power balance	A, O	N/A	Turns on or off "auto-level" for the LO1
IF rack balance	B, P, A, O	N/A	Balances, prepares, turns on "auto-prepare", or turns off "auto-prepare" for I.F. Rack
Converter rack prepare	P, A, O	N/A	Prepares, turns on "auto-prepare", or turns off "auto-prepare" for Converter Rack
Analog Filter Rack prepare	P, A, O	N/A	Prepares, turns on "auto-prepare", or turns off "auto-prepare" for Analog Filter Rack
Backend prepare	B, NB, P, A, O	N/A	Turns on & off balance [spectrometer, spectral processor], prepares, turns on "auto-prepare", or turns off "auto-prepare" for chosen backend
Bad Hardware	Any peice of hardware can be listed	All systems potentially affected	This allows the user to list (for his/her project only a piece of hardware which should be avoided in the signal path. If doing so block the ability to configure the system, and gigantic warning should be sent.
Active Surface	on, off	Active Surface Affected Only	This just turns on and off the active surface. The default should be based off the receiver being used (e.g. its off for low frequencies and on for high frequencies)