GetTimeSeriesLogInformation.h

#ifndef MANTID_ALGORITHMS_GETTIMESERIESLOGINFORMATION_H_
#define MANTID_ALGORITHMS_GETTIMESERIESLOGINFORMATION_H_

#include "MantidKernel/System.h"
#include "MantidAPI/Algorithm.h"
#include "MantidAPI/MatrixWorkspace_fwd.h"
#include "MantidDataObjects/EventWorkspace.h"
#include "MantidDataObjects/Workspace2D.h"
#include "MantidDataObjects/TableWorkspace.h"

namespace Mantid {
namespace Algorithms {

/** GetTimeSeriesLogInformation : Read a TimeSeries log and return some
  information required by users.

  @date 2011-12-22

  Copyright © 2011 ISIS Rutherford Appleton Laboratory, NScD Oak Ridge
  National Laboratory & European Spallation Source

  This file is part of Mantid.

  Mantid is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 3 of the License, or
  (at your option) any later version.

  Mantid is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.

  File change history is stored at: <https://github.com/mantidproject/mantid>
  Code Documentation is available at: <http://doxygen.mantidproject.org>
*/
class DLLExport GetTimeSeriesLogInformation : public API::Algorithm {
public:
  GetTimeSeriesLogInformation();
  ~GetTimeSeriesLogInformation() override;

  const std::string name() const override {
    return "GetTimeSeriesLogInformation";
  }
  /// Summary of algorithms purpose
  const std::string summary() const override {
    return "Get information from a TimeSeriesProperty log.";
  }

  int version() const override { return 1; }
  const std::string category() const override {
    return "Diffraction\\Utility;Events\\EventFiltering";
  }

private:
  API::MatrixWorkspace_sptr m_dataWS;

  Kernel::DateAndTime mRunStartTime;
  Kernel::DateAndTime mFilterT0;
  Kernel::DateAndTime mFilterTf;

  std::map<std::string, std::size_t> m_intInfoMap;
  std::map<std::string, double> m_dblInfoMap;

  Kernel::TimeSeriesProperty<double> *m_log;
  std::vector<Kernel::DateAndTime> m_timeVec;
  std::vector<double> m_valueVec;

  Kernel::DateAndTime m_starttime;
  Kernel::DateAndTime m_endtime;

  bool m_ignoreNegativeTime;

  void init() override;

  void exec() override;

  void examLog(std::string logname, std::string outputdir);

  void generateCalibrationFile();

  void processTimeRange();

  /// Calcualte the distribution of delta T in time stamps
  DataObjects::Workspace2D_sptr
  calDistributions(std::vector<Kernel::DateAndTime> timevec, double stepsize);

  void exportLog(API::MatrixWorkspace_sptr ws,
                 std::vector<Kernel::DateAndTime> abstimevec, double dts);

  void setupEventWorkspace(int numentries,
                           std::vector<Kernel::DateAndTime> &times,
                           std::vector<double> values);

  void setupWorkspace2D(int numentries, std::vector<Kernel::DateAndTime> &times,
                        std::vector<double> values);

  void execQuickStatistics();

  void exportErrorLog(API::MatrixWorkspace_sptr ws,
                      std::vector<Kernel::DateAndTime> abstimevec, double dts);

  void checkLogValueChanging(std::vector<Kernel::DateAndTime> timevec,
                             std::vector<double> values, double delta);

  void checkLogBasicInforamtion();

  /// Generate statistic information table workspace
  DataObjects::TableWorkspace_sptr generateStatisticTable();

  Kernel::DateAndTime getAbsoluteTime(double abstimens);

  Kernel::DateAndTime calculateRelativeTime(double deltatime);
};

} // namespace Algorithms
} // namespace Mantid

#endif /* MANTID_ALGORITHMS_GETTIMESERIESLOGINFORMATION_H_ */