Mantid::MDAlgorithms::IntegrationParameters Struct Reference

Parameters for controlling peak integration. More...

#include <Integrate3DEvents.h>

Public Attributes
double	backgroundInnerRadius
	Inner radius of background shell.
double	backgroundOuterRadius
	Outer radius of background shell.
std::vector< Kernel::V3D >	E1Vectors
	Vectors for calculating detector edges.
double	peakRadius
	Radius of peak ellipsoid.
double	regionRadius
	Radius of region to search for events.
bool	specifySize
	If true, use specified sizes; if false, use data-driven sizes.

Detailed Description

Parameters for controlling peak integration.

This structure contains the parameters needed to control the integration of peaks using ellipsoidal volumes.

Definition at line 44 of file Integrate3DEvents.h.

Member Data Documentation

backgroundInnerRadius

double Mantid::MDAlgorithms::IntegrationParameters::backgroundInnerRadius

Inner radius of background shell.

Definition at line 46 of file Integrate3DEvents.h.

Referenced by Mantid::MDAlgorithms::Integrate3DEvents::calculateRadiusFactors(), and Mantid::MDAlgorithms::IntegrateEllipsoidsTwoStep::makeIntegrationParameters().

backgroundOuterRadius

double Mantid::MDAlgorithms::IntegrationParameters::backgroundOuterRadius

Outer radius of background shell.

Definition at line 47 of file Integrate3DEvents.h.

Referenced by Mantid::MDAlgorithms::Integrate3DEvents::calculateRadiusFactors(), and Mantid::MDAlgorithms::IntegrateEllipsoidsTwoStep::makeIntegrationParameters().

E1Vectors

std::vector<Kernel::V3D> Mantid::MDAlgorithms::IntegrationParameters::E1Vectors

Vectors for calculating detector edges.

Definition at line 45 of file Integrate3DEvents.h.

Referenced by Mantid::MDAlgorithms::Integrate3DEvents::integrateStrongPeak(), Mantid::MDAlgorithms::Integrate3DEvents::integrateWeakPeak(), and Mantid::MDAlgorithms::IntegrateEllipsoidsTwoStep::makeIntegrationParameters().

peakRadius

double Mantid::MDAlgorithms::IntegrationParameters::peakRadius

Radius of peak ellipsoid.

Definition at line 49 of file Integrate3DEvents.h.

Referenced by Mantid::MDAlgorithms::Integrate3DEvents::calculateRadiusFactors(), and Mantid::MDAlgorithms::IntegrateEllipsoidsTwoStep::makeIntegrationParameters().

regionRadius

double Mantid::MDAlgorithms::IntegrationParameters::regionRadius

Radius of region to search for events.

Definition at line 48 of file Integrate3DEvents.h.

Referenced by Mantid::MDAlgorithms::Integrate3DEvents::calculateRadiusFactors(), Mantid::MDAlgorithms::Integrate3DEvents::estimateSignalToNoiseRatio(), Mantid::MDAlgorithms::Integrate3DEvents::integrateStrongPeak(), and Mantid::MDAlgorithms::IntegrateEllipsoidsTwoStep::makeIntegrationParameters().

specifySize

bool Mantid::MDAlgorithms::IntegrationParameters::specifySize

If true, use specified sizes; if false, use data-driven sizes.

Definition at line 50 of file Integrate3DEvents.h.

Referenced by Mantid::MDAlgorithms::Integrate3DEvents::calculateRadiusFactors(), and Mantid::MDAlgorithms::IntegrateEllipsoidsTwoStep::makeIntegrationParameters().

---

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

• Framework/MDAlgorithms/inc/MantidMDAlgorithms/Integrate3DEvents.h