Mantid::Algorithms::IBeamProfile Class Reference

Base class for all classes defining a beam profile. More...

#include <IBeamProfile.h>

Inheritance diagram for Mantid::Algorithms::IBeamProfile:

Classes
struct	Ray

Public Member Functions
virtual Geometry::BoundingBox	defineActiveRegion (const Geometry::BoundingBox &) const =0
virtual Ray	generatePoint (Kernel::PseudoRandomNumberGenerator &rng) const =0
virtual Ray	generatePoint (Kernel::PseudoRandomNumberGenerator &rng, const Geometry::BoundingBox &) const =0
virtual	~IBeamProfile ()=default

Detailed Description

Base class for all classes defining a beam profile.

Definition at line 26 of file IBeamProfile.h.

Constructor & Destructor Documentation

~IBeamProfile()

virtual Mantid::Algorithms::IBeamProfile::~IBeamProfile ( )

virtualdefault

Member Function Documentation

defineActiveRegion()

virtual Geometry::BoundingBox Mantid::Algorithms::IBeamProfile::defineActiveRegion ( const Geometry::BoundingBox &  ) const

pure virtual

Implemented in Mantid::Algorithms::RectangularBeamProfile, and Mantid::Algorithms::CircularBeamProfile.

Referenced by Mantid::Algorithms::MCAbsorptionStrategy::setActiveRegion().

generatePoint() [1/2]

virtual Ray Mantid::Algorithms::IBeamProfile::generatePoint ( Kernel::PseudoRandomNumberGenerator &  rng ) const

pure virtual

Implemented in Mantid::Algorithms::CircularBeamProfile, and Mantid::Algorithms::RectangularBeamProfile.

Referenced by Mantid::Algorithms::MCAbsorptionStrategy::calculate().

generatePoint() [2/2]

virtual Ray Mantid::Algorithms::IBeamProfile::generatePoint ( Kernel::PseudoRandomNumberGenerator &  rng, const Geometry::BoundingBox &    ) const

pure virtual

Implemented in Mantid::Algorithms::CircularBeamProfile, and Mantid::Algorithms::RectangularBeamProfile.

---

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

• Framework/Algorithms/inc/MantidAlgorithms/SampleCorrections/IBeamProfile.h