Mantid
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Mantid::Kernel::ITimeSeriesProperty Class Referenceabstract

A non-templated interface to a TimeSeriesProperty. More...

#include <ITimeSeriesProperty.h>

Inheritance diagram for Mantid::Kernel::ITimeSeriesProperty:
Mantid::Kernel::TimeSeriesProperty< HeldType > Mantid::Kernel::TimeSeriesProperty< double > Mantid::Kernel::TimeSeriesProperty< int > Mantid::Kernel::TimeSeriesProperty< bool > Mantid::Kernel::TimeSeriesProperty< TYPE > Mantid::Kernel::FilteredTimeSeriesProperty< HeldType > Mantid::Kernel::FilteredTimeSeriesProperty< double >

Public Member Functions

virtual void clear ()=0
 Deletes the series of values in the property.
 
virtual void clearOutdated ()=0
 Deletes all but the 'last entry' in the property.
 
virtual Property * cloneInTimeROI (const TimeROI &timeROI) const =0
 
virtual Property * cloneWithTimeShift (const double timeShift) const =0
 
virtual void expandFilterToRange (std::vector< SplittingInterval > &split, double min, double max, const TimeInterval &range) const =0
 Make sure an existing filter covers the full time range given.
 
virtual double extractStatistic (Math::StatisticType selection, const TimeROI *=nullptr) const =0
 Filtering the series according to the selected statistical measure.
 
virtual TimeSeriesPropertyStatistics getStatistics (const TimeROI *roi=nullptr) const =0
 Return a TimeSeriesPropertyStatistics object.
 
virtual bool isFiltered () const =0
 
virtual TimeROI makeFilterByValue (double min, double max, bool expand=false, const TimeInterval &expandRange=TimeInterval(0, 1), double TimeTolerance=0., bool centre=true, const TimeROI *existingROI=nullptr) const =0
 Fill a SplittingIntervalVec that will filter the events by matching.
 
virtual void makeFilterByValue (std::vector< SplittingInterval > &split, double min, double max, double TimeTolerance, bool centre=true) const =0
 Fill a SplittingIntervalVec that will filter the events by matching.
 
virtual int realSize () const =0
 Returns the real size of the time series property map:
 
virtual void removeDataOutsideTimeROI (const TimeROI &timeRoi)=0
 
virtual double timeAverageValue (const TimeROI *timeRoi=nullptr) const =0
 Returns the calculated time weighted average value.
 
virtual std::pair< double, double > timeAverageValueAndStdDev (const Kernel::TimeROI *timeRoi=nullptr) const =0
 Returns the calculated time weighted mean and standard deviation values.
 
virtual std::vector< Types::Core::DateAndTime > timesAsVector () const =0
 Return the time series's times as a vector<DateAndTime>
 
virtual ~ITimeSeriesProperty ()=default
 Virtual destructor.
 

Detailed Description

A non-templated interface to a TimeSeriesProperty.

Definition at line 31 of file ITimeSeriesProperty.h.

Constructor & Destructor Documentation

◆ ~ITimeSeriesProperty()

virtual Mantid::Kernel::ITimeSeriesProperty::~ITimeSeriesProperty ( )
virtualdefault

Virtual destructor.

Member Function Documentation

◆ clear()

virtual void Mantid::Kernel::ITimeSeriesProperty::clear ( )
pure virtual

Deletes the series of values in the property.

Implemented in Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< bool >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< HeldType >, and Mantid::Kernel::TimeSeriesProperty< int >.

◆ clearOutdated()

virtual void Mantid::Kernel::ITimeSeriesProperty::clearOutdated ( )
pure virtual

Deletes all but the 'last entry' in the property.

Implemented in Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< bool >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< HeldType >, and Mantid::Kernel::TimeSeriesProperty< int >.

◆ cloneInTimeROI()

virtual Property * Mantid::Kernel::ITimeSeriesProperty::cloneInTimeROI ( const TimeROI &  timeROI) const
pure virtual

Implemented in Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< bool >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< HeldType >, and Mantid::Kernel::TimeSeriesProperty< int >.

◆ cloneWithTimeShift()

virtual Property * Mantid::Kernel::ITimeSeriesProperty::cloneWithTimeShift ( const double  timeShift) const
pure virtual

Implemented in Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< bool >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< HeldType >, and Mantid::Kernel::TimeSeriesProperty< int >.

◆ expandFilterToRange()

virtual void Mantid::Kernel::ITimeSeriesProperty::expandFilterToRange ( std::vector< SplittingInterval > &  split,
double  min,
double  max,
const TimeInterval &  range 
) const
pure virtual

Make sure an existing filter covers the full time range given.

Implemented in Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< bool >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< HeldType >, Mantid::Kernel::TimeSeriesProperty< int >, Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< bool >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< HeldType >, and Mantid::Kernel::TimeSeriesProperty< int >.

◆ extractStatistic()

virtual double Mantid::Kernel::ITimeSeriesProperty::extractStatistic ( Math::StatisticType  selection,
const TimeROI *  = nullptr 
) const
pure virtual

Filtering the series according to the selected statistical measure.

Implemented in Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< bool >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< HeldType >, Mantid::Kernel::TimeSeriesProperty< int >, Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< bool >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< HeldType >, and Mantid::Kernel::TimeSeriesProperty< int >.

◆ getStatistics()

virtual TimeSeriesPropertyStatistics Mantid::Kernel::ITimeSeriesProperty::getStatistics ( const TimeROI *  roi = nullptr) const
pure virtual

Return a TimeSeriesPropertyStatistics object.

Implemented in Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< bool >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< HeldType >, Mantid::Kernel::TimeSeriesProperty< int >, Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< bool >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< HeldType >, and Mantid::Kernel::TimeSeriesProperty< int >.

◆ isFiltered()

virtual bool Mantid::Kernel::ITimeSeriesProperty::isFiltered ( ) const
pure virtual

Implemented in Mantid::Kernel::FilteredTimeSeriesProperty< double >, Mantid::Kernel::FilteredTimeSeriesProperty< HeldType >, Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< bool >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< HeldType >, and Mantid::Kernel::TimeSeriesProperty< int >.

◆ makeFilterByValue() [1/2]

virtual TimeROI Mantid::Kernel::ITimeSeriesProperty::makeFilterByValue ( double  min,
double  max,
bool  expand = false,
const TimeInterval &  expandRange = TimeInterval(0, 1),
double  TimeTolerance = 0.,
bool  centre = true,
const TimeROI *  existingROI = nullptr 
) const
pure virtual

Fill a SplittingIntervalVec that will filter the events by matching.

Implemented in Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< bool >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< HeldType >, Mantid::Kernel::TimeSeriesProperty< int >, Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< bool >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< HeldType >, and Mantid::Kernel::TimeSeriesProperty< int >.

◆ makeFilterByValue() [2/2]

virtual void Mantid::Kernel::ITimeSeriesProperty::makeFilterByValue ( std::vector< SplittingInterval > &  split,
double  min,
double  max,
double  TimeTolerance,
bool  centre = true 
) const
pure virtual

Fill a SplittingIntervalVec that will filter the events by matching.

Implemented in Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< bool >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< HeldType >, Mantid::Kernel::TimeSeriesProperty< int >, Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< bool >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< HeldType >, and Mantid::Kernel::TimeSeriesProperty< int >.

◆ realSize()

virtual int Mantid::Kernel::ITimeSeriesProperty::realSize ( ) const
pure virtual

Returns the real size of the time series property map:

Implemented in Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< bool >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< HeldType >, and Mantid::Kernel::TimeSeriesProperty< int >.

◆ removeDataOutsideTimeROI()

virtual void Mantid::Kernel::ITimeSeriesProperty::removeDataOutsideTimeROI ( const TimeROI &  timeRoi)
pure virtual

Implemented in Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< bool >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< HeldType >, and Mantid::Kernel::TimeSeriesProperty< int >.

◆ timeAverageValue()

virtual double Mantid::Kernel::ITimeSeriesProperty::timeAverageValue ( const TimeROI *  timeRoi = nullptr) const
pure virtual

Returns the calculated time weighted average value.

Parameters
timeRoiObject that holds information about when the time measurement was active.
Returns
The time-weighted average value of the log when the time measurement was active.

Implemented in Mantid::Kernel::FilteredTimeSeriesProperty< double >, Mantid::Kernel::FilteredTimeSeriesProperty< HeldType >, Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< bool >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< HeldType >, Mantid::Kernel::TimeSeriesProperty< int >, Mantid::Kernel::FilteredTimeSeriesProperty< double >, Mantid::Kernel::FilteredTimeSeriesProperty< HeldType >, Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< bool >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< HeldType >, and Mantid::Kernel::TimeSeriesProperty< int >.

◆ timeAverageValueAndStdDev()

virtual std::pair< double, double > Mantid::Kernel::ITimeSeriesProperty::timeAverageValueAndStdDev ( const Kernel::TimeROI *  timeRoi = nullptr) const
pure virtual

Returns the calculated time weighted mean and standard deviation values.

Parameters
timeRoiObject that holds information about when the time measurement was active.

Implemented in Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< bool >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< HeldType >, Mantid::Kernel::TimeSeriesProperty< int >, Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< bool >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< HeldType >, and Mantid::Kernel::TimeSeriesProperty< int >.

◆ timesAsVector()

virtual std::vector< Types::Core::DateAndTime > Mantid::Kernel::ITimeSeriesProperty::timesAsVector ( ) const
pure virtual

Return the time series's times as a vector<DateAndTime>

Implemented in Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< bool >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< HeldType >, and Mantid::Kernel::TimeSeriesProperty< int >.

Referenced by Mantid::Algorithms::FilterByLogValue::exec().

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.8