Mantid
Loading...
Searching...
No Matches
NXcanSASDefinitions.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2018 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#include <string>
10
11namespace Mantid {
12namespace DataHandling {
13
14namespace NXcanSAS {
15// General
17
18// NXcanSAS Tag Definitions
19const std::string sasUnitAttr = "units";
20const std::string sasSignal = "signal";
21const std::string sasSeparator = ",";
22const std::string sasAngstrom = "A";
23const std::string sasNone = "none";
24const std::string sasIntensity = "1/cm";
25const std::string sasMomentumTransfer = "1/A";
26const std::string sasNxclass = "NX_class";
27const std::string sasCanSASclass = "canSAS_class";
28
35const std::string sasUncertaintyAttr = "uncertainty";
36const std::string sasUncertaintiesAttr = "uncertainties";
37
38// SASentry
39const std::string sasEntryClassAttr = "SASentry";
40const std::string nxEntryClassAttr = "NXentry";
41const std::string sasEntryGroupName = "sasentry";
42const std::string sasEntryVersionAttr = "version";
43const std::string sasEntryVersionAttrValue = "1.1";
44const std::string sasEntryDefinition = "definition";
45const std::string sasEntryDefinitionFormat = "NXcanSAS";
46const std::string sasEntryTitle = "title";
47const std::string sasEntryRun = "run";
48const std::string sasEntryRunInLogs = "run_number";
49
50// SASdata
51const std::string sasDataClassAttr = "SASdata";
52const std::string nxDataClassAttr = "NXdata";
53const std::string sasDataGroupName = "sasdata";
54const std::string sasDataIAxesAttr = "I_axes";
55const std::string sasDataIUncertaintyAttr = "I_uncertainty";
56const std::string sasDataIUncertaintiesAttr = "I_uncertainties";
57const std::string sasDataQIndicesAttr = "Q_indices";
58const std::string sasDataQUncertaintyAttr = "Q_uncertainty";
59const std::string sasDataQUncertaintiesAttr = "Q_uncertainties";
60const std::string sasDataMaskIndicesAttr = "Mask_indices";
61
62const std::string sasDataQ = "Q";
63const std::string sasDataQx = "Qx";
64const std::string sasDataQy = "Qy";
65const std::string sasDataQdev = "Qdev";
66
67const std::string sasDataI = "I";
68const std::string sasDataIdev = "Idev";
69const std::string sasDataMask = "Mask";
70
71// SASinstrument
72const std::string sasInstrumentClassAttr = "SASinstrument";
73const std::string nxInstrumentClassAttr = "NXinstrument";
74const std::string sasInstrumentGroupName = "sasinstrument";
75const std::string sasInstrumentName = "name";
76
77const std::string sasInstrumentSourceClassAttr = "SASsource";
78const std::string nxInstrumentSourceClassAttr = "NXsource";
79
80const std::string sasInstrumentSourceGroupName = "sassource";
81const std::string sasInstrumentSourceRadiation = "type";
82
83const std::string sasInstrumentCollimationClassAttr = "SAScollimation";
84const std::string nxInstrumentCollimationClassAttr = "NXcollimator";
85
86const std::string sasInstrumentCollimationGroupName = "sascollimation";
87
88const std::string sasInstrumentDetectorClassAttr = "SASdetector";
89const std::string nxInstrumentDetectorClassAttr = "NXdetector";
90
91const std::string sasInstrumentDetectorGroupName = "sasdetector";
92const std::string sasInstrumentDetectorName = "name";
93const std::string sasInstrumentDetectorSdd = "SDD";
95
96const std::string sasInstrumentSampleClassAttr = "SASsample";
97const std::string nxInstrumentSampleClassAttr = "NXsample";
98
99const std::string sasInstrumentSampleGroupAttr = "sassample";
100const std::string sasInstrumentSampleId = "ID";
101
102const std::string sasInstrumentIDF = "idf";
103
104// SASprocess
105const std::string sasProcessClassAttr = "SASprocess";
106const std::string nxProcessClassAttr = "NXprocess";
107const std::string sasProcessGroupName = "sasprocess";
108const std::string sasProcessName = "name";
109const std::string sasProcessNameValue = "Mantid_generated_NXcanSAS";
110const std::string sasProcessDate = "date";
111const std::string sasProcessTermSvn = "svn";
112const std::string sasProcessTermCan = "can_trans_run";
113const std::string sasProcessTermUserFile = "user_file";
114const std::string sasProcessUserFileInLogs = "UserFile";
115const std::string sasProcessTermBatchFile = "batch_file";
116const std::string sasProcessBatchFileInLogs = "BatchFile";
117
118// SASnote
119const std::string sasNoteClassAttr = "SASnote";
120const std::string nxNoteClassAttr = "NXnote";
121const std::string sasNoteGroupName = "sasnote";
122const std::string sasProcessTermSampleTrans = "sample_trans_run";
123const std::string sasProcessTermSampleDirect = "sample_direct_run";
124const std::string sasProcessTermCanScatter = "can_scatter_run";
125const std::string sasProcessTermCanDirect = "can_direct_run";
126
127// SAStransmission_spectrum
128const std::string sasTransmissionSpectrumClassAttr = "SAStransmission_spectrum";
129const std::string nxTransmissionSpectrumClassAttr = "NXdata";
130const std::string sasTransmissionSpectrumGroupName = "sastransmission_spectrum";
131const std::string sasTransmissionSpectrumTIndices = "T_indices";
132const std::string sasTransmissionSpectrumTUncertainty = "T_uncertainty";
133const std::string sasTransmissionSpectrumTUncertainties = "T_uncertainties";
134const std::string sasTransmissionSpectrumNameAttr = "name";
137const std::string sasTransmissionSpectrumTimeStampAttr = "timestamp";
138const std::string sasTransmissionSpectrumLambda = "lambda";
139const std::string sasTransmissionSpectrumT = "T";
140const std::string sasTransmissionSpectrumTdev = "Tdev";
141} // namespace NXcanSAS
142} // namespace DataHandling
143} // namespace Mantid
const std::string sasTransmissionSpectrumNameAttr
const std::string sasTransmissionSpectrumNameCanAttrValue
const std::string sasInstrumentClassAttr
const std::string sasInstrumentSampleClassAttr
const std::string sasInstrumentSourceRadiation
const std::string sasDataQUncertaintiesAttr
const std::string sasTransmissionSpectrumTdev
const std::string sasTransmissionSpectrumT
const std::string sasInstrumentCollimationGroupName
const std::string nxTransmissionSpectrumClassAttr
const std::string sasDataMaskIndicesAttr
const std::string sasTransmissionSpectrumTIndices
const std::string sasUncertaintyAttr
Standards state that "uncertainties" should be used, however different facilities interpret the stand...
const std::string sasInstrumentDetectorSdd
const std::string sasTransmissionSpectrumTUncertainties
const std::string sasProcessTermSampleDirect
const std::string nxInstrumentCollimationClassAttr
const std::string sasTransmissionSpectrumLambda
const std::string sasInstrumentDetectorClassAttr
const std::string sasInstrumentSourceGroupName
const std::string nxInstrumentSourceClassAttr
const std::string sasProcessTermCanScatter
const std::string sasTransmissionSpectrumNameSampleAttrValue
const std::string sasInstrumentCollimationClassAttr
const std::string nxInstrumentSampleClassAttr
const std::string sasInstrumentDetectorSddUnitAttrValue
const std::string sasDataQUncertaintyAttr
const std::string sasProcessUserFileInLogs
const std::string sasTransmissionSpectrumTUncertainty
const std::string sasInstrumentSourceClassAttr
const std::string nxInstrumentDetectorClassAttr
const std::string sasEntryVersionAttrValue
const std::string sasEntryDefinitionFormat
const std::string sasDataIUncertaintiesAttr
const std::string sasProcessBatchFileInLogs
const std::string sasTransmissionSpectrumTimeStampAttr
const std::string sasInstrumentDetectorName
const std::string sasTransmissionSpectrumGroupName
const std::string sasInstrumentDetectorGroupName
const std::string sasTransmissionSpectrumClassAttr
const std::string sasDataIUncertaintyAttr
const std::string sasInstrumentSampleGroupAttr
const std::string sasProcessTermSampleTrans
const std::string sasInstrumentGroupName
Helper class which provides the Collimation Length for SANS instruments.