Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
Public Member Functions | Static Public Member Functions | List of all members
ska::cheetah::sigproc::SigProcWriter< HeaderType > Class Template Reference

Writes data types to a sigproc format file. More...

#include <cheetah/sigproc/SigProcWriter.h>

Collaboration diagram for ska::cheetah::sigproc::SigProcWriter< HeaderType >:
Collaboration graph

Public Member Functions

 SigProcWriter (WriterConfig const &)
 
 SigProcWriter (std::string const &directory)
 
 SigProcWriter (boost::filesystem::path const &directory)
 
template<typename Arch , typename NumericalRep >
SigProcWriteroperator<< (data::TimeFrequency< Arch, NumericalRep > const &tf)
 writes out the samples in the data to the currently open sigproc file More...
 
template<typename DerivedType , typename NumericalRep , typename Alloc >
SigProcWriteroperator<< (data::SpectrumBase< DerivedType, NumericalRep, Alloc > const &spectrum_data)
 
void flush ()
 close any existing data files
 
template<typename T >
std::enable_if< pss::astrotypes::has_exact_dimensions< T, data::Time, data::Frequency >::value, SigProcWriter & >::type write (HeaderType const &, T const &t)
 write the data out to file using the meta data from the header provided
 
template<typename Arch , typename NumericalRep >
SigProcWriter< HeaderType > & operator<< (data::TimeFrequency< Arch, NumericalRep > const &tf)
 
template<typename DerivedType , typename NumericalRep , typename Alloc >
SigProcWriter< HeaderType > & operator<< (data::SpectrumBase< DerivedType, NumericalRep, Alloc > const &spectrum)
 

Static Public Member Functions

template<typename Arch , typename NumericalRep >
static void fill_header (HeaderType &header, data::TimeFrequency< Arch, NumericalRep > const &tf)
 fill the sigproc header object with meta data taken from the TimeFrequency object
 

Detailed Description

template<typename HeaderType = pss::astrotypes::sigproc::Header>
class ska::cheetah::sigproc::SigProcWriter< HeaderType >

Writes data types to a sigproc format file.

Will automatically create files in the provided directory with timestamps as the filename

Definition at line 45 of file SigProcWriter.h.

Member Function Documentation

◆ operator<<()

template<typename HeaderType = pss::astrotypes::sigproc::Header>
template<typename Arch , typename NumericalRep >
SigProcWriter& ska::cheetah::sigproc::SigProcWriter< HeaderType >::operator<< ( data::TimeFrequency< Arch, NumericalRep > const &  tf)

writes out the samples in the data to the currently open sigproc file

if the sigproc file is not open, or the data parameters do not match that of the currently open sigproc file, then a new sigproc file will be created with a suitable header.


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