ITimeSeriesProperty.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2012 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
#include <vector>
 
namespace Mantid {
namespace Types {
namespace Core {
class DateAndTime;
}
} // namespace Types
namespace Kernel {
//---------------------------------------------------------------------------
// Forward Declarations
//---------------------------------------------------------------------------
namespace Math {
enum StatisticType : int;
}
class SplittingInterval;
class TimeInterval;
struct TimeSeriesPropertyStatistics;
class Property;
class TimeROI;
class ITimeSeriesProperty {
public:
  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;
  virtual void makeFilterByValue(std::vector<SplittingInterval> &split, double min, double max, double TimeTolerance,
                                 bool centre = true) const = 0;
  virtual void expandFilterToRange(std::vector<SplittingInterval> &split, double min, double max,
                                   const TimeInterval &range) const = 0;
  // Provide a new instance of the ITimeSeriesProperty with shifted time values
  // After trying to use return type covariance, but that showed Error C2908
  // Using property seemed to be the most straightforward solution.
  virtual Property *cloneWithTimeShift(const double timeShift) const = 0;
 
  // Create a partial copy of this ITimeSeriesProperty-derived object according to a TimeROI. The partially cloned
  // object will include all time values enclosed by the ROI regions defined as [roi_begin,roi_end], plus the values
  // immediately before and after an ROI region, if available.
  virtual Property *cloneInTimeROI(const TimeROI &timeROI) const = 0;
 
  virtual std::vector<Types::Core::DateAndTime> timesAsVector() const = 0;
  virtual double timeAverageValue(const TimeROI *timeRoi = nullptr) const = 0;
  virtual std::pair<double, double> timeAverageValueAndStdDev(const Kernel::TimeROI *timeRoi = nullptr) const = 0;
  virtual TimeSeriesPropertyStatistics getStatistics(const TimeROI *roi = nullptr) const = 0;
  virtual double extractStatistic(Math::StatisticType selection, const TimeROI * = nullptr) const = 0;
  virtual int realSize() const = 0;
  virtual void clear() = 0;
  virtual void clearOutdated() = 0;
 
  // Returns whether the time series has been filtered
  virtual bool isFiltered() const = 0;
 
  // Remove time values outside the TimeROI regions defined as [roi_begin,roi_end].
  // However, keep the values immediately before and after each ROI region, if available.
  virtual void removeDataOutsideTimeROI(const TimeROI &timeRoi) = 0;
 
  virtual ~ITimeSeriesProperty() = default;
};
 
} // namespace Kernel
} // namespace Mantid