Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
Public Types | Public Member Functions | Protected Member Functions | List of all members
ska::cheetah::generators::PulsarInjectionConfig Class Reference

Confgiuration Parameters for the pulsar injection generator. More...

#include <cheetah/generators/PulsarInjectionConfig.h>

Inheritance diagram for ska::cheetah::generators::PulsarInjectionConfig:
Inheritance graph
Collaboration diagram for ska::cheetah::generators::PulsarInjectionConfig:
Collaboration graph

Public Types

typedef PhaseModelFactory::type PhaseModelType
 
- Public Types inherited from ska::cheetah::utils::Config
typedef System SystemType
 
typedef panda::PoolManager< SystemTypePoolManagerType
 
typedef PoolManagerType::PoolType PoolType
 

Public Member Functions

 PulsarInjectionConfig (std::string const &tagname="pulsar")
 
float signal_to_noise () const
 signal to nosie ratio to emulate
 
void signal_to_noise (float snr)
 set the target signal to nosie ratio to emulate
 
PulsarProfileId const & profile () const
 the name of the pulse profile to emulate
 
void profile (std::string const &profile_name)
 set the name of the pulse profile to emulate
 
void spectral_index (float si)
 set the spectral index of the pulse
 
float spectral_index () const
 get the spectral index to emulate
 
PhaseModelType const & phase_model () const
 return the phase model that has benn specified
 
SimplePhaseModelConfig const & simple_phase_model_config () const
 configuration for the simple phase model
 
void set_phase_model (SimplePhaseModelConfig const &)
 set the phase model to single type with the speocife settings
 
void set_phase_model (Tempo2PhaseModelConfig const &)
 
data::DedispersionMeasureType< double > dm () const
 the dedisperion measure to emulate
 
void dm (data::DedispersionMeasureType< double >)
 set the dedisperion measure to emulate
 
- Public Member Functions inherited from ska::cheetah::utils::Config
 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
 
void phase_model (std::string const &)
 

Detailed Description

Confgiuration Parameters for the pulsar injection generator.

Definition at line 45 of file PulsarInjectionConfig.h.


The documentation for this class was generated from the following files: