ITK  4.8.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage > Class Template Reference

#include <itkFastMarchingUpwindGradientImageFilter.h>

+ Inheritance diagram for itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >:
+ Collaboration diagram for itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >:

Detailed Description

template<typename TLevelSet, typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
class itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >

Generates the upwind gradient field of fast marching arrival times.

This filter adds some extra functionality to its base class. While the solution T(x) of the Eikonal equation is being generated by the base class with the fast marching method, the filter generates the upwind gradient vectors of T(x), storing them in an image.

Since the Eikonal equation generates the arrival times of a wave travelling at a given speed, the generated gradient vectors can be interpreted as the slowness (1/velocity) vectors of the front (the quantity inside the modulus operator in the Eikonal equation).

Gradient vectors are computed using upwind finite differences, that is, information only propagates from points where the wavefront has already passed. This is consistent with how the fast marching method works.

One more extra feature is the possibility to define a set of Target points where the propagation stops. This can be used to avoid computing the Eikonal solution for the whole domain. The front can be stopped either when one Target point is reached or all Target points are reached. The propagation can stop after a time TargetOffset has passed since the stop condition is met. This way the solution is computed a bit downstream the Target points, so that the level sets of T(x) corresponding to the Target are smooth.

Author
Luca Antiga Ph.D. Biomedical Technologies Laboratory, Bioengineering Department, Mario Negri Institute, Italy.

Definition at line 61 of file itkFastMarchingUpwindGradientImageFilter.h.

Public Types

enum  {
  NoTargets,
  OneTarget,
  SomeTargets,
  AllTargets
}
 
typedef Superclass::AxisNodeType AxisNodeType
 
typedef SmartPointer< const SelfConstPointer
 
typedef GradientImageType::Pointer GradientImagePointer
 
typedef Image
< GradientPixelType,
itkGetStaticConstMacro(SetDimension) > 
GradientImageType
 
typedef CovariantVector
< PixelType,
itkGetStaticConstMacro(SetDimension) > 
GradientPixelType
 
typedef Superclass::IndexType IndexType
 
typedef Superclass::LabelImageType LabelImageType
 
typedef
Superclass::LevelSetImageType 
LevelSetImageType
 
typedef
Superclass::LevelSetIndexType 
LevelSetIndexType
 
typedef Superclass::LevelSetPointer LevelSetPointer
 
typedef Superclass::LevelSetType LevelSetType
 
typedef Superclass::NodeContainer NodeContainer
 
typedef
Superclass::NodeContainerPointer 
NodeContainerPointer
 
typedef Superclass::NodeType NodeType
 
typedef
Superclass::OutputSpacingType 
OutputSpacingType
 
typedef Superclass::PixelType PixelType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::OutputPointType PointType
 
typedef
FastMarchingUpwindGradientImageFilter 
Self
 
typedef
Superclass::SpeedImageConstPointer 
SpeedImageConstPointer
 
typedef Superclass::SpeedImageType SpeedImageType
 
typedef
FastMarchingImageFilter
< TLevelSet, TSpeedImage > 
Superclass
 
- Public Types inherited from itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >
typedef SmartPointer< const SelfConstPointer
 
typedef Index
< itkGetStaticConstMacro(SetDimension) > 
IndexType
 
typedef LabelImageType::Pointer LabelImagePointer
 
typedef Image< unsigned char,
itkGetStaticConstMacro(SetDimension) > 
LabelImageType
 
enum  LabelType {
  FarPoint = 0,
  AlivePoint,
  TrialPoint,
  InitialTrialPoint,
  OutsidePoint
}
 
typedef
LevelSetType::LevelSetImageType 
LevelSetImageType
 
typedef
LevelSetType::LevelSetPointer 
LevelSetPointer
 
typedef LevelSetTypeDefault
< TLevelSet > 
LevelSetType
 
typedef LevelSetType::NodeContainer NodeContainer
 
typedef
LevelSetType::NodeContainerPointer 
NodeContainerPointer
 
typedef NodeType::IndexType NodeIndexType
 
typedef LevelSetType::NodeType NodeType
 
typedef
LevelSetImageType::DirectionType 
OutputDirectionType
 
typedef
LevelSetImageType::PointType 
OutputPointType
 
typedef
LevelSetImageType::RegionType 
OutputRegionType
 
typedef LevelSetImageType::SizeType OutputSizeType
 
typedef
LevelSetImageType::SpacingType 
OutputSpacingType
 
typedef LevelSetType::PixelType PixelType
 
typedef SmartPointer< SelfPointer
 
typedef FastMarchingImageFilter Self
 
typedef
SpeedImageType::ConstPointer 
SpeedImageConstPointer
 
typedef SpeedImageType::Pointer SpeedImagePointer
 
typedef TSpeedImage SpeedImageType
 
typedef ImageSource< TLevelSet > Superclass
 
- Public Types inherited from itk::ImageToImageFilter< TSpeedImage, TLevelSet >
typedef SmartPointer< const SelfConstPointer
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TSpeedImage InputImageType
 
typedef
Superclass::OutputImagePixelType 
OutputImagePixelType
 
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
 
typedef SmartPointer< SelfPointer
 
typedef ImageToImageFilter Self
 
typedef ImageSource< TLevelSet > Superclass
 
- Public Types inherited from itk::ImageSource< TLevelSet >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TLevelSet OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef ImageSource Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject 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 () const
 
GradientImagePointer GetGradientImage () const
 
virtual const char * GetNameOfClass () const
 
virtual const SizeValueTypeGetNumberOfTargets () const
 
NodeContainerPointer GetReachedTargetPoints ()
 
virtual const double & GetTargetOffset () const
 
NodeContainerPointer GetTargetPoints ()
 
virtual const double & GetTargetValue () const
 
virtual void SetGenerateGradientImage (bool _arg)
 
virtual void SetTargetOffset (double _arg)
 
void SetTargetReachedModeToAllTargets ()
 
 typedef (Concept::DivisionOperators< typename TLevelSet::PixelType, double >) LevelSetDoubleDivisionOperatorsCheck
 
 typedef (Concept::DivisionAndAssignOperators< typename TLevelSet::PixelType, double >) LevelSetDoubleDivisionAndAssignOperatorsCheck
 
void SetTargetPoints (NodeContainer *points)
 
virtual const bool & GetGenerateGradientImage () const
 
virtual void GenerateGradientImageOn ()
 
virtual void GenerateGradientImageOff ()
 
virtual void SetTargetReachedMode (int _arg)
 
virtual const int & GetTargetReachedMode () const
 
void SetTargetReachedModeToNoTargets ()
 
void SetTargetReachedModeToOneTarget ()
 
void SetTargetReachedModeToSomeTargets (SizeValueType numberOfTargets)
 
- Public Member Functions inherited from itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >
NodeContainerPointer GetAlivePoints ()
 
LabelImagePointer GetLabelImage () const
 
NodeContainerPointer GetProcessedPoints () const
 
virtual const double & GetSpeedConstant () const
 
virtual const double & GetStoppingValue () const
 
NodeContainerPointer GetTrialPoints ()
 
template<typename TPixel >
void SetBinaryMask (Image< TPixel, SetDimension > *iImage)
 
virtual void SetCollectPoints (bool _arg)
 
virtual void SetStoppingValue (double _arg)
 
 typedef (Concept::SameDimension< SetDimension, SpeedImageDimension >) SameDimensionCheck
 
 typedef (Concept::Convertible< typename TSpeedImage::PixelType, double >) SpeedConvertibleToDoubleCheck
 
 typedef (Concept::Convertible< double, PixelType >) DoubleConvertibleToLevelSetCheck
 
 typedef (Concept::OStreamWritable< PixelType >) LevelSetOStreamWritableCheck
 
void SetOutsidePoints (NodeContainer *points)
 
void SetAlivePoints (NodeContainer *points)
 
void SetTrialPoints (NodeContainer *points)
 
void SetSpeedConstant (double value)
 
virtual void SetNormalizationFactor (double _arg)
 
virtual double GetNormalizationFactor () const
 
virtual const bool & GetCollectPoints () const
 
virtual void CollectPointsOn ()
 
virtual void CollectPointsOff ()
 
virtual void SetOutputSize (const OutputSizeType &size)
 
virtual OutputSizeType GetOutputSize () const
 
virtual void SetOutputRegion (OutputRegionType _arg)
 
virtual const OutputRegionTypeGetOutputRegion () const
 
virtual void SetOutputSpacing (OutputSpacingType _arg)
 
virtual const OutputSpacingTypeGetOutputSpacing () const
 
virtual void SetOutputDirection (OutputDirectionType _arg)
 
virtual const OutputDirectionTypeGetOutputDirection () const
 
virtual void SetOutputOrigin (OutputPointType _arg)
 
virtual const OutputPointTypeGetOutputOrigin () const
 
virtual void SetOverrideOutputInformation (bool _arg)
 
virtual const bool & GetOverrideOutputInformation () const
 
virtual void OverrideOutputInformationOn ()
 
virtual void OverrideOutputInformationOff ()
 
- Public Member Functions inherited from itk::ImageToImageFilter< TSpeedImage, TLevelSet >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
virtual void PopBackInput () override
 
virtual void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetInput (const InputImageType *image)
 
virtual void SetInput (unsigned int, const TSpeedImage *image)
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual double GetCoordinateTolerance () const
 
virtual void SetDirectionTolerance (double _arg)
 
virtual double GetDirectionTolerance () const
 
- Public Member Functions inherited from itk::ImageSource< TLevelSet >
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftOutput (DataObject *output)
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
- 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 ()
 
const MetaDataDictionaryGetMetaDataDictionary () 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 override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () 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 Member Functions inherited from itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static const unsigned int SetDimension = Superclass::SetDimension
 
- Static Public Attributes inherited from itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >
static const unsigned int SetDimension = LevelSetType::SetDimension
 
static const unsigned int SpeedImageDimension = SpeedImageType::ImageDimension
 
- Static Public Attributes inherited from itk::ImageToImageFilter< TSpeedImage, TLevelSet >
static const unsigned int InputImageDimension
 
static const unsigned int OutputImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TLevelSet >
static const unsigned int OutputImageDimension
 

Protected Member Functions

virtual void ComputeGradient (const IndexType &index, const LevelSetImageType *output, const LabelImageType *labelImage, GradientImageType *gradientImage)
 
 FastMarchingUpwindGradientImageFilter ()
 
void GenerateData () override
 
virtual void Initialize (LevelSetImageType *) override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void UpdateNeighbors (const IndexType &index, const SpeedImageType *, LevelSetImageType *) override
 
 ~FastMarchingUpwindGradientImageFilter ()
 
- Protected Member Functions inherited from itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >
virtual void EnlargeOutputRequestedRegion (DataObject *output) override
 
 FastMarchingImageFilter ()
 
virtual void GenerateOutputInformation () override
 
virtual const PixelTypeGetLargeValue () const
 
virtual const LevelSetIndexTypeGetLastIndex () const
 
const AxisNodeTypeGetNodeUsedInCalculation (unsigned int idx) const
 
virtual const LevelSetIndexTypeGetStartIndex () const
 
virtual double UpdateValue (const IndexType &index, const SpeedImageType *, LevelSetImageType *)
 
 ~FastMarchingImageFilter ()
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TSpeedImage, TLevelSet >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
virtual void GenerateInputRequestedRegion () override
 
 ImageToImageFilter ()
 
virtual void VerifyInputInformation () override
 
 ~ImageToImageFilter ()
 
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
- Protected Member Functions inherited from itk::ImageSource< TLevelSet >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual const
ImageRegionSplitterBase
GetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual ~ImageSource ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName (void) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
- 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 ()
 

Private Member Functions

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

Private Attributes

bool m_GenerateGradientImage
 
GradientImagePointer m_GradientImage
 
SizeValueType m_NumberOfTargets
 
NodeContainerPointer m_ReachedTargetPoints
 
double m_TargetOffset
 
NodeContainerPointer m_TargetPoints
 
int m_TargetReachedMode
 
double m_TargetValue
 

Additional Inherited Members

- Protected Types inherited from itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >
typedef
LevelSetImageType::IndexType 
LevelSetIndexType
 
- Protected Types inherited from itk::ImageToImageFilter< TSpeedImage, TLevelSet >
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(OutputImageDimension),
itkGetStaticConstMacro(InputImageDimension) > 
InputToOutputRegionCopierType
 
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(InputImageDimension),
itkGetStaticConstMacro(OutputImageDimension) > 
OutputToInputRegionCopierType
 
- Static Protected Member Functions inherited from itk::ImageSource< TLevelSet >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 
- Protected Attributes inherited from itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >
OutputRegionType m_BufferedRegion
 
LevelSetIndexType m_LastIndex
 
LevelSetIndexType m_StartIndex
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
typedef Superclass::AxisNodeType itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::AxisNodeType

Definition at line 85 of file itkFastMarchingUpwindGradientImageFilter.h.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
typedef SmartPointer< const Self > itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::ConstPointer

Definition at line 69 of file itkFastMarchingUpwindGradientImageFilter.h.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
typedef GradientImageType::Pointer itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::GradientImagePointer

GradientImagePointer typedef support.

Definition at line 126 of file itkFastMarchingUpwindGradientImageFilter.h.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
typedef Image< GradientPixelType, itkGetStaticConstMacro(SetDimension) > itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::GradientImageType

GradientImage typedef support.

Definition at line 123 of file itkFastMarchingUpwindGradientImageFilter.h.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
typedef CovariantVector< PixelType, itkGetStaticConstMacro(SetDimension) > itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::GradientPixelType

GradientPixel typedef support.

Definition at line 119 of file itkFastMarchingUpwindGradientImageFilter.h.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
typedef Superclass::IndexType itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::IndexType

Definition at line 90 of file itkFastMarchingUpwindGradientImageFilter.h.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
typedef Superclass::LabelImageType itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::LabelImageType

Definition at line 83 of file itkFastMarchingUpwindGradientImageFilter.h.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
typedef Superclass::LevelSetImageType itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::LevelSetImageType

Definition at line 80 of file itkFastMarchingUpwindGradientImageFilter.h.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
typedef Superclass::LevelSetIndexType itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::LevelSetIndexType

Definition at line 92 of file itkFastMarchingUpwindGradientImageFilter.h.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
typedef Superclass::LevelSetPointer itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::LevelSetPointer

Definition at line 81 of file itkFastMarchingUpwindGradientImageFilter.h.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
typedef Superclass::LevelSetType itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::LevelSetType

Inherited typedefs.

Definition at line 75 of file itkFastMarchingUpwindGradientImageFilter.h.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
typedef Superclass::NodeContainer itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::NodeContainer

Definition at line 87 of file itkFastMarchingUpwindGradientImageFilter.h.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
typedef Superclass::NodeContainerPointer itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::NodeContainerPointer

Definition at line 88 of file itkFastMarchingUpwindGradientImageFilter.h.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
typedef Superclass::NodeType itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::NodeType

Definition at line 86 of file itkFastMarchingUpwindGradientImageFilter.h.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
typedef Superclass::OutputSpacingType itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::OutputSpacingType

Definition at line 91 of file itkFastMarchingUpwindGradientImageFilter.h.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
typedef Superclass::PixelType itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::PixelType

Definition at line 84 of file itkFastMarchingUpwindGradientImageFilter.h.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
typedef SmartPointer< Self > itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::Pointer

Definition at line 68 of file itkFastMarchingUpwindGradientImageFilter.h.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
typedef Superclass::OutputPointType itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::PointType

Definition at line 94 of file itkFastMarchingUpwindGradientImageFilter.h.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
typedef FastMarchingUpwindGradientImageFilter itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::Self

Standard class typdedefs.

Definition at line 66 of file itkFastMarchingUpwindGradientImageFilter.h.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
typedef Superclass::SpeedImageConstPointer itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::SpeedImageConstPointer

Definition at line 82 of file itkFastMarchingUpwindGradientImageFilter.h.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
typedef Superclass::SpeedImageType itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::SpeedImageType

Definition at line 79 of file itkFastMarchingUpwindGradientImageFilter.h.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
typedef FastMarchingImageFilter< TLevelSet, TSpeedImage > itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::Superclass

Definition at line 67 of file itkFastMarchingUpwindGradientImageFilter.h.

Member Enumeration Documentation

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
anonymous enum
Enumerator
NoTargets 
OneTarget 
SomeTargets 
AllTargets 

Definition at line 177 of file itkFastMarchingUpwindGradientImageFilter.h.

Constructor & Destructor Documentation

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::FastMarchingUpwindGradientImageFilter ( )
protected
template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::~FastMarchingUpwindGradientImageFilter ( )
inlineprotected

Definition at line 195 of file itkFastMarchingUpwindGradientImageFilter.h.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::FastMarchingUpwindGradientImageFilter ( const Self )
private

Member Function Documentation

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
virtual void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::ComputeGradient ( const IndexType index,
const LevelSetImageType output,
const LabelImageType labelImage,
GradientImageType gradientImage 
)
protectedvirtual
template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
virtual::itk::LightObject::Pointer itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::CreateAnother ( ) 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::FastMarchingImageFilter< TLevelSet, TSpeedImage >.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::GenerateData ( void  )
overrideprotectedvirtual

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling ThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead.

See Also
ThreadedGenerateData()

Reimplemented from itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
virtual void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::GenerateGradientImageOff ( )
virtual

Get the GenerateGradientImage flag.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
virtual void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::GenerateGradientImageOn ( )
virtual

Get the GenerateGradientImage flag.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
virtual const bool& itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::GetGenerateGradientImage ( ) const
virtual

Get the GenerateGradientImage flag.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
GradientImagePointer itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::GetGradientImage ( ) const
inline
template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
virtual const char* itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
virtual const SizeValueType& itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::GetNumberOfTargets ( ) const
virtual

Get the number of targets.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
NodeContainerPointer itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::GetReachedTargetPoints ( )
inline
template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
virtual const double& itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::GetTargetOffset ( ) const
virtual

Get the TargetOffset ivar.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
NodeContainerPointer itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::GetTargetPoints ( )
inline
template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
virtual const int& itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::GetTargetReachedMode ( ) const
virtual

Choose whether the front must stop when the first target has been reached or all targets have been reached.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
virtual const double& itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::GetTargetValue ( ) const
virtual

Get the arrival time corresponding to the last reached target. If TargetReachedMode is set to NoTargets, TargetValue contains the last (aka largest) Eikonal solution value generated.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
virtual void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::Initialize ( LevelSetImageType )
overrideprotectedvirtual
template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
static Pointer itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::New ( )
static

Method for creation through the object factory.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::operator= ( const Self )
private
template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
virtual void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::SetGenerateGradientImage ( bool  _arg)
virtual

Set the GenerateGradientImage flag. Instrument the algorithm to generate the gradient of the Eikonal equation solution while fast marching.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
virtual void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::SetTargetOffset ( double  _arg)
virtual

Set how long (in terms of arrival times) after targets are reached the front must stop. This is useful to ensure that the level set of target arrival time is smooth.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::SetTargetPoints ( NodeContainer points)
inline

Set the container of Target Points. If a target point is reached, the propagation stops. Trial points are represented as a VectorContainer of LevelSetNodes.

Definition at line 102 of file itkFastMarchingUpwindGradientImageFilter.h.

References itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::m_TargetPoints, and itk::Object::Modified().

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
virtual void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::SetTargetReachedMode ( int  _arg)
virtual
template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::SetTargetReachedModeToAllTargets ( )
inline
template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::SetTargetReachedModeToNoTargets ( )
inline

Choose whether the front must stop when the first target has been reached or all targets have been reached.

Definition at line 154 of file itkFastMarchingUpwindGradientImageFilter.h.

References itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::NoTargets, and itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::SetTargetReachedMode().

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::SetTargetReachedModeToOneTarget ( )
inline

Choose whether the front must stop when the first target has been reached or all targets have been reached.

Definition at line 156 of file itkFastMarchingUpwindGradientImageFilter.h.

References itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::OneTarget, and itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::SetTargetReachedMode().

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::SetTargetReachedModeToSomeTargets ( SizeValueType  numberOfTargets)
inline
template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::typedef ( Concept::DivisionOperators< typename TLevelSet::PixelType, double >  )

This class requires LevelSetDoubleDivisionOperatorsCheck in the form of ( Concept::DivisionOperators< typename TLevelSet::PixelType, double > )

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::typedef ( Concept::DivisionAndAssignOperators< typename TLevelSet::PixelType, double >  )

This class requires LevelSetDoubleDivisionAndAssignOperatorsCheck in the form of ( Concept::DivisionAndAssignOperators< typename TLevelSet::PixelType, double > )

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
virtual void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::UpdateNeighbors ( const IndexType index,
const SpeedImageType ,
LevelSetImageType  
)
overrideprotectedvirtual

Member Data Documentation

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
bool itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::m_GenerateGradientImage
private

Definition at line 221 of file itkFastMarchingUpwindGradientImageFilter.h.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
GradientImagePointer itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::m_GradientImage
private
template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
SizeValueType itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::m_NumberOfTargets
private
template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
NodeContainerPointer itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::m_ReachedTargetPoints
private
template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
double itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::m_TargetOffset
private

Definition at line 223 of file itkFastMarchingUpwindGradientImageFilter.h.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
NodeContainerPointer itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::m_TargetPoints
private
template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
int itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::m_TargetReachedMode
private

Definition at line 225 of file itkFastMarchingUpwindGradientImageFilter.h.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
double itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::m_TargetValue
private

Definition at line 227 of file itkFastMarchingUpwindGradientImageFilter.h.

template<typename TLevelSet , typename TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
const unsigned int itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::SetDimension = Superclass::SetDimension
static

The dimension of the level set.

Definition at line 97 of file itkFastMarchingUpwindGradientImageFilter.h.


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