Mantid::DataObjects::CalculateReflectometry Class Reference

Provides a common interface to Reflectometry Transform calculators. More...

#include <CalculateReflectometry.h>

Inheritance diagram for Mantid::DataObjects::CalculateReflectometry:

Public Member Functions
virtual double	calculateDim0 (double wavelength) const =0
	Executes the calculation on dimension 0. More...
virtual double	calculateDim1 (double wavelength) const =0
	Executes the calculation on dimension 1. More...
	CalculateReflectometry (int version)
virtual Mantid::Geometry::Quadrilateral	createQuad (double lamLower, double lamUpper, double thetaLower, double thetaUpper)=0
virtual void	setThetaFinal (double thetaFinal)=0
	Setter for the final theta value require for the calculation. More...
void	setThetaIncident (double thetaIncident)
	Setter for the incident theta value require for the calculation. More...
virtual void	setTwoTheta (double twoTheta)=0
	Set the final theta value from the detector twoTheta angle. More...
virtual void	updateThetaIncident (double thetaIncident)=0
	Derived class setter for the final theta value require for the calculation. More...
virtual	~CalculateReflectometry ()=default

Protected Attributes
double	m_theta_i {0.0}
int	m_version
const double	to_radians_factor = M_PI / 180.0

Detailed Description

Provides a common interface to Reflectometry Transform calculators.

Definition at line 18 of file CalculateReflectometry.h.

Constructor & Destructor Documentation

CalculateReflectometry()

Mantid::DataObjects::CalculateReflectometry::CalculateReflectometry ( int  version )

inline

Definition at line 26 of file CalculateReflectometry.h.

~CalculateReflectometry()

virtual Mantid::DataObjects::CalculateReflectometry::~CalculateReflectometry ( )

virtualdefault

Member Function Documentation

calculateDim0()

virtual double Mantid::DataObjects::CalculateReflectometry::calculateDim0 ( double  wavelength ) const

pure virtual

Executes the calculation on dimension 0.

Parameters

wavelength

: wavelength in Angstroms

Implemented in Mantid::DataObjects::CalculateReflectometryKiKf, Mantid::DataObjects::CalculateReflectometryP, and Mantid::DataObjects::CalculateReflectometryQxQz.

calculateDim1()

virtual double Mantid::DataObjects::CalculateReflectometry::calculateDim1 ( double  wavelength ) const

pure virtual

Executes the calculation on dimension 1.

Parameters

wavelength

: wavelength in Angstroms

Implemented in Mantid::DataObjects::CalculateReflectometryKiKf, Mantid::DataObjects::CalculateReflectometryP, and Mantid::DataObjects::CalculateReflectometryQxQz.

createQuad()

virtual Mantid::Geometry::Quadrilateral Mantid::DataObjects::CalculateReflectometry::createQuad ( double  lamLower, double  lamUpper, double  thetaLower, double  thetaUpper  )

pure virtual

Implemented in Mantid::DataObjects::CalculateReflectometryKiKf, Mantid::DataObjects::CalculateReflectometryP, and Mantid::DataObjects::CalculateReflectometryQxQz.

setThetaFinal()

virtual void Mantid::DataObjects::CalculateReflectometry::setThetaFinal ( double  thetaFinal )

pure virtual

Setter for the final theta value require for the calculation.

Parameters

thetaFinal

final theta value in degrees

Implemented in Mantid::DataObjects::CalculateReflectometryKiKf, Mantid::DataObjects::CalculateReflectometryP, and Mantid::DataObjects::CalculateReflectometryQxQz.

setThetaIncident()

void Mantid::DataObjects::CalculateReflectometry::setThetaIncident ( double  thetaIncident )

inline

Setter for the incident theta value require for the calculation.

Parameters

thetaIncident

incident theta value in degrees

Definition at line 33 of file CalculateReflectometry.h.

References m_theta_i, and updateThetaIncident().

setTwoTheta()

virtual void Mantid::DataObjects::CalculateReflectometry::setTwoTheta ( double  twoTheta )

pure virtual

Set the final theta value from the detector twoTheta angle.

Parameters

twoTheta

detector twoTheta value in degrees

Implemented in Mantid::DataObjects::CalculateReflectometryKiKf, Mantid::DataObjects::CalculateReflectometryP, and Mantid::DataObjects::CalculateReflectometryQxQz.

updateThetaIncident()

virtual void Mantid::DataObjects::CalculateReflectometry::updateThetaIncident ( double  thetaIncident )

pure virtual

Derived class setter for the final theta value require for the calculation.

Parameters

thetaIncident

incident theta value in degrees

Implemented in Mantid::DataObjects::CalculateReflectometryKiKf, Mantid::DataObjects::CalculateReflectometryP, and Mantid::DataObjects::CalculateReflectometryQxQz.

Referenced by setThetaIncident().

Member Data Documentation

m_theta_i

double Mantid::DataObjects::CalculateReflectometry::m_theta_i {0.0}

protected

Definition at line 21 of file CalculateReflectometry.h.

Referenced by setThetaIncident(), Mantid::DataObjects::CalculateReflectometryKiKf::setTwoTheta(), Mantid::DataObjects::CalculateReflectometryP::setTwoTheta(), and Mantid::DataObjects::CalculateReflectometryQxQz::setTwoTheta().

m_version

int Mantid::DataObjects::CalculateReflectometry::m_version

protected

Definition at line 23 of file CalculateReflectometry.h.

Referenced by Mantid::DataObjects::CalculateReflectometryKiKf::setTwoTheta(), Mantid::DataObjects::CalculateReflectometryP::setTwoTheta(), and Mantid::DataObjects::CalculateReflectometryQxQz::setTwoTheta().

to_radians_factor

const double Mantid::DataObjects::CalculateReflectometry::to_radians_factor = M_PI / 180.0

protected

Definition at line 22 of file CalculateReflectometry.h.

Referenced by Mantid::DataObjects::CalculateReflectometryKiKf::setThetaFinal(), Mantid::DataObjects::CalculateReflectometryP::setThetaFinal(), Mantid::DataObjects::CalculateReflectometryQxQz::setThetaFinal(), Mantid::DataObjects::CalculateReflectometryKiKf::updateThetaIncident(), Mantid::DataObjects::CalculateReflectometryP::updateThetaIncident(), and Mantid::DataObjects::CalculateReflectometryQxQz::updateThetaIncident().

---

The documentation for this class was generated from the following file:

• Framework/DataObjects/inc/MantidDataObjects/CalculateReflectometry.h