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

SpCandidates associated with a single data chank. More...

#include <cheetah/data/SpCandidateData.h>

Inheritance diagram for ska::cheetah::data::SpCandidateData< TimeFrequencyT >:
Inheritance graph
Collaboration diagram for ska::cheetah::data::SpCandidateData< TimeFrequencyT >:
Collaboration graph

Classes

class  Candidate
 

Public Types

typedef TimeFrequencyT TimeFrequencyType
 
typedef CandidateContainer::value_type CandidateType
 
typedef CandidateContainer::const_iterator ConstCandidateIterator
 
- Public Types inherited from ska::cheetah::data::ExtendedTimeFrequency< TimeFrequencyT >
typedef Type TimeFrequencyType
 
typedef Type::TimeType TimeType
 
typedef Type::TimePointType TimePointType
 
typedef Type::FrequencyType FrequencyType
 
typedef Type::Architecture Architecture
 
typedef Type::NumericalRep NumericalRep
 

Public Member Functions

 SpCandidateData (std::shared_ptr< TimeFrequencyT > const &)
 
void add (CandidateType &&candidate)
 add a Candidate to the candidates list More...
 
ConstCandidateIterator begin_candidates () const
 Iterator over the candidates.
 
ConstCandidateIterator end_candidates () const
 Iterator marking the end of any candidates.
 
CandidateType const & candidate (std::size_t candidate_number) const
 get the correspondin numbered candidate (<= number_of_candidates())
 
std::size_t number_of_candidates () const
 the number of candidates associated with this data
 
- Public Member Functions inherited from ska::cheetah::data::ExtendedTimeFrequency< TimeFrequencyT >
 ExtendedTimeFrequency (std::shared_ptr< TimeFrequencyT > const &)
 
 operator Type const & () const
 conversion operator to the underlying TimeFrequency type static casting to the tf block and using the reference may prove more efficient way of accessing the TF interface if you are calling more than one method.
 
TimePointType const & start_time () const
 get the start time of first spectrum
 
TimePointType start_time (std::size_t offset) const
 
void start_time (TimePointType const &start_time)
 Set the start time of the instance. More...
 
TimeType sample_interval () const
 
void sample_interval (TimeType dt)
 
std::vector< FrequencyType > const & channel_frequencies () const
 
std::pair< FrequencyType, FrequencyType > low_high_frequencies () const
 
void set_channel_frequencies_const_width (FrequencyType const &start, FrequencyType const &delta)
 Set the frequency index based on evenly spaced channels. More...
 
void set_channel (unsigned channel_number, NumericalRep const &value)
 sets the value of the specified channel to the provided value across all time samples
 

Additional Inherited Members

- Protected Types inherited from ska::cheetah::data::ExtendedTimeFrequency< TimeFrequencyT >
typedef BaseT::Type Type
 

Detailed Description

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

SpCandidates associated with a single data chank.

Definition at line 43 of file SpCandidateData.h.

Member Function Documentation

◆ add()

template<typename TimeFrequencyT >
void ska::cheetah::data::SpCandidateData< TimeFrequencyT >::add ( CandidateType &&  candidate)

add a Candidate to the candidates list

the Candidate should be wholly included in the data

Definition at line 50 of file SpCandidateData.cpp.

51 {
52  _cands.emplace_back(std::move(candidate));
53 }
CandidateType const & candidate(std::size_t candidate_number) const
get the correspondin numbered candidate (<= number_of_candidates())

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