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

A class to compute timefrequency stats (mean and variance. More...

#include <cheetah/data/TimeFrequencyStats.h>

Inheritance diagram for ska::cheetah::data::TimeFrequencyStats< TimeFrequencyType >:
Inheritance graph
Collaboration diagram for ska::cheetah::data::TimeFrequencyStats< TimeFrequencyType >:
Collaboration graph

Classes

class  Statistics
 

Public Types

typedef BaseT::NumericalRep NumericalRep
 
- Public Types inherited from ska::cheetah::data::ExtendedTimeFrequency< TimeFrequencyType >
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

 TimeFrequencyStats (std::shared_ptr< TimeFrequencyType > const &)
 : construct an object with median and variance statistics for each channel and each spectrum.
 
void calculate_stats () const
 : recompute the statistics
 
std::vector< Statistics > const & channel_stats () const
 : return the Statistics for each channel in the block
 
std::vector< Statistics > const & spectrum_stats () const
 : return the Statistics (mean and variance) for each spectrum
 
- Public Member Functions inherited from ska::cheetah::data::ExtendedTimeFrequency< TimeFrequencyType >
 ExtendedTimeFrequency (std::shared_ptr< TimeFrequencyType > 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< TimeFrequencyType >
typedef BaseT::Type Type
 

Detailed Description

template<typename TimeFrequencyType>
class ska::cheetah::data::TimeFrequencyStats< TimeFrequencyType >

A class to compute timefrequency stats (mean and variance.

Definition at line 39 of file TimeFrequencyStats.h.


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