amber_options

class amber_meta.amber_options.AmberOptions(rfim=True, rfim_mode='time_domain_sigma_cut', snr_mode='snr_mom_sigmacut', input_data_mode='sigproc', downsampling=False)

Class representing amber's command line options.

The class can be instanciated using default values, or by passing parameters as input. All command options will be availble via self.options.

>>> amber_options = AmberOptions(rfim=False, snr_mode='snr_mom_sigmacut', input_data_mode='sigproc', downsampling=False)
>>> amber_options.options
['print',
 'opencl_platform',
 'opencl_device',
 'device_name',
 'sync',
 'padding_file',
 'zapped_channels',
 'integration_steps',
 'integration_file',
 'compact_results',
 'output',
 'dms',
 'dm_first',
 'dm_step',
 'threshold',
 'snr_mom_sigmacut',
 'max_std_file',
 'mom_stepone_file',
 'mom_steptwo_file',
 'sigproc',
 'stream',
 'header',
 'data',
 'batches',
 'channels',
 'min_freq',
 'channel_bandwidth',
 'samples',
 'sampling_time',
 'subband_dedispersion',
 'dedispersion_stepone_file',
 'dedispersion_steptwo_file',
 'subbands',
 'subbanding_dms',
 'subbanding_dm_first',
 'subbanding_dm_step']

Parameters:

• rfim (bool (optional)) -- Default: True
• rfim_mode (str (optional)) -- RFIm mode of operation. Default: 'time_domain_sigma_cut'
• snr_mode (str (optional)) -- SNR mode of operation. Default: 'snr_mom_sigmacut'
• input_data_mode (str (optional)) -- Input data mode (sigproc's filterbank file or dada ringbuffer). Default: 'sigproc'
• downsampling (bool (optional)) -- Enable downsampling. Default: False

options_base

List of basic options

Type:list

options_tdsc

List of options for RFIm's time domain sigma cut

Type:list

options_fdsc

List of options for RFIm's frequency domain sigma cut

Type:list

options_rfim

Options to choose between RFIm modes

Type:dict

options_snr_standard

List of options for SNR standard

Type:list

options_snr_momad

List of options for SNR median of medians maximum absolute deviation

Type:list

options_snr_mom_sigmacut

List of options for SNR median of medians sigma cut

Type:list

options_SNR

Options to choose between SNR modes

Type:dict

options_downsampling

List of options for downsampling

Type:list

options_subband_dedispersion

List of options for subband dedispersion

Type:list

options_sigproc

List of options for sigproc data input

Type:list

options_dada

List of options for dada ringbuffer input

Type:list

options_input_data

Options to choose between input data modes

Type:dict