Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
Public Member Functions | List of all members
ska::cheetah::fldo::Fldo< Handler, NumericalT, ConfigType > Class Template Reference

The FLDO primary API. More...

#include <cheetah/fldo/Fldo.h>

Inheritance diagram for ska::cheetah::fldo::Fldo< Handler, NumericalT, ConfigType >:
Inheritance graph
Collaboration diagram for ska::cheetah::fldo::Fldo< Handler, NumericalT, ConfigType >:
Collaboration graph

Public Member Functions

 Fldo (ConfigType const &, Handler &)
 initiate the Fldo aglorithm passing it the handler to be called on completion of the task
 
std::shared_ptr< panda::ResourceJob > operator() (std::vector< std::shared_ptr< TimeFrequencyType >> &tf_data, data::Scl const &scl_data)
 generic call for an async fldo task - the handler will be called on completion utilising any device in the pool More...
 

Additional Inherited Members

- Protected Types inherited from ska::cheetah::fldo::FldoModule< FldoTraitsType, FldoAlgos >
typedef FldoTraitsType::TimeFrequencyType TimeFrequencyType
 
- Protected Member Functions inherited from ska::cheetah::fldo::FldoModule< FldoTraitsType, FldoAlgos >
 FldoModule (Config const &, Handler &)
 
std::shared_ptr< panda::ResourceJob > operator() (std::vector< std::shared_ptr< TimeFrequencyType >> &tf_data, data::Scl const &scl_data)
 call this operator to submit a job for folding More...
 

Detailed Description

template<typename Handler, typename NumericalT, class ConfigType = fldo::ConfigType>
class ska::cheetah::fldo::Fldo< Handler, NumericalT, ConfigType >

The FLDO primary API.

perform folding for pulsar detection

Template Parameters
Handlershould support the operator()(std::shared_ptr<data::Ocld>)

Definition at line 54 of file Fldo.h.

Member Function Documentation

◆ operator()()

template<typename Handler , typename NumericalT , class ConfigType >
std::shared_ptr< panda::ResourceJob > ska::cheetah::fldo::Fldo< Handler, NumericalT, ConfigType >::operator() ( std::vector< std::shared_ptr< TimeFrequencyType >> &  tf_data,
data::Scl const &  scl_data 
)
inline

generic call for an async fldo task - the handler will be called on completion utilising any device in the pool

Returns
A ResourceJob object for tracking the job status. You can use the wait() method to block until the job is complete

Definition at line 41 of file Fldo.cpp.

42 {
43  return static_cast<BaseT&>(*this)(tf_data, scl_data);
44 }

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