ITK  4.4.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep > Class Template Reference

#include <itkRayCastInterpolateImageFunction.h>

+ Inheritance diagram for itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >:
+ Collaboration diagram for itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >:

Detailed Description

template<class TInputImage, class TCoordRep = double>
class itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >

Projective interpolation of an image at specified positions.

RayCastInterpolateImageFunction casts rays through a 3-dimensional image and uses bilinear interpolation to integrate each plane of voxels traversed.

Warning
This interpolator works for 3-dimensional images only.

Definition at line 39 of file itkRayCastInterpolateImageFunction.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::ContinuousIndexType 
ContinuousIndexType
 
typedef Vector< TCoordRep, 3 > DirectionType
 
typedef Superclass::IndexType IndexType
 
typedef Superclass::InputImageType InputImageType
 
typedef
TransformType::InputPointType 
InputPointType
 
typedef InterpolatorType::Pointer InterpolatorPointer
 
typedef
InterpolateImageFunction
< TInputImage, TCoordRep > 
InterpolatorType
 
typedef
TransformType::OutputPointType 
OutputPointType
 
typedef Superclass::OutputType OutputType
 
typedef Superclass::InputPixelType PixelType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::PointType PointType
 
typedef Superclass::RealType RealType
 
typedef
RayCastInterpolateImageFunction 
Self
 
typedef TInputImage::SizeType SizeType
 
typedef
InterpolateImageFunction
< TInputImage, TCoordRep > 
Superclass
 
typedef TransformType::JacobianType TransformJacobianType
 
typedef
TransformType::ParametersType 
TransformParametersType
 
typedef TransformType::Pointer TransformPointer
 
typedef Transform< TCoordRep, 3, 3 > TransformType
 
- Public Types inherited from itk::InterpolateImageFunction< TInputImage, TCoordRep >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::ContinuousIndexType 
ContinuousIndexType
 
typedef Superclass::IndexType IndexType
 
typedef Superclass::IndexValueType IndexValueType
 
typedef Superclass::InputImageType InputImageType
 
typedef Superclass::OutputType OutputType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::PointType PointType
 
typedef NumericTraits
< typename
TInputImage::PixelType >
::RealType 
RealType
 
typedef InterpolateImageFunction Self
 
typedef ImageFunction
< TInputImage, typename
NumericTraits< typename
TInputImage::PixelType >
::RealType, TCoordRep > 
Superclass
 
- Public Types inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
typedef SmartPointer< const SelfConstPointer
 
typedef ContinuousIndex
< TCoordRep,
itkGetStaticConstMacro(ImageDimension) > 
ContinuousIndexType
 
typedef TCoordRep CoordRepType
 
typedef InputImageType::IndexType IndexType
 
typedef
InputImageType::IndexValueType 
IndexValueType
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef TInputImage InputImageType
 
typedef InputImageType::PixelType InputPixelType
 
typedef NumericTraits
< TInputImage::PixelType >
::RealType 
OutputType
 
typedef SmartPointer< SelfPointer
 
typedef Point< TCoordRep,
itkGetStaticConstMacro(ImageDimension) > 
PointType
 
typedef ImageFunction Self
 
typedef FunctionBase< Point
< TCoordRep,
itkGetStaticConstMacro(ImageDimension) >
, NumericTraits
< TInputImage::PixelType >
::RealType > 
Superclass
 
- Public Types inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >
typedef SmartPointer< const SelfConstPointer
 
typedef Point< TCoordRep,
TInputImage::ImageDimension > 
InputType
 
typedef NumericTraits
< TInputImage::PixelType >
::RealType 
OutputType
 
typedef SmartPointer< SelfPointer
 
typedef FunctionBase Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual OutputType Evaluate (const PointType &point) const
 
virtual OutputType EvaluateAtContinuousIndex (const ContinuousIndexType &index) const
 
virtual InputPointType GetFocalPoint () const
 
virtual const InterpolatorTypeGetInterpolator () const
 
virtual InterpolatorTypeGetModifiableInterpolator ()
 
virtual TransformTypeGetModifiableTransform ()
 
virtual const char * GetNameOfClass () const
 
virtual double GetThreshold () const
 
virtual const TransformTypeGetTransform () const
 
bool IsInsideBuffer (const PointType &) const
 
bool IsInsideBuffer (const ContinuousIndexType &) const
 
bool IsInsideBuffer (const IndexType &) const
 
virtual void SetFocalPoint (InputPointType _arg)
 
virtual void SetInterpolator (InterpolatorType *_arg)
 
virtual void SetThreshold (double _arg)
 
virtual void SetTransform (TransformType *_arg)
 
- Public Member Functions inherited from itk::InterpolateImageFunction< TInputImage, TCoordRep >
virtual OutputType EvaluateAtIndex (const IndexType &index) const
 
- Public Member Functions inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
void ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const
 
void ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const
 
void ConvertPointToNearestIndex (const PointType &point, IndexType &index) const
 
virtual NumericTraits
< TInputImage::PixelType >
::RealType 
EvaluateAtContinuousIndex (const ContinuousIndexType &index) const =0
 
virtual NumericTraits
< TInputImage::PixelType >
::RealType 
EvaluateAtIndex (const IndexType &index) const =0
 
virtual const ContinuousIndexTypeGetEndContinuousIndex ()
 
virtual const IndexTypeGetEndIndex ()
 
const InputImageTypeGetInputImage () const
 
virtual const ContinuousIndexTypeGetStartContinuousIndex ()
 
virtual const IndexTypeGetStartIndex ()
 
virtual void SetInputImage (const InputImageType *ptr)
 
virtual bool IsInsideBuffer (const IndexType &index) const
 
virtual bool IsInsideBuffer (const ContinuousIndexType &index) const
 
- Public Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >
virtual OutputType Evaluate (const InputType &input) const =0
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 

Static Public Attributes

static const unsigned int ImageDimension = Superclass::ImageDimension
 
static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
- Static Public Attributes inherited from itk::InterpolateImageFunction< TInputImage, TCoordRep >
static const unsigned int ImageDimension = Superclass::ImageDimension
 
- Static Public Attributes inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
static const unsigned int ImageDimension
 

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const
 
 RayCastInterpolateImageFunction ()
 
 ~RayCastInterpolateImageFunction ()
 
- Protected Member Functions inherited from itk::InterpolateImageFunction< TInputImage, TCoordRep >
 InterpolateImageFunction ()
 
 ~InterpolateImageFunction ()
 
- Protected Member Functions inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
 ImageFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const
 
 ~ImageFunction ()
 
- Protected Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >
 FunctionBase ()
 
 ~FunctionBase ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

InputPointType m_FocalPoint
 
InterpolatorPointer m_Interpolator
 
double m_Threshold
 
TransformPointer m_Transform
 

Private Member Functions

void operator= (const Self &)
 
 RayCastInterpolateImageFunction (const Self &)
 

Additional Inherited Members

- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 

Member Typedef Documentation

template<class TInputImage , class TCoordRep = double>
typedef SmartPointer< const Self > itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::ConstPointer

Definition at line 47 of file itkRayCastInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>
typedef Superclass::ContinuousIndexType itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::ContinuousIndexType

ContinuousIndex typedef support.

Definition at line 101 of file itkRayCastInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>
typedef Vector< TCoordRep, 3 > itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::DirectionType

Definition at line 69 of file itkRayCastInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>
typedef Superclass::IndexType itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::IndexType

Index typedef support.

Definition at line 98 of file itkRayCastInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>
typedef Superclass::InputImageType itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::InputImageType

InputImageType typedef support.

Definition at line 86 of file itkRayCastInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>
typedef TransformType::InputPointType itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::InputPointType

Definition at line 60 of file itkRayCastInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>
typedef InterpolatorType::Pointer itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::InterpolatorPointer

Definition at line 74 of file itkRayCastInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>
typedef InterpolateImageFunction< TInputImage, TCoordRep > itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::InterpolatorType

Type of the Interpolator Base class

Definition at line 72 of file itkRayCastInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>
typedef TransformType::OutputPointType itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::OutputPointType

Definition at line 61 of file itkRayCastInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>
typedef Superclass::OutputType itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::OutputType

OutputType typedef support.

Definition at line 80 of file itkRayCastInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>
typedef Superclass::InputPixelType itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::PixelType

Definition at line 65 of file itkRayCastInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>
typedef SmartPointer< Self > itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::Pointer

Definition at line 46 of file itkRayCastInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>
typedef Superclass::PointType itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::PointType

Point typedef support.

Definition at line 95 of file itkRayCastInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>
typedef Superclass::RealType itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::RealType

RealType typedef support.

Definition at line 89 of file itkRayCastInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>
typedef RayCastInterpolateImageFunction itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::Self

Standard class typedefs.

Definition at line 44 of file itkRayCastInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>
typedef TInputImage::SizeType itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::SizeType

Definition at line 67 of file itkRayCastInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>
typedef InterpolateImageFunction< TInputImage, TCoordRep > itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::Superclass

Definition at line 45 of file itkRayCastInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>
typedef TransformType::JacobianType itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::TransformJacobianType

Definition at line 63 of file itkRayCastInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>
typedef TransformType::ParametersType itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::TransformParametersType

Definition at line 62 of file itkRayCastInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>
typedef TransformType::Pointer itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::TransformPointer

Definition at line 59 of file itkRayCastInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>
typedef Transform< TCoordRep, 3, 3 > itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::TransformType

Type of the Transform Base class The fixed image should be a 3D image

Definition at line 57 of file itkRayCastInterpolateImageFunction.h.

Constructor & Destructor Documentation

template<class TInputImage , class TCoordRep = double>
itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::RayCastInterpolateImageFunction ( )
protected

Constructor.

template<class TInputImage , class TCoordRep = double>
itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::~RayCastInterpolateImageFunction ( )
inlineprotected

Destructor.

Definition at line 177 of file itkRayCastInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>
itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::RayCastInterpolateImageFunction ( const Self )
private

Member Function Documentation

template<class TInputImage , class TCoordRep = double>
virtual::itk::LightObject::Pointer itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::CreateAnother ( void  ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<class TInputImage , class TCoordRep = double>
virtual OutputType itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::Evaluate ( const PointType point) const
virtual

Interpolate the image at a point position.

Returns the interpolated image intensity at a specified point position. No bounds checking is done. The point is assume to lie within the image buffer.

ImageFunction::IsInsideBuffer() can be used to check bounds before calling the method.

Reimplemented from itk::InterpolateImageFunction< TInputImage, TCoordRep >.

template<class TInputImage , class TCoordRep = double>
virtual OutputType itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex ( const ContinuousIndexType index) const
virtual

Interpolate the image at a continuous index position

Returns the interpolated image intensity at a specified index position. No bounds checking is done. The point is assume to lie within the image buffer.

Subclasses must override this method.

ImageFunction::IsInsideBuffer() can be used to check bounds before calling the method.

Implements itk::InterpolateImageFunction< TInputImage, TCoordRep >.

template<class TInputImage , class TCoordRep = double>
virtual InputPointType itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::GetFocalPoint ( ) const
virtual

Get a pointer to the Interpolator.

template<class TInputImage , class TCoordRep = double>
virtual const InterpolatorType* itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::GetInterpolator ( ) const
virtual
template<class TInputImage , class TCoordRep = double>
virtual InterpolatorType* itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::GetModifiableInterpolator ( )
virtual

Get a pointer to the Interpolator.

template<class TInputImage , class TCoordRep = double>
virtual TransformType* itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::GetModifiableTransform ( )
virtual

Get a pointer to the Transform.

template<class TInputImage , class TCoordRep = double>
virtual const char* itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::InterpolateImageFunction< TInputImage, TCoordRep >.

template<class TInputImage , class TCoordRep = double>
virtual double itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::GetThreshold ( ) const
virtual

Get a pointer to the Transform.

template<class TInputImage , class TCoordRep = double>
virtual const TransformType* itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::GetTransform ( ) const
virtual
template<class TInputImage , class TCoordRep = double>
bool itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::IsInsideBuffer ( const PointType ) const
inlinevirtual

Check if a point is inside the image buffer.

Warning
For efficiency, no validity checking of the input image pointer is done.

Reimplemented from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >.

Definition at line 156 of file itkRayCastInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>
bool itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::IsInsideBuffer ( const ContinuousIndexType ) const
inline

Definition at line 161 of file itkRayCastInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>
bool itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::IsInsideBuffer ( const IndexType ) const
inline

Definition at line 166 of file itkRayCastInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>
static Pointer itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::New ( )
static

Method for creation through the object factory.

template<class TInputImage , class TCoordRep = double>
void itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::operator= ( const Self )
private
template<class TInputImage , class TCoordRep = double>
void itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

Print the object.

Reimplemented from itk::InterpolateImageFunction< TInputImage, TCoordRep >.

template<class TInputImage , class TCoordRep = double>
virtual void itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::SetFocalPoint ( InputPointType  _arg)
virtual

Connect the Interpolator.

template<class TInputImage , class TCoordRep = double>
virtual void itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::SetInterpolator ( InterpolatorType _arg)
virtual

Connect the Interpolator.

template<class TInputImage , class TCoordRep = double>
virtual void itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::SetThreshold ( double  _arg)
virtual

Connect the Transform.

template<class TInputImage , class TCoordRep = double>
virtual void itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::SetTransform ( TransformType _arg)
virtual

Connect the Transform.

Member Data Documentation

template<class TInputImage , class TCoordRep = double>
const unsigned int itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::ImageDimension = Superclass::ImageDimension
static

Dimension underlying input image.

Definition at line 92 of file itkRayCastInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>
const unsigned int itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::InputImageDimension = TInputImage::ImageDimension
static

Constants for the image dimensions

Definition at line 51 of file itkRayCastInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>
InputPointType itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::m_FocalPoint
protected

The focal point or position of the ray source.

Definition at line 186 of file itkRayCastInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>
InterpolatorPointer itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::m_Interpolator
protected

Pointer to the interpolator.

Definition at line 192 of file itkRayCastInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>
double itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::m_Threshold
protected

The threshold above which voxels along the ray path are integrated.

Definition at line 189 of file itkRayCastInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>
TransformPointer itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >::m_Transform
protected

Transformation used to calculate the new focal point position.

Definition at line 183 of file itkRayCastInterpolateImageFunction.h.


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