FilteredTimeSeriesProperty.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 "MantidKernel/DllConfig.h"
#include "MantidKernel/TimeSeriesProperty.h"
 
#include <cstddef>
 
namespace Mantid {
using namespace Types::Core;
namespace Kernel {
 
class SplittingInterval;
 
template <typename HeldType> class MANTID_KERNEL_DLL FilteredTimeSeriesProperty : public TimeSeriesProperty<HeldType> {
 
public:
  explicit FilteredTimeSeriesProperty(const std::string &name);
  FilteredTimeSeriesProperty(TimeSeriesProperty<HeldType> *seriesProp, const TimeSeriesProperty<bool> &filterProp);
  FilteredTimeSeriesProperty(const std::string &name, const std::vector<Types::Core::DateAndTime> &times,
                             const std::vector<HeldType> &values);
 
  FilteredTimeSeriesProperty(TimeSeriesProperty<HeldType> *seriesProp);
 
  FilteredTimeSeriesProperty(std::unique_ptr<const TimeSeriesProperty<HeldType>> seriesProp,
                             const TimeSeriesProperty<bool> &filterProp);
  FilteredTimeSeriesProperty<HeldType> *clone() const override;
 
  FilteredTimeSeriesProperty(const FilteredTimeSeriesProperty &prop);
 
  ~FilteredTimeSeriesProperty() override;
 
  FilteredTimeSeriesProperty() = delete;
 
  std::vector<HeldType> filteredValuesAsVector(const Kernel::TimeROI *roi) const override;
  // overload method rather than default value so python bindings work
  std::vector<HeldType> filteredValuesAsVector() const override;
  std::vector<Types::Core::DateAndTime> filteredTimesAsVector(const Kernel::TimeROI *roi) const override;
  // overload method rather than default value so python bindings work
  std::vector<Types::Core::DateAndTime> filteredTimesAsVector() const override;
 
  TimeInterval nthInterval(int n) const override;
  HeldType nthValue(int n) const override;
  Types::Core::DateAndTime nthTime(int n) const override;
 
  void filterWith(const TimeSeriesProperty<bool> *filter);
  void filterWith(const TimeROI &filter);
  void clearFilter() const;
  // Returns whether the time series has been filtered
  bool isFiltered() const override { return m_filterApplied; }
 
  int size() const override;
 
  const TimeSeriesProperty<HeldType> *unfiltered() const;
 
  std::vector<Mantid::Kernel::TimeInterval> getTimeIntervals() const override;
 
  const Kernel::TimeROI &getTimeROI() const;
  double timeAverageValue(const TimeROI *timeRoi = nullptr) const override;
 
  bool operator==(const TimeSeriesProperty<HeldType> &right) const override;
  bool operator==(const Property &right) const override;
 
private:
  void applyFilter() const;
  void countSize() const;
  void clearFilterCache() const;
 
  std::string setValueFromProperty(const Property &right) override;
 
  TimeROI *intersectFilterWithOther(const TimeROI *other) const;
 
  mutable std::unique_ptr<TimeROI> m_filter;
  mutable std::vector<size_t> m_filterMap;
  mutable std::vector<TimeInterval> m_filterIntervals;
  mutable bool m_filterApplied;
};
 
} // namespace Kernel
} // namespace Mantid