Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
|
A simple record to hold 'candidate' proprerties. More...
#include <cheetah/data/Candidate.h>
Public Member Functions | |
Candidate () | |
Create a zero-sized Candidate. | |
Candidate (MsecTimeType pulse_period, SecPerSecType pulse_pdot, Dm dm, std::size_t ident=0) | |
Construct a defined size Candidate object. More... | |
Candidate (MsecTimeType pulse_period, SecPerSecType pulse_pdot, Dm dm, MsecTimeType pulse_width, T sigma, std::size_t ident=0) | |
Construct a defined size Candidate object. More... | |
~Candidate () | |
destroy a Candidate | |
MsecTimeType const & | period () const |
access a reference to pulsar period. More... | |
void | period (MsecTimeType c_period) |
Set the candidate period. More... | |
SecPerSecType const & | pdot () const |
access a reference to pulse_pdot. More... | |
void | pdot (SecPerSecType c_pulse_pdot) |
Set the candidate pulse_pdot value. More... | |
Dm const & | dm () const |
access a reference to dm. More... | |
void | dm (Dm c_dm) |
Set the candidate dm value. More... | |
MsecTimeType const & | width () const |
access a reference to width. More... | |
void | width (MsecTimeType c_width) |
set the candidate width value. More... | |
T const & | sigma () const |
access a reference to _sigma. More... | |
void | sigma (T c_sigma) |
Set the candidate sigma value. More... | |
std::size_t const & | ident () const |
access a reference to ident. More... | |
void | ident (std::size_t c_ident) |
set the candidate ident value. More... | |
A simple record to hold 'candidate' proprerties.
A collection of values which hold the 'candidate' proprerties to be used in more complex vector-type classes
T | the underlying data representation (double, float uin8_t, etc) for the Dedispersion measure, sigma and pulse_pdot. |
Most data are double type.
Definition at line 60 of file Candidate.h.
ska::cheetah::data::Candidate< Arch, T >::Candidate | ( | MsecTimeType | pulse_period, |
SecPerSecType | pulse_pdot, | ||
Dm | dm, | ||
std::size_t | ident = 0 |
||
) |
Construct a defined size Candidate object.
pulse_period | = estimated/computed pulse period |
pulse_pdot | = estimated/computed period acceleration |
dm | = estimated/computed dispersion measure |
ident | = candidate identifier, to be held constant along pipeline (debug tracing) |
ska::cheetah::data::Candidate< Arch, T >::Candidate | ( | MsecTimeType | pulse_period, |
SecPerSecType | pulse_pdot, | ||
Dm | dm, | ||
MsecTimeType | pulse_width, | ||
T | sigma, | ||
std::size_t | ident = 0 |
||
) |
Construct a defined size Candidate object.
pulse_period | = estimated/computed pulse period |
pulse_pdot | = estimated/computed period acceleration |
dm | = estimated/computed dispersion measure |
pulse_width | = computed pulse width |
sigma | = computed significance |
ident | = candidate identifier, to be held constant along pipeline (debug tracing) |
Candidate< Arch, T >::Dm const & ska::cheetah::data::Candidate< Arch, T >::dm | ( | ) | const |
access a reference to dm.
The dispersion measure is a measure on how much interstellar electrons disperse the pulsar's signal causing lower observing frequencies to arrive later than higher observing frequencies. It express electon column density so its units are pc cm-3.
Definition at line 85 of file Candidate.cpp.
void ska::cheetah::data::Candidate< Arch, T >::dm | ( | Dm | c_dm | ) |
Set the candidate dm value.
The dispersion measure (dm) is a measure on how much interstellar electrons disperse the pulsar's signal causing lower observing frequencies to arrive later than higher observing frequencies. It express electon column density so its units are pc cm-3
[in] | dm | the candidate dispersion measure |
Definition at line 91 of file Candidate.cpp.
std::size_t const & ska::cheetah::data::Candidate< Arch, T >::ident | ( | ) | const |
access a reference to ident.
ident is an optional identifier label to let follow the trail of a specific candidate across different modules.
Definition at line 123 of file Candidate.cpp.
void ska::cheetah::data::Candidate< Arch, T >::ident | ( | std::size_t | c_ident | ) |
set the candidate ident value.
ident is an optional identifier label to let follow the trail of a specific candidate across different modules.
[in] | c_ident | the candidate ID number |
Definition at line 129 of file Candidate.cpp.
Candidate< Arch, T >::SecPerSecType const & ska::cheetah::data::Candidate< Arch, T >::pdot | ( | ) | const |
access a reference to pulse_pdot.
The pulse_pdot, or Period Derivative, is the first time derivative of the period. It has units of seconds per second. This change could be induced by a companion star or planets orbiting the pulsar.
Definition at line 73 of file Candidate.cpp.
void ska::cheetah::data::Candidate< Arch, T >::pdot | ( | SecPerSecType | c_pulse_pdot | ) |
Set the candidate pulse_pdot value.
The pulse_pdot, or Period Derivative, is the first time derivative of the period. It has units of seconds per second. This change could be induced by a companion star or planets orbiting the pulsar.
[in] | c_pulse_pdot | the candidate period derivative in sec/sec |
Definition at line 79 of file Candidate.cpp.
Candidate< Arch, T >::MsecTimeType const & ska::cheetah::data::Candidate< Arch, T >::period | ( | ) | const |
access a reference to pulsar period.
Definition at line 61 of file Candidate.cpp.
void ska::cheetah::data::Candidate< Arch, T >::period | ( | MsecTimeType | c_period | ) |
Set the candidate period.
[in] | c_period | the candidate period in msec. |
T const & ska::cheetah::data::Candidate< Arch, T >::sigma | ( | ) | const |
access a reference to _sigma.
sigma is the computed significance of the candidate. Here we assume the use of Gaussian equivalent significance that maps p-values to the corresponding sigma (standard deviation) that they would represent were the p-values drawn from a normal distribution of zero mean and unit variance.
Definition at line 111 of file Candidate.cpp.
void ska::cheetah::data::Candidate< Arch, T >::sigma | ( | T | c_sigma | ) |
Set the candidate sigma value.
sigma is the computed significance of the candidate. Here we assume the use of Gaussian equivalent significance that maps p-values to the corresponding sigma (standard deviation) that they would represent were the p-values drawn from a normal distribution of zero mean and unit variance.
[in] | c_sigma | the candidate signal-to-noise ratio |
Definition at line 117 of file Candidate.cpp.
Candidate< Arch, T >::MsecTimeType const & ska::cheetah::data::Candidate< Arch, T >::width | ( | ) | const |
access a reference to width.
width is the length of the pulses as computed by FLDO module. It is expressed in milliseconds
Definition at line 98 of file Candidate.cpp.
void ska::cheetah::data::Candidate< Arch, T >::width | ( | MsecTimeType | c_width | ) |
set the candidate width value.
width is the length of the pulses as computed by FLDO module. It is expressed in milliseconds.
[in] | c_width | the candidate pulse width in msec. |