Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
Public Types | Public Member Functions | List of all members
ska::cheetah::data::SpCandidateData< TimeFrequencyT >::Candidate< T > Class Template Reference
Collaboration diagram for ska::cheetah::data::SpCandidateData< TimeFrequencyT >::Candidate< T >:
Collaboration graph

Public Types

typedef DedispersionMeasureType< T > Dm
 
typedef boost::units::quantity< MilliSeconds, double > MsecTimeType
 
typedef MsecTimeType Width
 
typedef MsecTimeType Duration
 
typedef pss::astrotypes::units::ModifiedJulianClock::time_point TimePointType
 
typedef T Sigma
 
typedef boost::units::quantity< MegaHertz, double > FrequencyType
 

Public Member Functions

 Candidate (Dm dm, TimePointType start_time_mjd, Width width, Duration duration, T sigma)
 
TimePointType const & start_time () const
 Get the start time of the candidate. More...
 
Duration const & duration () const
 The duration in time of the candidate pulse.
 
Dm const & dm () const
 access a reference to dm. More...
 
Width const & width () const
 access a reference to width. More...
 
Sigma const & sigma () const
 access a reference to standard deviation (sigma). More...
 

Detailed Description

template<typename TimeFrequencyT>
template<typename T>
class ska::cheetah::data::SpCandidateData< TimeFrequencyT >::Candidate< T >

Definition at line 50 of file SpCandidateData.h.

Member Function Documentation

◆ dm()

template<typename TimeFrequencyT >
template<typename T >
SpCandidateData< TimeFrequencyT >::template Candidate< T >::Dm const & ska::cheetah::data::SpCandidateData< TimeFrequencyT >::Candidate< 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.

Returns
The candidate dispersion measure in pc cm-3

Definition at line 99 of file SpCandidateData.cpp.

100 {
101  return _dm;
102 }

◆ sigma()

template<typename TimeFrequencyT >
template<typename T >
SpCandidateData< TimeFrequencyT >::template Candidate< T >::Sigma const & ska::cheetah::data::SpCandidateData< TimeFrequencyT >::Candidate< T >::sigma ( ) const

access a reference to standard deviation (sigma).

sigma 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.

Returns
The candidate signal-to-noise ratio.

Definition at line 120 of file SpCandidateData.cpp.

121 {
122  return _sigma;
123 }

◆ start_time()

template<typename TimeFrequencyT >
template<typename T >
SpCandidateData< TimeFrequencyT >::template Candidate< T >::TimePointType const & ska::cheetah::data::SpCandidateData< TimeFrequencyT >::Candidate< T >::start_time ( ) const

Get the start time of the candidate.

Returns
The candidate start time in MJD

Definition at line 106 of file SpCandidateData.cpp.

107 {
108  return _start_time;
109 }

◆ width()

template<typename TimeFrequencyT >
template<typename T >
SpCandidateData< TimeFrequencyT >::template Candidate< T >::Width const & ska::cheetah::data::SpCandidateData< TimeFrequencyT >::Candidate< T >::width ( ) const

access a reference to width.

width is the duration pulse, expressed in milliseconds.

Returns
The candidate pulse width in msec.

Definition at line 127 of file SpCandidateData.cpp.

128 {
129  return _width;
130 }

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