Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
|
Class that wraps a single DM trial from a DmTime object. More...
#include <cheetah/data/detail/DmTimeDm.h>
Public Member Functions | |
DmTimeDm (std::size_t const dm_idx, std::shared_ptr< SliceType const > parent) | |
Create a new instance. More... | |
template<typename TimeSeriesType > | |
TimeSeriesType::Iterator | copy_to (TimeSeriesType ×eries) const |
Copy the given DM trial to an arbitrary timeseries. More... | |
std::size_t | number_of_samples () const |
Get the number of time samples in the associated DM trial. More... | |
data::DedispersionMeasureType< float > | dm () const |
TimeType | sampling_interval () const |
Class that wraps a single DM trial from a DmTime object.
This class provides an interface that allows for single DM trials to be extracted from a DmTime object and sent to an arbitrary memory location on an arbitrary device.
This class is not intended to be used directly, but should instead only be returned from a dereferenced DmTimeSliceIterator.
Definition at line 47 of file DmTimeDm.h.
ska::cheetah::data::detail::DmTimeDm< DmTimeType >::DmTimeDm | ( | std::size_t const | dm_idx, |
std::shared_ptr< SliceType const > | parent | ||
) |
Create a new instance.
[in] | dm_idx | The dm index |
[in] | parent | The parent DmTimeSlice object |
Definition at line 17 of file DmTimeDm.cpp.
TimeSeriesType::Iterator ska::cheetah::data::detail::DmTimeDm< DmTimeType >::copy_to | ( | TimeSeriesType & | timeseries | ) | const |
Copy the given DM trial to an arbitrary timeseries.
The copy_to method will copy only up to the size of the timeseries provided. For objects using this method, it is necessary to check that the iterator returned by copy_to() matches the end() iterator of the timeseries. When they do not match, the timeseries should likely be resized or padded to ensure that all of the data it contains remains valid.
timeseries | The timeseries to be copied to |
TimeSeriesType | The type of the timeseries |
Definition at line 59 of file DmTimeDm.cpp.
std::size_t ska::cheetah::data::detail::DmTimeDm< DmTimeType >::number_of_samples | ( | ) | const |
Get the number of time samples in the associated DM trial.
Definition at line 29 of file DmTimeDm.cpp.