Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
|
A wrapper class that presents a SeriesSlice object as a trial dispersion measure time series. More...
#include <cheetah/data/DmTrial.h>
Public Types | |
typedef SeriesType::Iterator | Iterator |
typedef DedispersionMeasureType< float > | DmType |
typedef boost::units::quantity< Seconds, double > | TimeType |
![]() | |
typedef SeriesType::Iterator | Iterator |
typedef SeriesType::ConstIterator | ConstIterator |
typedef std::iterator_traits< Iterator >::pointer | Pointer |
typedef std::iterator_traits< ConstIterator >::pointer | ConstPointer |
typedef std::iterator_traits< Iterator >::reference | Reference |
typedef std::iterator_traits< ConstIterator >::reference | ConstReference |
typedef std::iterator_traits< Iterator >::value_type | ValueType |
Public Member Functions | |
DmTrial (DmTrialsMetadata::Metadata const &metadata, Iterator start_it, Iterator end_it) | |
Create new instance. More... | |
TimeType | sampling_interval () const |
Return the sampling interval. | |
DmType | dm () const |
Return the dispersion measure of the trial. | |
![]() | |
SeriesSlice (Iterator start_it, Iterator end_it) | |
Construct a new instance. More... | |
Iterator | begin () |
Return an iterator pointing to the start of the slice. | |
ConstIterator | begin () const |
ConstIterator | cbegin () const |
Iterator | end () |
Return an iterator pointing to the end of the slice. | |
ConstIterator | end () const |
ConstIterator | cend () const |
Reference | operator[] (std::size_t n) |
Return a reference to the nth element of the slice. More... | |
ConstReference | operator[] (std::size_t n) const |
std::size_t | size () const |
Return the number of elements in the slice. | |
Pointer | data () |
Return a pointer to the first element of the slice. | |
ConstPointer | data () const |
Additional Inherited Members | |
![]() | |
Iterator | _start_it |
Iterator | _end_it |
A wrapper class that presents a SeriesSlice object as a trial dispersion measure time series.
This class provides some necessary functionality to allow a user to access individual dispersion measure trials stored inside a DmTrials object (a single contiguous array that split into multiple dispersion measure trials).
This class is not intended to be instantiated directly by the user, but instead instances of this class will be returned to the user by a DmTrials object.
This class adds to pieces of functionality over the basic SeriesSlice object, namely methods to access the DM and sampling interval of the data contained in the slice.
ska::cheetah::data::DmTrial< SeriesType >::DmTrial | ( | DmTrialsMetadata::Metadata const & | metadata, |
Iterator | start_it, | ||
Iterator | end_it | ||
) |
Create new instance.
dm | The dispersion measure of the trial | |
sampling_interval | The sampling interval | |
[in] | start_it | The start iterator |
[in] | end_it | The end iterator |
Definition at line 8 of file DmTrial.cpp.