Public Member Functions | Public Attributes | List of all members
dsp::LoadToFold::Config Class Reference

Load, unpack, process and fold data into phase-averaged profile(s) More...

#include <LoadToFoldConfig.h>

Inheritance diagram for dsp::LoadToFold::Config:
dsp::SingleThread::Config Reference::Able Reference::HeapTracked

Public Member Functions

 Config ()
 Default constructor.
 
void set_archive_class (const std::string &)
 
void set_sk_m (std::string txt)
 
void set_sk_noverlap (std::string txt)
 
void set_sk_std_devs (std::string txt)
 
void single_pulse ()
 
bool single_archiver_required ()
 
bool concurrent_archives ()
 
bool may_be_more_than_one_archive_per_second ()
 
unsigned get_nfold () const
 Return the number of folds to perform.
 
dsp::Filterbank::Config::When get_convolve_when () const
 Return when convolution is performed: before, during, or after (Inverse)Filterbank.
 
unsigned get_filterbank_nchan () const
 return the number of channels produced by (Inverse)Filterbank
 
virtual void set_quiet ()
 Operate in quiet mode.
 
virtual void set_verbose ()
 Operate in verbose mode.
 
virtual void set_very_verbose ()
 Operate in very verbose mode.
 
- Public Member Functions inherited from dsp::SingleThread::Config
 Config ()
 Default constructor.
 
virtual void add_options (CommandLine::Menu &)
 Add command line options.
 
Source * open (int argc, char **argv)
 Create new Input based on command line options. More...
 
void set_times_minimum_ndat (unsigned)
 
unsigned get_times_minimum_ndat () const
 
void set_maximum_RAM (uint64_t)
 
uint64_t get_maximum_RAM () const
 
void set_minimum_RAM (uint64_t)
 
uint64_t get_minimum_RAM () const
 
virtual void prepare (Source *)
 Prepare the input according to the configuration.
 
void set_cuda_device (std::string)
 set the cuda devices to be used
 
unsigned get_cuda_ndevice () const
 
void set_nthread (unsigned)
 set the number of CPU threads to be used
 
unsigned get_total_nthread () const
 get the total number of threads
 
void set_affinity (std::string)
 set the cpus on which each thread will run
 
void set_fft_library (std::string)
 set the FFT library
 
unsigned get_nbuffers () const
 get the number of buffers required to process the data
 
- Public Member Functions inherited from Reference::Able
 Able (const Able &)
 
Able & operator= (const Able &)
 
unsigned get_reference_count () const
 
- Public Member Functions inherited from Reference::HeapTracked
 HeapTracked (const HeapTracked &)
 
HeapTracked & operator= (const HeapTracked &)
 
bool __is_on_heap () const
 

Public Attributes

TwoBitCorrection::Config twobit_config
 
bool apply_FITS_scale_and_offset
 
bool coherent_dedispersion
 
bool coherent_derotation
 
bool interchan_dedispersion
 
double dispersion_measure
 
double rotation_measure
 
bool zap_rfi
 
bool use_fft_bench
 
bool optimal_order
 
std::string calibrator_database_filename
 
unsigned nsmear
 
unsigned times_minimum_nfft
 
unsigned plfb_nbin
 
unsigned plfb_nchan
 
unsigned cyclic_nchan
 
unsigned cyclic_mover
 
bool fourth_moment
 
bool pdmp_output
 
bool sk_zap
 
std::string sk_config
 
bool nosk_too
 
bool sk_omit_outliers = false
 
std::vector< unsigned > sk_m
 
std::vector< unsigned > sk_noverlap
 
std::vector< float > sk_std_devs
 
unsigned sk_chan_start
 
unsigned sk_chan_end
 
bool sk_time = true
 
bool sk_freq = true
 
bool sk_time_freq = true
 
unsigned sk_nthreads = 1
 
bool sk_fold = false
 
unsigned npol
 
unsigned nbin
 
unsigned ndim
 
Filterbank::Config filterbank
 
std::string temporal_apodization_type
 
std::string spectral_apodization_type
 
InverseFilterbank::Config inverse_filterbank
 
bool is_inverse_filterbank
 
bool do_deripple
 
bool force_sensible_nbin
 
unsigned integration_turns
 
double integration_length
 
std::string integration_reference_epoch
 
double minimum_integration_length
 
bool single_archive
 
unsigned subints_per_archive
 
std::string filename_convention
 
std::string reference_epoch
 
double reference_phase
 
double folding_period
 
bool fractional_pulses
 
bool asynchronous_fold
 
std::vector< std::string > additional_pulsars
 
std::vector< Reference::To< Pulsar::Parameters > > ephemerides
 
std::vector< Reference::To< Pulsar::Predictor > > predictors
 
bool no_dynamic_extensions
 
std::string archive_class
 
bool archive_class_specified_by_user
 
std::string archive_filename
 
std::string archive_extension
 
std::vector< std::string > jobs
 
std::string command_line
 
- Public Attributes inherited from dsp::SingleThread::Config
std::string application_name
 The name of the application.
 
Functor< void(Source *) > source_prepare
 external function used to prepare the input each time it is opened
 
bool force_contiguity
 
bool command_line_header
 
MJD seek_epoch
 Seek such that the first time sample output is at the specified (topocentric) MJD. More...
 
double seek_seconds
 
double total_seconds
 
bool list_attributes
 List all editor-accessible attributes of the observation.
 
TextEditor< Observation > editor
 The editor used to set Observation attributes via the command line.
 
bool report_vitals
 report vital statistics
 
bool report_done
 report the percentage finished
 
bool run_repeatedly
 run repeatedly on the same input
 
bool input_buffering
 use input-buffering to compensate for operation edge effects
 
bool weighted_time_series
 use weighted time series to flag bad data
 
std::vector< std::string > dump_before
 dump points
 
std::vector< std::string > mask_before
 mask points
 

Additional Inherited Members

- Static Public Member Functions inherited from Reference::Able
static size_t get_instance_count ()
 
- Static Public Member Functions inherited from Reference::HeapTracked
static void * operator new (size_t size, void *ptr=0)
 
static void operator delete (void *location, void *ptr)
 
static void operator delete (void *location)
 
static size_t get_heap_queue_size ()
 
- Protected Member Functions inherited from Reference::Able
Handle * __reference (bool active) const
 
void __dereference (bool auto_delete=true) const
 
- Protected Attributes inherited from dsp::SingleThread::Config
bool can_cuda
 application can make use of CUDA
 
std::vector< unsigned > cuda_device
 CUDA devices on which computations will take place.
 
bool can_thread
 application can make use of multiple cores
 
std::vector< unsigned > affinity
 CPUs on which threads will run.
 
unsigned nthread
 number of CPU threads
 
unsigned buffers
 number of buffers that have been created by new_time_series
 
unsigned repeated
 number of times that the input has been re-opened
 
unsigned times_minimum_ndat
 
uint64_t maximum_RAM
 
uint64_t minimum_RAM
 

Detailed Description

Load, unpack, process and fold data into phase-averaged profile(s)

The documentation for this class was generated from the following files:
Generated using doxygen 1.8.17