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

Class for storing birdies (known RFI periodicities/frequencies) More...

#include <cheetah/data/Birdie.h>

Collaboration diagram for ska::cheetah::data::Birdie:
Collaboration graph

Public Member Functions

 Birdie ()
 Create an empty Birdie instance.
 
 Birdie (data::FourierFrequencyType const &frequency, data::FourierFrequencyType const &width)
 Create a new Birdie. More...
 
 Birdie (Birdie const &)=default
 
 Birdie (Birdie &&)=default
 
Birdieoperator= (Birdie const &)=default
 Copy assignment.
 
void frequency (data::FourierFrequencyType const &frequency)
 Set the frequency of the birdie. More...
 
data::FourierFrequencyType const & frequency () const
 Get the frequency of the birdie. More...
 
void width (data::FourierFrequencyType const &width)
 Set the width of the birdie. More...
 
data::FourierFrequencyType const & width () const
 Get the width of the birdie. More...
 

Detailed Description

Class for storing birdies (known RFI periodicities/frequencies)

Each birdie represents a signal of a given width to be excised from the spectrum of each DM trial during a search for periodic pulsar-like signals

Definition at line 41 of file Birdie.h.

Constructor & Destructor Documentation

◆ Birdie()

ska::cheetah::data::Birdie::Birdie ( data::FourierFrequencyType const &  frequency,
data::FourierFrequencyType const &  width 
)

Create a new Birdie.

Parameters
frequencyThe central frequency of the birdie
widthThe full width of the birdie (centered around the frequency)

Definition at line 34 of file Birdie.cpp.

35  : _frequency(frequency)
36  , _width(width)
37 {
38 }
data::FourierFrequencyType const & frequency() const
Get the frequency of the birdie.
Definition: Birdie.cpp:49
data::FourierFrequencyType const & width() const
Get the width of the birdie.
Definition: Birdie.cpp:59

Member Function Documentation

◆ frequency() [1/2]

void ska::cheetah::data::Birdie::frequency ( data::FourierFrequencyType const &  frequency)

Set the frequency of the birdie.

Parameters
frequencyThe frequency

Definition at line 44 of file Birdie.cpp.

45 {
46  _frequency = frequency;
47 }
data::FourierFrequencyType const & frequency() const
Get the frequency of the birdie.
Definition: Birdie.cpp:49
Here is the call graph for this function:

◆ frequency() [2/2]

data::FourierFrequencyType const & ska::cheetah::data::Birdie::frequency ( ) const

Get the frequency of the birdie.

Returns
The frequency of the birdie in Hz

Definition at line 49 of file Birdie.cpp.

50 {
51  return _frequency;
52 }

◆ width() [1/2]

void ska::cheetah::data::Birdie::width ( data::FourierFrequencyType const &  width)

Set the width of the birdie.

Parameters
widthThe width in Hz

Definition at line 54 of file Birdie.cpp.

55 {
56  _width = width;
57 }
data::FourierFrequencyType const & width() const
Get the width of the birdie.
Definition: Birdie.cpp:59
Here is the call graph for this function:

◆ width() [2/2]

data::FourierFrequencyType const & ska::cheetah::data::Birdie::width ( ) const

Get the width of the birdie.

Returns
The frequency width of the birdie in Hz

Definition at line 59 of file Birdie.cpp.

60 {
61  return _width;
62 }

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