Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
Public Types | Public Member Functions | List of all members
ska::cheetah::data::TimeFrequency< Arch, NumericalT > Class Template Reference
Inheritance diagram for ska::cheetah::data::TimeFrequency< Arch, NumericalT >:
Inheritance graph
Collaboration diagram for ska::cheetah::data::TimeFrequency< Arch, NumericalT >:
Collaboration graph

Public Types

typedef NumericalT DataType
 the underlying data storage type for the amplitude of the signal
 
typedef NumericalT NumericalRep
 
typedef Arch Architecture
 
typedef CommonBaseT::FrequencyType FrequencyType
 
typedef CommonBaseT::TimeType TimeType
 
typedef CommonBaseT::TimePointType TimePointType
 
typedef BaseT::iterator Iterator
 
typedef BaseT::const_iterator ConstIterator
 
typedef BaseT::Spectra Spectra
 Iterator class for accessing each time sample. More...
 
typedef BaseT::ConstSpectra ConstSpectra
 
typedef BaseT::Channel Channel
 
typedef BaseT::ConstChannel ConstChannel
 
- Public Types inherited from ska::cheetah::data::TimeFrequencyCommon< TimeFrequency< Arch, NumericalT > >
typedef boost::units::quantity< MegaHertz, double > FrequencyType
 
typedef boost::units::quantity< boost::units::si::time, double > TimeType
 
typedef cheetah::utils::ModifiedJulianClock::time_point TimePointType
 

Public Member Functions

 TimeFrequency ()
 
 TimeFrequency (DimensionSize< Time > number_of_spectra, DimensionSize< Frequency > number_of_channels)
 
 TimeFrequency (DimensionSize< Frequency > number_of_channels, DimensionSize< Time > number_of_spectra)
 
template<class OtherArch , typename OtherNumericalT >
 TimeFrequency (const TimeFrequency< OtherArch, OtherNumericalT > &tf)
 
template<typename OtherNumericalT >
 TimeFrequency (FrequencyTime< Cpu, OtherNumericalT > const &ft)
 
template<class OtherArch , typename OtherNumericalT >
 TimeFrequency (FrequencyTime< OtherArch, OtherNumericalT > const &ft)
 
std::size_t number_of_channels () const
 
std::size_t number_of_spectra () const
 
void set_channel (unsigned channel_number, DataType const &value)
 sets the value of the specified channel to the provided value across all time samples
 
bool operator== (TimeFrequency const &) const
 return true if equivalent data
 
template<typename NumericalT >
 TimeFrequency (TimeFrequency< Cuda, NumericalT > const &tf)
 
template<typename OtherArch >
 TimeFrequency (TimeFrequency< OtherArch, NumericalT > const &tf)
 
template<typename OtherNumericalT >
 TimeFrequency (FrequencyTime< Cuda, OtherNumericalT > const &ft)
 
- Public Member Functions inherited from ska::cheetah::data::TimeFrequencyCommon< TimeFrequency< Arch, NumericalT > >
 TimeFrequencyCommon (TimeFrequencyCommon< OtherDerivedType > const &tfc)
 
TimePointType const & start_time () const
 
TimePointType start_time (std::size_t offset) const
 
void start_time (TimePointType const &start_time)
 Set the start time of the instance. More...
 
TimePointType end_time () const
 
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_frequencies (InputIterator begin, InputIterator const end)
 
TimeFrequencyMetadata const & metadata () const
 
void metadata (TimeFrequencyMetadata const &metadata)
 set the metadata
 

Detailed Description

template<class Arch, typename NumericalT>
class ska::cheetah::data::TimeFrequency< Arch, NumericalT >

Definition at line 44 of file FrequencyTime.h.

Member Typedef Documentation

◆ Spectra

template<class Arch, typename NumericalT>
typedef BaseT::Spectra ska::cheetah::data::TimeFrequency< Arch, NumericalT >::Spectra

Iterator class for accessing each time sample.

note the iterator has its own begin() and end() methods to generate iterators over the frequency channels of the sample

Examples:
/home/docs/checkouts/readthedocs.org/user_builds/ska-pss-cheetah/checkouts/latest/cheetah/data/TimeFrequency.h.

Definition at line 112 of file TimeFrequency.h.

Constructor & Destructor Documentation

◆ TimeFrequency() [1/2]

template<class Arch , typename NumericalT >
ska::cheetah::data::TimeFrequency< Arch, NumericalT >::TimeFrequency ( )

Construct an empty TimeFrequency object

Examples:
/home/docs/checkouts/readthedocs.org/user_builds/ska-pss-cheetah/checkouts/latest/cheetah/data/TimeFrequency.h.

Definition at line 34 of file TimeFrequency.cpp.

35  : BaseT( pss::astrotypes::DimensionSize<Frequency>(0)
36  , pss::astrotypes::DimensionSize<Time>(0))
37 {}

◆ TimeFrequency() [2/2]

template<class Arch , typename NumericalT >
ska::cheetah::data::TimeFrequency< Arch, NumericalT >::TimeFrequency ( DimensionSize< Time >  number_of_spectra,
DimensionSize< Frequency >  number_of_channels 
)

Construct a defined size TimeFrequency object

Definition at line 40 of file TimeFrequency.cpp.

42 {
43 }
std::size_t number_of_channels() const
std::size_t number_of_spectra() const

Member Function Documentation

◆ number_of_channels()

template<class Arch , typename NumericalT >
std::size_t ska::cheetah::data::TimeFrequency< Arch, NumericalT >::number_of_channels ( ) const
Returns
the integer number of channels in the block
Examples:
/home/docs/checkouts/readthedocs.org/user_builds/ska-pss-cheetah/checkouts/latest/cheetah/data/TimeFrequency.h.

Definition at line 129 of file TimeFrequency.cpp.

130 {
131  return _number_of_channels;
132 }

◆ number_of_spectra()

template<class Arch , typename NumericalT >
std::size_t ska::cheetah::data::TimeFrequency< Arch, NumericalT >::number_of_spectra ( ) const
Returns
the integer number of samples in the block
Examples:
/home/docs/checkouts/readthedocs.org/user_builds/ska-pss-cheetah/checkouts/latest/cheetah/data/TimeFrequency.h.

Definition at line 135 of file TimeFrequency.cpp.

136 {
137  return _number_of_spectra;
138 }

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