HRPDSlabCanAbsorption.cpp

// 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 +
#include "MantidAlgorithms/HRPDSlabCanAbsorption.h"
#include "MantidAPI/MatrixWorkspace.h"
#include "MantidAPI/Sample.h"
#include "MantidAPI/SpectrumInfo.h"
#include "MantidGeometry/Instrument/Component.h"
#include "MantidKernel/BoundedValidator.h"
#include "MantidKernel/ListValidator.h"
#include "MantidKernel/Material.h"

namespace Mantid {
namespace Algorithms {

// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(HRPDSlabCanAbsorption)

using namespace Kernel;
using namespace API;
using namespace Geometry;
using namespace Mantid::PhysicalConstants;

void HRPDSlabCanAbsorption::init() {
  declareProperty(std::make_unique<WorkspaceProperty<>>("InputWorkspace", "", Direction::Input));
  declareProperty(std::make_unique<WorkspaceProperty<>>("OutputWorkspace", "", Direction::Output));

  auto mustBePositive = std::make_shared<BoundedValidator<double>>();
  mustBePositive->setLower(0.0);
  declareProperty("SampleAttenuationXSection", EMPTY_DBL(), mustBePositive,
                  "The ABSORPTION cross-section for the sample material in "
                  "barns if not set with SetSampleMaterial");
  declareProperty("SampleScatteringXSection", EMPTY_DBL(), mustBePositive,
                  "The scattering cross-section (coherent + incoherent) for "
                  "the sample material in barns if not set with "
                  "SetSampleMaterial");
  declareProperty("SampleNumberDensity", EMPTY_DBL(), mustBePositive,
                  "The number density of the sample in number of atoms per "
                  "cubic angstrom if not set with SetSampleMaterial");
  declareProperty("Thickness", 0.2, mustBePositive,
                  "The thickness of the sample in cm. Common values are 0.2, "
                  "0.5, 1.0, 1.5");

  auto positiveInt = std::make_shared<BoundedValidator<int64_t>>();
  positiveInt->setLower(1);
  declareProperty("NumberOfWavelengthPoints", int64_t(EMPTY_INT()), positiveInt,
                  "The number of wavelength points for which the numerical integral is\n"
                  "calculated (default: all points)");

  std::vector<std::string> exp_options{"Normal", "FastApprox"};
  declareProperty("ExpMethod", "Normal", std::make_shared<StringListValidator>(exp_options),
                  "Select the method to use to calculate exponentials, normal or a\n"
                  "fast approximation (default: Normal)");

  auto moreThanZero = std::make_shared<BoundedValidator<double>>();
  moreThanZero->setLower(0.001);
  declareProperty("ElementSize", 1.0, moreThanZero, "The size of one side of an integration element cube in mm");
}

void HRPDSlabCanAbsorption::exec() {
  // First run the numerical absorption correction for the sample
  MatrixWorkspace_sptr workspace = runFlatPlateAbsorption();

  /* Now do the corrections for the sample holder.
     Using an analytical formula for a flat plate correction:
        exp( -mt/cos(theta) )
     Fullprof says it then divides by another cos(theta), but I
     can't see where this comes from - it would make the transmission
     higher at higher angle, which isn't intuitive.
     In this equation, it's not obvious to me where theta should be
     calculated from - I'm taking the centre of the plate (in any
     case this would only make a very small difference)
   */

  /* The HRPD sample holders consist of a cuboid void for the sample of
     18x23 mm and some thickness, 0.125mm vanadium foil windows front
     and back, and an aluminium surround of total width 40mm, meaning
     that there is 11mm of Al to be traversed en route to the 90 degree
     bank.
   */

  const double vanWinThickness = 0.000125; // in m
  const double vanRho = 0.07192 * 100;     // in Angstroms-3 * 100
  const double vanRefAtten = -5.08 * vanRho / 1.798;
  const double vanScat = -5.1 * vanRho;

  const size_t numHists = workspace->getNumberHistograms();
  const size_t specSize = workspace->blocksize();

  const auto &spectrumInfo = workspace->spectrumInfo();
  Progress progress(this, 0.91, 1.0, numHists);
  for (size_t i = 0; i < numHists; ++i) {

    if (!spectrumInfo.hasDetectors(i)) {
      // If a spectrum doesn't have an attached detector go to next one instead
      continue;
    }

    // Get detector position
    V3D detectorPos = spectrumInfo.position(i);

    const int detID = spectrumInfo.detector(i).getID();
    double angleFactor;
    // If the low angle or backscattering bank, want angle wrt beamline
    if (detID < 900000) {
      double theta = detectorPos.angle(V3D(0.0, 0.0, 1.0));
      angleFactor = 1.0 / std::abs(cos(theta));
    }
    // For 90 degree bank need it wrt X axis
    else {
      double theta = detectorPos.angle(V3D(1.0, 0.0, 0.0));
      angleFactor = 1.0 / std::abs(cos(theta));
    }

    auto &Y = workspace->mutableY(i);
    const auto lambdas = workspace->points(i);
    for (size_t j = 0; j < specSize; ++j) {
      const double lambda = lambdas[j];

      // Front vanadium window - 0.5-1% effect, increasing with lambda
      Y[j] *= exp(vanWinThickness * ((vanRefAtten * lambda) + vanScat));

      // 90 degree bank aluminium sample holder
      if (detID > 900000) {
        // Below values are for aluminium
        Y[j] *= exp(-angleFactor * 0.011 * 6.02 * ((0.231 * lambda / 1.798) + 1.503));
      } else // Another vanadium window
      {
        Y[j] *= exp(angleFactor * vanWinThickness * ((vanRefAtten * lambda) + vanScat));
      }
    }

    progress.report();
  }

  setProperty("OutputWorkspace", workspace);
}

API::MatrixWorkspace_sptr HRPDSlabCanAbsorption::runFlatPlateAbsorption() {
  MatrixWorkspace_sptr m_inputWS = getProperty("InputWorkspace");
  double sigma_atten = getProperty("SampleAttenuationXSection"); // in barns
  double sigma_s = getProperty("SampleScatteringXSection");      // in barns
  double rho = getProperty("SampleNumberDensity");               // in Angstroms-3
  const Material &sampleMaterial = m_inputWS->sample().getMaterial();
  if (sampleMaterial.totalScatterXSection() != 0.0) {
    if (rho == EMPTY_DBL())
      rho = sampleMaterial.numberDensity();
    if (sigma_s == EMPTY_DBL())
      sigma_s = sampleMaterial.totalScatterXSection();
    if (sigma_atten == EMPTY_DBL())
      sigma_atten = sampleMaterial.absorbXSection(NeutronAtom::ReferenceLambda);
  } else // Save input in Sample with wrong atomic number and name
  {
    NeutronAtom neutron(0, 0, 0.0, 0.0, sigma_s, 0.0, sigma_s, sigma_atten);
    auto shape = std::shared_ptr<IObject>(
        m_inputWS->sample().getShape().cloneWithMaterial(Material("SetInSphericalAbsorption", neutron, rho)));
    m_inputWS->mutableSample().setShape(shape);
  }

  // Call FlatPlateAbsorption as a Child Algorithm
  IAlgorithm_sptr childAlg = createChildAlgorithm("FlatPlateAbsorption", 0.0, 0.9);
  // Pass through all the properties
  childAlg->setProperty<MatrixWorkspace_sptr>("InputWorkspace", m_inputWS);
  childAlg->setProperty<double>("AttenuationXSection", sigma_atten);
  childAlg->setProperty<double>("ScatteringXSection", sigma_s);
  childAlg->setProperty<double>("SampleNumberDensity", rho);
  childAlg->setProperty<int64_t>("NumberOfWavelengthPoints", getProperty("NumberOfWavelengthPoints"));
  childAlg->setProperty<std::string>("ExpMethod", getProperty("ExpMethod"));
  childAlg->setProperty<double>("ElementSize", getProperty("ElementSize"));
  // The height and width of the sample holder are standard for HRPD
  const double HRPDCanHeight = 2.3;
  const double HRPDCanWidth = 1.8;
  childAlg->setProperty("SampleHeight", HRPDCanHeight);
  childAlg->setProperty("SampleWidth", HRPDCanWidth);
  const double thickness = getProperty("Thickness");
  childAlg->setProperty("SampleThickness", thickness);
  childAlg->executeAsChildAlg();
  return childAlg->getProperty("OutputWorkspace");
}

} // namespace Algorithms
} // namespace Mantid