Mantid
Loading...
Searching...
No Matches
LoadRawSpectrum0.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 {
43class MANTID_DATAHANDLING_DLL LoadRawSpectrum0 : public LoadRawHelper {
44public:
48 const std::string name() const override { return "LoadRawSpectrum0"; }
50 const std::string summary() const override {
51 return "Loads spectrum zero from ISIS raw file and stores it in a 2D "
52 "workspace (Workspace2D class).";
53 }
54
56 int version() const override { return 1; }
57 const std::vector<std::string> seeAlso() const override { return {"LoadRawBin0", "LoadRaw"}; }
59 const std::string category() const override { return "Diagnostics\\Raw;DataHandling\\Raw"; }
60
61private:
63 void init() override;
65 void exec() override;
66
69 std::shared_ptr<ISISRAW2> isisRaw;
71 std::string m_filename;
72
75
77 std::vector<std::string> m_cache_options;
79 std::map<int64_t, int64_t> m_specTimeRegimes;
81 double m_prog;
83 int64_t m_lengthIn;
86};
87} // namespace DataHandling
88} // namespace Mantid
isis raw file.
Definition: isisraw2.h:13
Helper class for LoadRaw algorithms.
Definition: LoadRawHelper.h:40
Loads zeroth spectrum from ISIS RAW format file and stores it in a 2D workspace (Workspace2D class).
int64_t m_lengthIn
Read in the time bin boundaries.
std::vector< std::string > m_cache_options
Allowed values for the cache property.
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm....
const std::string category() const override
Algorithm's category for identification overriding a virtual method.
double m_prog
The current value of the progress counter.
std::string m_filename
The name and path of the input file.
int64_t m_noTimeRegimes
number of time regime
specnum_t m_numberOfSpectra
The number of spectra in the raw file.
int version() const override
Algorithm's version for identification overriding a virtual method.
std::map< int64_t, int64_t > m_specTimeRegimes
A map for storing the time regime for each spectrum.
std::shared_ptr< ISISRAW2 > isisRaw
ISISRAW class instance which does raw file reading.
const std::string summary() const override
Summary of algorithms purpose.
const std::string name() const override
Algorithm's name for identification overriding a virtual method.
Helper class which provides the Collimation Length for SANS instruments.
int32_t specnum_t
Typedef for a spectrum Number.
Definition: IDTypes.h:16