NXcanSASDefinitions.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
#include <map>
#include <string>
 
namespace Mantid {
namespace DataHandling {
 
namespace NXcanSAS {
 
namespace StandardProperties {
static const std::string INPUT_WORKSPACE = "InputWorkspace";
static const std::string FILENAME = "Filename";
static const std::string RADIATION_SOURCE = "RadiationSource";
static const std::string DETECTOR_NAMES = "DetectorNames";
static const std::string TRANSMISSION = "Transmission";
static const std::string TRANSMISSION_CAN = "TransmissionCan";
static const std::string SAMPLE_TRANS_RUN_NUMBER = "SampleTransmissionRunNumber";
static const std::string SAMPLE_DIRECT_RUN_NUMBER = "SampleDirectRunNumber";
static const std::string CAN_SCATTER_RUN_NUMBER = "CanScatterRunNumber";
static const std::string CAN_DIRECT_RUN_NUMBER = "CanDirectRunNumber";
static const std::string BKG_SUB_WORKSPACE = "BackgroundSubtractionWorkspace";
static const std::string BKG_SUB_SCALE = "BackgroundSubtractionScaleFactor";
static const std::string GEOMETRY = "Geometry";
static const std::string SAMPLE_HEIGHT = "SampleHeight";
static const std::string SAMPLE_WIDTH = "SampleWidth";
static const std::string SAMPLE_THICKNESS = "SampleThickness";
} // namespace StandardProperties
 
namespace PolProperties {
static const std::string INPUT_SPIN_STATES = "InputSpinStates";
static const std::string POLARIZER_COMP_NAME = "PolarizerComponentName";
static const std::string ANALYZER_COMP_NAME = "AnalyzerComponentName";
static const std::string FLIPPER_COMP_NAMES = "FlipperComponentNames";
static const std::string MAG_FIELD_STRENGTH_LOGNAME = "MagneticFieldStrengthLogName";
static const std::string MAG_FIELD_DIR = "MagneticFieldDirection";
inline std::map<std::string, std::string> POL_COMPONENTS = {
    {"polarizer", POLARIZER_COMP_NAME}, {"analyzer", ANALYZER_COMP_NAME}, {"flipper", FLIPPER_COMP_NAMES}};
} // namespace PolProperties
 
namespace SpinStateNXcanSAS {
static const std::string SPIN_PARA = "+1";
static const std::string SPIN_ANTIPARA = "-1";
static const std::string SPIN_ZERO = "0";
} // namespace SpinStateNXcanSAS
 
// NXcanSAS file extension
const std::string NX_CANSAS_EXTENSION = ".h5";
 
// NXcanSAS Tag Definitions
const std::string sasUnitAttr = "units";
const std::string sasSignal = "signal";
const std::string sasSeparator = ",";
const std::string sasAngstrom = "A";
const std::string sasNone = "none";
const std::string sasIntensity = "1/cm";
const std::string sasMomentumTransfer = "1/A";
const std::string sasNxclass = "NX_class";
const std::string sasCanSASclass = "canSAS_class";
 
const std::string sasUncertaintyAttr = "uncertainty";
const std::string sasUncertaintiesAttr = "uncertainties";
 
// SASentry
const std::string sasEntryClassAttr = "SASentry";
const std::string nxEntryClassAttr = "NXentry";
const std::string sasEntryGroupName = "sasentry";
const std::string sasEntryVersionAttr = "version";
const std::string sasEntryVersionAttrValue = "1.1";
const std::string sasEntryDefinition = "definition";
const std::string sasEntryDefinitionFormat = "NXcanSAS";
const std::string sasEntryTitle = "title";
const std::string sasEntryRun = "run";
const std::string sasEntryRunInLogs = "run_number";
const std::string sasEntryDefaultSuffix = "01";
 
// SASdata
const std::string sasDataClassAttr = "SASdata";
const std::string nxDataClassAttr = "NXdata";
const std::string sasDataGroupName = "sasdata";
const std::string sasDataIAxesAttr = "I_axes";
const std::string sasDataIUncertaintyAttr = "I_uncertainty";
const std::string sasDataIUncertaintiesAttr = "I_uncertainties";
const std::string sasDataQIndicesAttr = "Q_indices";
const std::string sasDataQUncertaintyAttr = "Q_uncertainty";
const std::string sasDataQUncertaintiesAttr = "Q_uncertainties";
const std::string sasDataMaskIndicesAttr = "Mask_indices";
 
const std::string sasDataQ = "Q";
const std::string sasDataQx = "Qx";
const std::string sasDataQy = "Qy";
const std::string sasDataQdev = "Qdev";
 
const std::string sasDataI = "I";
const std::string sasDataIdev = "Idev";
const std::string sasDataMask = "Mask";
 
// SASinstrument
const std::string sasInstrumentClassAttr = "SASinstrument";
const std::string nxInstrumentClassAttr = "NXinstrument";
const std::string sasInstrumentGroupName = "sasinstrument";
const std::string sasInstrumentName = "name";
 
const std::string sasInstrumentSourceClassAttr = "SASsource";
const std::string nxInstrumentSourceClassAttr = "NXsource";
 
const std::string sasInstrumentSourceGroupName = "sassource";
const std::string sasInstrumentSourceRadiation = "type";
 
const std::string sasInstrumentApertureClassAttr = "SASaperture";
const std::string nxInstrumentApertureClassAttr = "NXaperture";
 
const std::string sasInstrumentApertureGroupName = "sasaperture";
const std::string sasInstrumentApertureShape = "shape";
const std::string sasInstrumentApertureGapWidth = "x_gap";
const std::string sasInstrumentApertureGapHeight = "y_gap";
 
const std::string sasInstrumentCollimationClassAttr = "SAScollimation";
const std::string nxInstrumentCollimationClassAttr = "NXcollimator";
 
const std::string sasInstrumentCollimationGroupName = "sascollimation";
 
const std::string sasInstrumentDetectorClassAttr = "SASdetector";
const std::string nxInstrumentDetectorClassAttr = "NXdetector";
 
const std::string sasInstrumentDetectorGroupName = "sasdetector";
const std::string sasInstrumentDetectorName = "name";
const std::string sasInstrumentDetectorSdd = "SDD";
const std::string sasInstrumentDetectorSddUnitAttrValue = "m";
 
const std::string sasInstrumentSampleClassAttr = "SASsample";
const std::string nxInstrumentSampleClassAttr = "NXsample";
 
const std::string sasInstrumentSampleGroupAttr = "sassample";
const std::string sasInstrumentSampleId = "ID";
const std::string sasInstrumentSampleThickness = "thickness";
 
const std::string sasBeamAndSampleSizeUnitAttrValue = "mm";
 
const std::string sasInstrumentIDF = "idf";
 
// SASpolarization
// WIP: Initial proposal: https://wiki.cansas.org/index.php?title=NXcanSAS_v1.1
const std::string sasDataPout = "Pout";
const std::string sasDataPin = "Pin";
const std::string sasDataPoutIndicesAttr = "Pout_indices";
const std::string sasDataPinIndicesAttr = "Pin_indices";
constexpr int sasDataPoutIndicesValue = 1;
constexpr int sasDataPinIndicesValue = 0;
const std::string sasDataPolarizationUnitAttr = "none";
 
struct InstrumentPolarizer {
  explicit InstrumentPolarizer(const std::string &type, const std::string &name) : m_type(type), m_name(name) {};
  std::string sasPolarizerClassAttr() const { return "SAS" + m_type; }
  std::string sasPolarizerGroupAttr() const { return "sas" + m_type; }
  std::string nxPolarizerClassAttr() const { return (m_type == "flipper") ? "NX" + m_type : "NXpolarizer"; }
  static std::string sasPolarizerName() { return "name"; }
  static std::string sasPolarizerDeviceType() { return "type"; }
  static std::string sasPolarizerIDFDeviceType() { return "device-type"; }
  static std::string sasPolarizerDistance() { return "distance"; }
  static std::string sasPolarizerDistanceUnitAttr() { return "m"; }
  const std::string &getComponentName() const { return m_name; }
  const std::string &getComponentType() const { return m_type; }
 
private:
  std::string m_type;
  std::string m_name;
};
 
const std::string sasSampleMagneticField = "magnetic_field";
const std::string sasSampleEMFieldDirectionAttr = "direction";
const std::string sasSampleEMFieldDirectionSphericalAttr = "direction_spherical";
const std::string sasSampleEMFieldDirectionPolar = "polar_angle";
const std::string sasSampleEMFieldDirectionAzimuthal = "azimuthal_angle";
const std::string sasSampleEMFieldDirectionRotation = "rotation_angle";
const std::string sasSampleEMFieldDirectionUnitsAttr = "degrees";
 
// SASprocess
const std::string sasProcessClassAttr = "SASprocess";
const std::string nxProcessClassAttr = "NXprocess";
const std::string sasProcessGroupName = "sasprocess";
const std::string sasProcessName = "name";
const std::string sasProcessNameValue = "Mantid_generated_NXcanSAS";
const std::string sasProcessDate = "date";
const std::string sasProcessTermSvn = "svn";
const std::string sasProcessTermCan = "can_trans_run";
const std::string sasProcessTermUserFile = "user_file";
const std::string sasProcessUserFileInLogs = "UserFile";
const std::string sasProcessTermBatchFile = "batch_file";
const std::string sasProcessBatchFileInLogs = "BatchFile";
 
// SASnote
const std::string sasNoteClassAttr = "SASnote";
const std::string nxNoteClassAttr = "NXnote";
const std::string sasNoteGroupName = "sasnote";
const std::string sasProcessTermSampleTrans = "sample_trans_run";
const std::string sasProcessTermSampleDirect = "sample_direct_run";
const std::string sasProcessTermCanScatter = "can_scatter_run";
const std::string sasProcessTermCanDirect = "can_direct_run";
const std::string sasProcessTermScaledBgSubWorkspace = "scaled_bgsub_workspace";
const std::string sasProcessTermScaledBgSubScaleFactor = "scaled_bgsub_scale_factor";
 
// SAStransmission_spectrum
const std::string sasTransmissionSpectrumClassAttr = "SAStransmission_spectrum";
const std::string nxTransmissionSpectrumClassAttr = "NXdata";
const std::string sasTransmissionSpectrumGroupName = "sastransmission_spectrum";
const std::string sasTransmissionSpectrumTIndices = "T_indices";
const std::string sasTransmissionSpectrumTUncertainty = "T_uncertainty";
const std::string sasTransmissionSpectrumTUncertainties = "T_uncertainties";
const std::string sasTransmissionSpectrumNameAttr = "name";
const std::string sasTransmissionSpectrumNameSampleAttrValue = "sample";
const std::string sasTransmissionSpectrumNameCanAttrValue = "can";
const std::string sasTransmissionSpectrumTimeStampAttr = "timestamp";
const std::string sasTransmissionSpectrumLambda = "lambda";
const std::string sasTransmissionSpectrumT = "T";
const std::string sasTransmissionSpectrumTdev = "Tdev";
} // namespace NXcanSAS
} // namespace DataHandling
} // namespace Mantid