Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
|
Provides the TimeFrequency API over a set of TimeFrequency objects. More...
#include <cheetah/data/TimeFrequencyContainer.h>
Classes | |
struct | ConstChannelIterator |
struct | ConstEndChannelIterator |
Public Types | |
typedef TimeFrequency< Arch, NumericalT > | TimeFrequencyType |
typedef TimeFrequencyType::FrequencyType | FrequencyType |
typedef TimeFrequencyType::TimeType | TimeType |
typedef TimeFrequencyType::TimePointType | TimePointType |
Public Member Functions | |
void | add (TimeFrequencyType &data) |
add data to the collection | |
void | add (std::shared_ptr< TimeFrequencyType > const &data) |
void | clear () |
clear all data | |
bool | empty () const |
return true if there is no data | |
TimePointType const & | start_time () const |
std::size_t | number_of_channels () const |
std::size_t | number_of_spectra () const |
TimeType | sample_interval () const |
std::vector< FrequencyType > const & | channel_frequencies () const |
template<class ChannelIterationEndHandler , class TimeDiscontinuityHandler > | |
ConstChannelIterator< ChannelIterationEndHandler, TimeDiscontinuityHandler > | begin (ChannelIterationEndHandler, TimeDiscontinuityHandler) const |
ConstEndChannelIterator | end () const |
return the end iterator | |
template<class ChannelIterationEndHandler , class TimeDiscontinuityHandler > | |
TimeFrequencyContainer< Arch, NumericalT >::template ConstChannelIterator< ChannelIterationEndHandler, TimeDiscontinuityHandler > | begin (ChannelIterationEndHandler ch_handler, TimeDiscontinuityHandler td_handler) const |
Provides the TimeFrequency API over a set of TimeFrequency objects.
Definition at line 42 of file TimeFrequencyContainer.h.
ConstChannelIterator<ChannelIterationEndHandler, TimeDiscontinuityHandler> ska::cheetah::data::TimeFrequencyContainer< Arch, NumericalT >::begin | ( | ChannelIterationEndHandler | , |
TimeDiscontinuityHandler | |||
) | const |
ChannelIterationEndHandler | called at the end of each time_sample |
TimeDiscontinuityHandler | called any time the sample_interval changes or the start_time() is not contiguous from previous (will also be called on initialisation_ The function should take two arguments e.g.: auto my_td_handler = [](TimePointType const&, TimeType const& interval) { // do something } |
std::vector< typename TimeFrequencyContainer< Arch, NumericalT >::TimeFrequencyType::FrequencyType > const & ska::cheetah::data::TimeFrequencyContainer< Arch, NumericalT >::channel_frequencies | ( | ) | const |
Definition at line 321 of file TimeFrequencyContainer.cpp.
std::size_t ska::cheetah::data::TimeFrequencyContainer< Arch, NumericalT >::number_of_channels | ( | ) | const |
Definition at line 297 of file TimeFrequencyContainer.cpp.
std::size_t ska::cheetah::data::TimeFrequencyContainer< Arch, NumericalT >::number_of_spectra | ( | ) | const |
Definition at line 303 of file TimeFrequencyContainer.cpp.
TimeFrequencyContainer< Arch, NumericalT >::TimeType ska::cheetah::data::TimeFrequencyContainer< Arch, NumericalT >::sample_interval | ( | ) | const |
Definition at line 315 of file TimeFrequencyContainer.cpp.
TimeFrequencyContainer< Arch, NumericalT >::TimePointType const & ska::cheetah::data::TimeFrequencyContainer< Arch, NumericalT >::start_time | ( | ) | const |
Definition at line 309 of file TimeFrequencyContainer.cpp.