Pulse envelope
Module author: Pim Schellart <p.schellart@astro.ru.nl>
-
class pycrtools.tasks.pulseenvelope.PulseEnvelope(ws=None, parfile=None, **kwargs)
Calculate pulse envelope using a Hilbert transform.
Optionally the envelope will be (up/down)sampled using the resample_factor and the delays between the
peak_amplitude will be computed with respect to a reference antenna that is either given or taken to be the one
with the highest signal to noise.
Input parameters
- antennas_with_significant_pulses
- Indices of antennas with pulses more than nsigma above the noise limit.
- estimate_timing_error [default value: False ]
- Estimate timing error by adding estimate_timing_nsteps random noise blocks to the data and finding the pulse maximum in each case.
- estimate_timing_nsteps [default value: 10 ]
- Number of steps for timing error estimation shifting.
- estimate_timing_std [default value: None ]
- Estimated timing error as the standard deviation of estimate_timing_timediff per antenna.
- estimate_timing_stepsize [default value: 1e-07 ]
- Stepsize for timing error estimation shifting in seconds.
- extra [default value: False ]
- Calculate non essential extras (integrated pulse power & stokes parameters).
- fft_data
- Fourier transform of timeseries_data_resampled.
fftwplan
ifftwplan
- nantennas
- Number of antennas.
- nsigma [default value: 3 ]
- Number of standard deviations that pulse needs to be above noise level in order to be accepted as found.
- plot_antennas
- Antennas to create plots for.
- plot_prefix [default value: “” ]
- Prefix for plots
- plot_title [default value: True ]
- Plot title, turn off for publication ready figures.
- plot_type [default value: “png” ]
- Plot type (e.g. png, jpeg, pdf)
- plotlist [default value: [] ]
- List of plots
- pulse_end
- End of pulse window.
- pulse_start [default value: 0 ]
- Start of pulse window.
- pulse_width
- Width of pulse window.
- resample_factor [default value: 1 ]
- Factor with which the timeseries will be resampled, needs to be integer > 0
- sampling_frequency [default value: 200000000.0 ]
- Sampling frequency of timeseries_data.
- save_plots [default value: False ]
- Store plots
- timeseries_data [default value: None ]
- Timeseries data for all antennas, hArray of shape: [nAntennas,nSamples]
- timeseries_data_resampled
- Resampled timeseries data.
- window_end
- End of window.
- window_start
- Start of window.
- window_width
- Width of full window.
- window_width_resampled
- Width of pulse window after resampling.
Output parameters
- best
- Antenna with highest signal to noise.
- bestpos
- Position of pulse maximum relative to pulse_start in antenna with highest signal to noise.
- delays
- Delays corresponding to the position of the maximum of the envelope relative to the first antenna.
- envelope
- Envelope calculated using Hilbert transform.
- estimate_timing_maxpos
- Position of pulse maximum relative to pulse_start for each of the timing estimates.
- estimate_timing_timediff
- Position of pulse maximum relative to data start in seconds for each of the timing estimates.
- hilbertt
- Hilbert transform of fft_data.
- integrated_noise_power
- Integrated noise power per sample.
- integrated_noise_power_double_wide
- Integrated noise power per sample.
- integrated_noise_power_wide
- Integrated noise power per sample.
- integrated_pulse_power
- Integrated pulse power.
- integrated_pulse_power_double_wide
- Integrated pulse power.
- integrated_pulse_power_wide
- Integrated pulse power.
- maxdiff
- Maximum spread in position (in samples).
- maxpos
- Position of pulse maximum relative to pulse_start.
- maxpos_full
- Position of pulse maximum relative to pulse_start.
- mean
- Mean of noise.
- npolarizations [default value: 1 ]
- If this parameter > 1 then these are the number of antennas to be considered as one and pulse search is restricted to the one with the strongest SNR on average.
- peak_amplitude
- Pulse maximum.
- polarization_angle
- Polarization angle ..math::phi=0.5 tan(U/Q) for each antenna.
- pulse_maximum_time
- Position of pulse maximum relative to data start in seconds.
- refant
- Reference antenna for delays, taken as antenna with highest signal to noise.
- rms
- RMS of noise.
- snr
- Signal to noise ratio of pulse maximum.
- stokes
- Stokes parameters I, Q, U and V for each antenna.
- strongest_polarization [default value: None ]
- Polarization that is strongest and is used to find pulse strength.
-
run()
Run the task.