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

Configuration for the BRDZ module. More...

#include <cheetah/brdz/Config.h>

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

Public Member Functions

cuda::Config const & cuda_config () const
 Configuration for cuda implementation of Brdz. More...
 
std::vector< data::Birdie > const & birdies () const
 Get the birdie list. More...
 
template<typename Container >
void birdies (Container &&birds)
 Set the birdie list via a move. More...
 
template<typename Container >
void birdies (Container const &birds)
 Set the birdie list via a copy. More...
 
template<typename Iterator >
void birdies (Iterator beg, Iterator end)
 Set the birdie list from an iterator. More...
 
- 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

Configuration for the BRDZ module.

Definition at line 43 of file Config.h.

Member Function Documentation

◆ birdies() [1/4]

std::vector< data::Birdie > const & ska::cheetah::brdz::Config::birdies ( ) const

Get the birdie list.

Returns
list of birdie frequencies and widths

Definition at line 50 of file Config.cpp.

51 {
52  return _birdies;
53 }

◆ birdies() [2/4]

template<typename Container >
void ska::cheetah::brdz::Config::birdies ( Container &&  birds)

Set the birdie list via a move.

Parameters
[in]birdsContainer of data::Birdie instances
Template Parameters
ContainerThe type of container (must have value type of data::Birdie)

Definition at line 32 of file Config.cpp.

33 {
34  static_assert(std::is_same<typename Container::value_type, data::Birdie>::value,
35  "Container must have have value type of data::Birdie");
36  _birdies = birds;
37 }

◆ birdies() [3/4]

template<typename Container >
void ska::cheetah::brdz::Config::birdies ( Container const &  birds)

Set the birdie list via a copy.

Parameters
birdsContainer of data::Birdie instances
Template Parameters
ContainerThe type of container (must have value type of data::Birdie)

Definition at line 48 of file Config.cpp.

49 {
50  static_assert(std::is_same<typename Container::value_type, data::Birdie>::value,
51  "Container must have have value type of data::Birdie");
52  _birdies = birds;
53 }

◆ birdies() [4/4]

template<typename Iterator >
void ska::cheetah::brdz::Config::birdies ( Iterator  beg,
Iterator  end 
)

Set the birdie list from an iterator.

Parameters
[in]begThe start iterator
[in]endThe end iterator
Template Parameters
IteratorThe type of iterator (must have value type of data::Birdie)

Definition at line 40 of file Config.cpp.

41 {
42  static_assert(std::is_same<typename Iterator::value_type, data::Birdie>::value,
43  "Container must have have value type of data::Birdie");
44  _birdies.assign(beg,end);
45 }

◆ cuda_config()

cuda::Config const & ska::cheetah::brdz::Config::cuda_config ( ) const

Configuration for cuda implementation of Brdz.

Returns
cuda::Brdz configuration

Definition at line 45 of file Config.cpp.

46 {
47  return _cuda_config;
48 }

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