Module documentation
Module author: Arthur Corstanje <a.corstanje@astro.ru.nl>
-
class pycrtools.tasks.findrfi.FindRFI(ws=None, parfile=None, **kwargs)
Find RFI by creating an average spectrum and doing phase magic.
Input parameters
- apply_hanning_window [default value: True ]
- Apply Hanning window to data before FFT.
- bandpass_filter [default value: None ]
- Optional bandpass filter to multiply with.
- blocksize
- Blocksize.
- dataloss_threshhold [default value: 10 ]
- NOF consecutive zeros in timeseries to be considered due to dataloss.
- f
- File object.
- fft_data
- Fourier transform of timeseries_data_resampled.
- filename [default value: None ]
- Filename, used if no file object is given.
- flag_range_antennas [default value: [0.5, 2.0] ]
- Multiples of median power between which an antenna is considered good.
- freq_range [default value: None ]
- Optional frequency range to consider; everything outside the range is flagged as ‘bad’. Give as tuple, e.g. (30, 80)
- hanning_fraction [default value: 1.0 ]
- Fraction of the window to Hanning filter (at beginning and end of timeseries) 0.2 is 10% at both ends.
- nantennas
- Number of selected antennas.
- nfreq
- Number of frequencies in FFT.
- nofblocks [default value: -1 ]
- Number of data blocks to process. Set to -1 for entire file.
- plot_antennas
- Antennas to create plots for.
- plot_prefix [default value: “” ]
- Prefix for plots
- plot_title [default value: True ]
- Plot with or without title (for publication)
- plot_type [default value: “png” ]
- Plot type (e.g. png, jpeg, pdf)
- plotlist [default value: [] ]
- List of plots
- refant [default value: None ]
- Optional parameter to set reference antenna number.
- save_plots [default value: False ]
- Store plots
- sigma [default value: 0 ]
- Sigma value used for threshold of bad antennas. This is used toguether with the flag_range_antennas method.
- startblock [default value: 0 ]
- Start processing file at this block nr.
- testplots [default value: False ]
- Show test plots.
- verbose [default value: True ]
- Verbose output.
Output parameters
- antennas_cleaned_power [default value: None ]
- Cleaned power (sum of squares) from cleaned spectrum, per antenna.
- antennas_cleaned_sum_amplitudes [default value: None ]
- Cleaned sqrt(power) summed from cleaned spectrum, per antenna.
- average_spectrum [default value: None ]
- Average power spectrum (ADC units) per antenna, uncleaned. Dim = [nantennas, nfreq]
- bad_antennas [default value: [] ]
- Antennas found to be bad.
- blocks_with_dataloss [default value: 0 ]
- Blocks that have been found to contain dataloss.
- cleaned_spectrum [default value: None ]
- Cleaned power spectrum per antenna.
- dirty_channels [default value: [] ]
- List of channels found to contain RFI
- good_antennas
- Antennas found to be good.
- median_average_spectrum [default value: None ]
- Average power spectrum, in ADC units, uncleaned (raw data). Median over antennas is taken; dimension = [nfreq].
- median_cleaned_spectrum [default value: None ]
- Cleaned power spectrum. Equals average_spectrum, but with dirty_channels set to zero.
- median_phase_spreads [default value: None ]
- Median over antennas, of the phase spread measure from all blocks. Dimension = [nfreq]
- phase_RMS [default value: None ]
- RMS phase spread for each antenna, per frequency. Can be passed to RF calibration Task. Dimension = nantennas x nfreq
- phase_average [default value: None ]
- Average phases per antenna, per frequency. Can be passed to the RF calibration Task. Dimension = nantennas x nfreq
-
run()
Run the task.