Mantid
Loading...
Searching...
No Matches
LoadRawBin0.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2010 ISIS Rutherford Appleton Laboratory UKRI,
4// NScD Oak Ridge National Laboratory, European Spallation Source,
5// Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
6// SPDX - License - Identifier: GPL - 3.0 +
7#pragma once
8
9//----------------------------------------------------------------------
10// Includes
11//----------------------------------------------------------------------
12#include "MantidAPI/Algorithm.h"
15#include <climits>
16
17//----------------------------------------------------------------------
18// Forward declaration
19//----------------------------------------------------------------------
20class ISISRAW2;
21
22namespace Mantid {
23namespace DataHandling {
51class MANTID_DATAHANDLING_DLL LoadRawBin0 : public LoadRawHelper {
52public:
56 const std::string name() const override { return "LoadRawBin0"; }
58 const std::string summary() const override {
59 return "Loads bin zero from ISIS raw file and stores it in a 2D "
60 "workspace (Workspace2D class).";
61 }
62
64 int version() const override { return 1; }
65 const std::vector<std::string> seeAlso() const override { return {"LoadRawSpectrum0", "LoadRaw"}; }
67 const std::string category() const override { return "Diagnostics\\Raw;DataHandling\\Raw"; }
68
69private:
71 void init() override;
73 void exec() override;
74
76 void setOptionalProperties();
77
80 std::shared_ptr<ISISRAW2> isisRaw;
82 std::string m_filename;
83
88
90 std::vector<std::string> m_cache_options;
92 std::map<int64_t, int64_t> m_specTimeRegimes;
94 double m_prog;
95
97 int64_t m_lengthIn;
99 std::shared_ptr<Kernel::Property> m_perioids;
100
104 std::vector<std::shared_ptr<HistogramData::HistogramX>> m_timeChannelsVec;
105};
106} // namespace DataHandling
107} // namespace Mantid
isis raw file.
Definition: isisraw2.h:13
Loads bin zero for all spectra from ISIS RAW file and stores it in a 2D workspace (Workspace2D class)...
Definition: LoadRawBin0.h:51
std::shared_ptr< ISISRAW2 > isisRaw
ISISRAW class instance which does raw file reading.
Definition: LoadRawBin0.h:80
std::string m_filename
The name and path of the input file.
Definition: LoadRawBin0.h:82
int version() const override
Algorithm's version for identification overriding a virtual method.
Definition: LoadRawBin0.h:64
int64_t m_noTimeRegimes
number of time regime
Definition: LoadRawBin0.h:87
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm....
Definition: LoadRawBin0.h:65
double m_prog
The current value of the progress counter.
Definition: LoadRawBin0.h:94
std::shared_ptr< Kernel::Property > m_perioids
TimeSeriesProperty<int> containing data periods.
Definition: LoadRawBin0.h:99
const std::string category() const override
Algorithm's category for identification overriding a virtual method.
Definition: LoadRawBin0.h:67
int64_t m_lengthIn
Read in the time bin boundaries.
Definition: LoadRawBin0.h:97
std::vector< std::shared_ptr< HistogramData::HistogramX > > m_timeChannelsVec
time channel vector
Definition: LoadRawBin0.h:104
specnum_t m_numberOfSpectra
The number of spectra in the raw file.
Definition: LoadRawBin0.h:85
const std::string summary() const override
Summary of algorithms purpose.
Definition: LoadRawBin0.h:58
std::vector< std::string > m_cache_options
Allowed values for the cache property.
Definition: LoadRawBin0.h:90
const std::string name() const override
Algorithm's name for identification overriding a virtual method.
Definition: LoadRawBin0.h:56
specnum_t m_total_specs
total number of specs
Definition: LoadRawBin0.h:102
std::map< int64_t, int64_t > m_specTimeRegimes
A map for storing the time regime for each spectrum.
Definition: LoadRawBin0.h:92
Helper class for LoadRaw algorithms.
Definition: LoadRawHelper.h:40
Helper class which provides the Collimation Length for SANS instruments.
int32_t specnum_t
Typedef for a spectrum Number.
Definition: IDTypes.h:16