Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
|
Configuration module to specify Dedispersion Trials. More...
#include <cheetah/ddtr/DedispersionTrialPlan.h>
Public Types | |
typedef data::DedispersionMeasureType< float > | Dm |
typedef boost::units::quantity< data::dm_constant::s_mhz::Unit, double > | DmConstantType |
typedef boost::units::quantity< boost::units::si::time, double > | TimeType |
typedef boost::units::quantity< data::MegaHertz, double > | FrequencyType |
typedef panda::ConfigModuleIteratorWrapper< DedispersionConfig > | RangeIterator |
![]() | |
typedef System | SystemType |
typedef panda::PoolManager< SystemType > | PoolManagerType |
typedef PoolManagerType::PoolType | PoolType |
Public Member Functions | |
DedispersionTrialPlan (std::string const &tag_name) | |
DmConstantType | dm_constant () const |
get DM constant More... | |
void | dm_constant (DmConstantType dm_const) |
set DM constant More... | |
void | add_dm_range (Dm start, Dm end, Dm step) |
get range of DM values | |
void | dedispersion_config (DedispersionConfig &config) |
add a Dedispersion Configuration Element More... | |
std::shared_ptr< data::DmTrialsMetadata > | generate_dmtrials_metadata (TimeType sample_interval, std::size_t nspectra, std::size_t nsamples) const |
Generate metadata based on dedispersion plan. More... | |
std::vector< Dm > const & | dm_trials () const |
list of DM trials | |
Dm | max_dm () const |
the largest Dm value specified | |
TimeType | maximum_delay (FrequencyType freq_low, FrequencyType freq_high) const |
the maximum delay time for a signal at the maximum Dm in the plan | |
template<typename Arch , typename NumericalRep > | |
data::DimensionSize< data::Time > | maximum_delay_offset (data::TimeFrequency< Arch, NumericalRep > const &tf) const |
the maximum delay offset calculated with the TF blocks properties | |
RangeIterator | begin_range () const |
RangeIterator | end_range () const |
![]() | |
Config (std::string module_name) | |
void | terminate () const |
call for notifiers to indicate a termination condition More... | |
Protected Member Functions | |
void | add_options (OptionsDescriptionEasyInit &add_options) override |
Configuration module to specify Dedispersion Trials.
Definition at line 47 of file DedispersionTrialPlan.h.
void ska::cheetah::ddtr::DedispersionTrialPlan::dedispersion_config | ( | DedispersionConfig & | config | ) |
add a Dedispersion Configuration Element
note that the lifetime of the passed object is not controlled by this class.
Definition at line 85 of file DedispersionTrialPlan.cpp.
DedispersionTrialPlan::DmConstantType ska::cheetah::ddtr::DedispersionTrialPlan::dm_constant | ( | ) | const |
get DM constant
Definition at line 106 of file DedispersionTrialPlan.cpp.
void ska::cheetah::ddtr::DedispersionTrialPlan::dm_constant | ( | DedispersionTrialPlan::DmConstantType | dm_const | ) |
set DM constant
Definition at line 117 of file DedispersionTrialPlan.cpp.
std::shared_ptr< data::DmTrialsMetadata > ska::cheetah::ddtr::DedispersionTrialPlan::generate_dmtrials_metadata | ( | TimeType | sample_interval, |
std::size_t | nspectra, | ||
std::size_t | nsamples | ||
) | const |
Generate metadata based on dedispersion plan.
Error | if size of DM overlap region exceeds number of spectra |
Definition at line 91 of file DedispersionTrialPlan.cpp.