Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
Public Member Functions | List of all members
ska::cheetah::data::DmTrialsMetadata::Metadata Class Reference

Container for an metadata concerning a single DM trial. More...

#include <cheetah/data/DmTrialsMetadata.h>

Collaboration diagram for ska::cheetah::data::DmTrialsMetadata::Metadata:
Collaboration graph

Public Member Functions

 Metadata (DmTrialsMetadata const &parent, DmType dm, std::size_t downsampling_factor=1)
 Create a new Metadata instance. More...
 
DmType const & dm () const
 return the dispersion measure
 
TimeType sampling_interval () const
 return the sampling interval
 
std::size_t size () const
 return the size (number of samples)
 

Detailed Description

Container for an metadata concerning a single DM trial.

Definition at line 59 of file DmTrialsMetadata.h.

Constructor & Destructor Documentation

◆ Metadata()

ska::cheetah::data::DmTrialsMetadata::Metadata::Metadata ( DmTrialsMetadata const &  parent,
typename DmTrialsMetadata::DmType  dm,
std::size_t  downsampling_factor = 1 
)

Create a new Metadata instance.

Parameters
parentThe parent DmTrialsMetadata instance
[in]dmThe dispersion measure
[in]downsampling_factorThe downsampling factor

Definition at line 8 of file DmTrialsMetadata.cpp.

9  : _parent(parent)
10  , _dm(dm)
11  , _downsampling_factor(downsampling_factor)
12 {
13 
14 }
DmType const & dm() const
return the dispersion measure

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