Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
Public Types | Public Member Functions | List of all members
ska::cheetah::ddtr::Ddtr< ConfigType, NumericalRep, AggregationBufferFactoryTemplate > Class Template Reference

DDTR module top level API. More...

#include <cheetah/ddtr/Ddtr.h>

Inheritance diagram for ska::cheetah::ddtr::Ddtr< ConfigType, NumericalRep, AggregationBufferFactoryTemplate >:
Inheritance graph
Collaboration diagram for ska::cheetah::ddtr::Ddtr< ConfigType, NumericalRep, AggregationBufferFactoryTemplate >:
Collaboration graph

Public Types

typedef DdtrTraits::DedispersionHandler DedispersionHandler
 
typedef DdtrTraits::DmTrialsType DmTrialsType
 

Public Member Functions

 Ddtr (ConfigType const &config, DedispersionHandler)
 
template<typename TimeFreqDataT , typename data::EnableIfIsTimeFrequency< TimeFreqDataT, bool > = true>
void operator() (TimeFreqDataT const &input)
 dedisperses chunk of buffer data to a dm-time chunk. More...
 
template<typename T >
void operator() (std::shared_ptr< T > const &data)
 accept shared_ptr of TimeFrequency data types More...
 
- Public Member Functions inherited from ska::cheetah::ddtr::DdtrModule< DdtrTraits, DdtrAlgorithms >
template<typename DedispersionHandler >
 DdtrModule (ConfigType const &config, DedispersionHandler &&handler)
 
template<typename Handler >
 DdtrModule (ConfigType const &config, Handler &&handler)
 

Additional Inherited Members

- Protected Attributes inherited from ska::cheetah::ddtr::DdtrModule< DdtrTraits, DdtrAlgorithms >
TaskType _task
 
Buffering< DdtrTraits, ExtendedDedispersionPlan > _buffer
 

Detailed Description

template<typename ConfigType, typename NumericalRep, template< typename > class AggregationBufferFactoryTemplate = TimeFrequencyFactory>
class ska::cheetah::ddtr::Ddtr< ConfigType, NumericalRep, AggregationBufferFactoryTemplate >

DDTR module top level API.

Exposes all available ddtr algorithms to the user for selection via runtime configuration options

Definition at line 68 of file Ddtr.h.

Member Function Documentation

◆ operator()() [1/2]

template<typename ConfigType , typename NumericalRep , template< typename > class AggregationBufferFillerTemplate>
template<typename TimeFreqDataT , typename data::EnableIfIsTimeFrequency< TimeFreqDataT, bool > >
void ska::cheetah::ddtr::Ddtr< ConfigType, NumericalRep, AggregationBufferFillerTemplate >::operator() ( TimeFreqDataT const &  input)

dedisperses chunk of buffer data to a dm-time chunk.

the DedispersionHandler will be called when dedispersion is complete. The method is delegated device specific implementations.

Parameters
[in]inputA TimeFequency data type (or equivalent) of data to dedisperse.

Definition at line 46 of file Ddtr.cpp.

47 {
48  this->_buffer(tf_data);
49 }

◆ operator()() [2/2]

template<typename ConfigType , typename NumericalRep , template< typename > class AggregationBufferFillerTemplate>
template<typename T >
void ska::cheetah::ddtr::Ddtr< ConfigType, NumericalRep, AggregationBufferFillerTemplate >::operator() ( std::shared_ptr< T > const &  data)

accept shared_ptr of TimeFrequency data types

calls the appropriate operator for type T if it exists

Definition at line 53 of file Ddtr.cpp.

54 {
55  (*this)(*data);
56 }

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