Mantid
Loading...
Searching...
No Matches
Framework
DataHandling
inc
MantidDataHandling
LoadSINQFocus.h
Go to the documentation of this file.
1
// Mantid Repository : https://github.com/mantidproject/mantid
2
//
3
// Copyright © 2013 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/DeprecatedAlgorithm.h
"
13
#include "
MantidAPI/IFileLoader.h
"
14
#include "MantidDataHandling/DllConfig.h"
15
#include "
MantidNexus/NexusClasses_fwd.h
"
16
#include "
MantidNexus/NexusDescriptor.h
"
17
18
namespace
Mantid
{
19
namespace
DataHandling {
20
30
class
MANTID_DATAHANDLING_DLL
LoadSINQFocus
:
public
API::IFileLoader
<Nexus::NexusDescriptor>,
31
public
API::DeprecatedAlgorithm
{
32
public
:
33
LoadSINQFocus
();
34
const
std::string
name
()
const override
;
36
const
std::string
summary
()
const override
{
return
"Loads a FOCUS nexus file from the PSI"
; }
37
38
int
version()
const override
;
39
const
std::vector<std::string>
seeAlso
()
const override
{
return
{
"LoadSINQ"
,
"LoadSINQFile"
}; }
40
const
std::string category()
const override
;
41
43
int
confidence(
Nexus::NexusDescriptor
&descriptor)
const override
;
44
45
private
:
46
void
init()
override
;
47
void
exec()
override
;
48
void
setInstrumentName(
const
Nexus::NXEntry
&entry);
49
void
initWorkSpace(
const
Nexus::NXEntry
&);
50
void
loadDataIntoTheWorkSpace(
Nexus::NXEntry
&);
52
static
double
calculateError
(
double
in) {
return
sqrt(in); }
53
void
loadExperimentDetails(
const
Nexus::NXEntry
&);
54
void
loadRunDetails(
const
Nexus::NXEntry
&);
55
void
runLoadInstrument();
56
57
std::vector<std::string>
m_supportedInstruments
;
58
std::string
m_instrumentName
;
59
std::string
m_instrumentAddress
;
60
API::MatrixWorkspace_sptr
m_localWorkspace
;
61
size_t
m_numberOfTubes
;
// number of tubes - X
62
size_t
m_numberOfPixelsPerTube
;
// number of pixels per tube - Y
63
size_t
m_numberOfChannels
;
// time channels - Z
64
size_t
m_numberOfHistograms
;
65
};
66
67
}
// namespace DataHandling
68
}
// namespace Mantid
name
std::string name
Definition
Run.cpp:60
DeprecatedAlgorithm.h
IFileLoader.h
NexusClasses_fwd.h
NexusDescriptor.h
Mantid::API::DeprecatedAlgorithm
Class for marking algorithms as deprecated.
Definition
DeprecatedAlgorithm.h:23
Mantid::API::IFileLoader
Defines an interface to an algorithm that loads a file so that it can take part in the automatic sele...
Definition
IFileLoader.h:19
Mantid::DataHandling::LoadSINQFocus
Loads an PSI nexus file into a Mantid workspace.
Definition
LoadSINQFocus.h:31
Mantid::DataHandling::LoadSINQFocus::m_numberOfChannels
size_t m_numberOfChannels
Definition
LoadSINQFocus.h:63
Mantid::DataHandling::LoadSINQFocus::m_numberOfTubes
size_t m_numberOfTubes
Definition
LoadSINQFocus.h:61
Mantid::DataHandling::LoadSINQFocus::m_localWorkspace
API::MatrixWorkspace_sptr m_localWorkspace
Definition
LoadSINQFocus.h:60
Mantid::DataHandling::LoadSINQFocus::calculateError
static double calculateError(double in)
Calculate error for y.
Definition
LoadSINQFocus.h:52
Mantid::DataHandling::LoadSINQFocus::m_instrumentName
std::string m_instrumentName
Definition
LoadSINQFocus.h:58
Mantid::DataHandling::LoadSINQFocus::seeAlso
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
LoadSINQFocus.h:39
Mantid::DataHandling::LoadSINQFocus::m_supportedInstruments
std::vector< std::string > m_supportedInstruments
Definition
LoadSINQFocus.h:57
Mantid::DataHandling::LoadSINQFocus::m_numberOfHistograms
size_t m_numberOfHistograms
Definition
LoadSINQFocus.h:64
Mantid::DataHandling::LoadSINQFocus::summary
const std::string summary() const override
Summary of algorithms purpose.
Definition
LoadSINQFocus.h:36
Mantid::DataHandling::LoadSINQFocus::m_instrumentAddress
std::string m_instrumentAddress
Definition
LoadSINQFocus.h:59
Mantid::DataHandling::LoadSINQFocus::m_numberOfPixelsPerTube
size_t m_numberOfPixelsPerTube
Definition
LoadSINQFocus.h:62
Mantid::Nexus::NXEntry
Implements NXentry Nexus class.
Definition
NexusClasses.h:667
Mantid::Nexus::NexusDescriptor
Definition
NexusDescriptor.h:23
Mantid::API::MatrixWorkspace_sptr
std::shared_ptr< MatrixWorkspace > MatrixWorkspace_sptr
shared pointer to the matrix workspace base class
Definition
MatrixWorkspace.h:585
Mantid
Helper class which provides the Collimation Length for SANS instruments.
Definition
AbsorptionCorrection.h:18
Generated by
1.9.8