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

Algorithm configuration for the Dred module. More...

#include <cheetah/dred/Config.h>

Inheritance diagram for ska::cheetah::dred::Config:
Inheritance graph
Collaboration diagram for ska::cheetah::dred::Config:
Collaboration graph

Public Member Functions

cuda::Config const & cuda_config () const
 Configuration details for the cuda based RFIM algorithm.
 
pwft::Config const & pwft_config () const
 Configuration object for pwft module used by dred.
 
std::size_t oversmoothing_factor () const
 The oversmoothing factor for median window calculation. More...
 
void oversmoothing_factor (std::size_t)
 
- 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
 

Additional Inherited Members

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

Detailed Description

Algorithm configuration for the Dred module.

Definition at line 47 of file Config.h.

Member Function Documentation

◆ oversmoothing_factor()

std::size_t ska::cheetah::dred::Config::oversmoothing_factor ( ) const

The oversmoothing factor for median window calculation.

The oversmoothing factor refers to the ratio of median smoothing window size to the smearing of the most accelerated signal we are interested in preserving in our data set.

Definition at line 61 of file Config.cpp.

62 {
63  return _oversmoothing_factor;
64 }

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