ITK  5.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
itk::ShapeDetectionLevelSetSegmentationModule< NDimension > Class Template Reference

#include <itkShapeDetectionLevelSetSegmentationModule.h>

+ Inheritance diagram for itk::ShapeDetectionLevelSetSegmentationModule< NDimension >:
+ Collaboration diagram for itk::ShapeDetectionLevelSetSegmentationModule< NDimension >:

Detailed Description

template<unsigned int NDimension>
class itk::ShapeDetectionLevelSetSegmentationModule< NDimension >

This class applies the ShapeDetectionLevelSet segmentation method.

SpatialObjects are used as inputs and outputs of this class.

Definition at line 36 of file itkShapeDetectionLevelSetSegmentationModule.h.

Public Types

using ConstPointer = SmartPointer< const Self >
 
using FeatureImageType = typename Superclass::FeatureImageType
 
using FeatureSpatialObjectType = typename Superclass::FeatureSpatialObjectType
 
using InputImageType = typename Superclass::InputImageType
 
using InputSpatialObjectType = typename Superclass::InputSpatialObjectType
 
using OutputImageType = typename Superclass::OutputImageType
 
using OutputPixelType = typename Superclass::OutputPixelType
 
using OutputSpatialObjectType = typename Superclass::OutputSpatialObjectType
 
using Pointer = SmartPointer< Self >
 
using Self = ShapeDetectionLevelSetSegmentationModule
 
using SpatialObjectPointer = typename Superclass::SpatialObjectPointer
 
using SpatialObjectType = typename Superclass::SpatialObjectType
 
using Superclass = SinglePhaseLevelSetSegmentationModule< NDimension >
 
- Public Types inherited from itk::SinglePhaseLevelSetSegmentationModule< NDimension >
using ConstPointer = SmartPointer< const Self >
 
using FeatureImageType = Image< FeaturePixelType, NDimension >
 
using FeaturePixelType = float
 
using FeatureSpatialObjectType = ImageSpatialObject< NDimension, FeaturePixelType >
 
using InputImageType = Image< InputPixelType, NDimension >
 
using InputPixelType = float
 
using InputSpatialObjectType = ImageSpatialObject< NDimension, InputPixelType >
 
using OutputImageType = Image< OutputPixelType, NDimension >
 
using OutputPixelType = float
 
using OutputSpatialObjectType = ImageSpatialObject< NDimension, OutputPixelType >
 
using Pointer = SmartPointer< Self >
 
using Self = SinglePhaseLevelSetSegmentationModule
 
using SpatialObjectPointer = typename Superclass::SpatialObjectPointer
 
using SpatialObjectType = typename Superclass::SpatialObjectType
 
using Superclass = SegmentationModule< NDimension >
 
- Public Types inherited from itk::SegmentationModule< NDimension >
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = SegmentationModule
 
using SpatialObjectPointer = typename SpatialObjectType::Pointer
 
using SpatialObjectType = SpatialObject< NDimension >
 
using Superclass = ProcessObject
 
- Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = DataObject::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArray = std::vector< DataObjectPointer >
 
using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
 
using MultiThreaderType = MultiThreaderBase
 
using NameArray = std::vector< DataObjectIdentifierType >
 
using Pointer = SmartPointer< Self >
 
using Self = ProcessObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::SinglePhaseLevelSetSegmentationModule< NDimension >
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual void SetPropagationScaling (double _arg)
 
virtual double GetPropagationScaling ()
 
virtual void SetCurvatureScaling (double _arg)
 
virtual double GetCurvatureScaling ()
 
virtual void SetAdvectionScaling (double _arg)
 
virtual double GetAdvectionScaling ()
 
virtual void SetMaximumRMSError (double _arg)
 
virtual double GetMaximumRMSError ()
 
virtual void SetMaximumNumberOfIterations (unsigned int _arg)
 
virtual unsigned int GetMaximumNumberOfIterations ()
 
virtual void SetInvertOutputIntensities (bool _arg)
 
virtual bool GetInvertOutputIntensities ()
 
virtual void InvertOutputIntensitiesOn ()
 
virtual void InvertOutputIntensitiesOff ()
 
- Public Member Functions inherited from itk::SegmentationModule< NDimension >
unsigned int GetExpectedNumberOfFeatures () const
 
const SpatialObjectTypeGetOutput () const
 
void SetInput (const SpatialObjectType *input)
 
const SpatialObjectTypeGetInput () const
 
void SetFeature (const SpatialObjectType *feature)
 
const SpatialObjectTypeGetFeature () const
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderTypeGetMultiThreader () 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 DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (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 SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () 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
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexceptoverride
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
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::SinglePhaseLevelSetSegmentationModule< NDimension >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::SegmentationModule< NDimension >
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 constexpr unsigned int Dimension = NDimension
 
- Static Public Attributes inherited from itk::SinglePhaseLevelSetSegmentationModule< NDimension >
static constexpr unsigned int Dimension = NDimension
 
- Static Public Attributes inherited from itk::SegmentationModule< NDimension >
static constexpr unsigned int Dimension = NDimension
 

Protected Member Functions

void GenerateData () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ShapeDetectionLevelSetSegmentationModule ()
 
 ~ShapeDetectionLevelSetSegmentationModule () override
 
- Protected Member Functions inherited from itk::SinglePhaseLevelSetSegmentationModule< NDimension >
void GenerateData () override
 
const FeatureImageTypeGetInternalFeatureImage () const
 
const InputImageTypeGetInternalInputImage () const
 
void PackOutputImageInOutputSpatialObject (OutputImageType *outputImage)
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 SinglePhaseLevelSetSegmentationModule ()
 
 ~SinglePhaseLevelSetSegmentationModule () override
 
- Protected Member Functions inherited from itk::SegmentationModule< NDimension >
SpatialObjectTypeGetInternalOutput ()
 
 SegmentationModule ()
 
 ~SegmentationModule () override
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
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
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
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 VerifyInputInformation () ITKv5_CONST
 
virtual void VerifyPreconditions () ITKv5_CONST
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () 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)
 
 ~Object () override
 
- 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 ()
 

Additional Inherited Members

- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Member Typedef Documentation

template<unsigned int NDimension>
using itk::ShapeDetectionLevelSetSegmentationModule< NDimension >::ConstPointer = SmartPointer<const Self>
template<unsigned int NDimension>
using itk::ShapeDetectionLevelSetSegmentationModule< NDimension >::FeatureImageType = typename Superclass::FeatureImageType
template<unsigned int NDimension>
using itk::ShapeDetectionLevelSetSegmentationModule< NDimension >::FeatureSpatialObjectType = typename Superclass::FeatureSpatialObjectType
template<unsigned int NDimension>
using itk::ShapeDetectionLevelSetSegmentationModule< NDimension >::InputImageType = typename Superclass::InputImageType
template<unsigned int NDimension>
using itk::ShapeDetectionLevelSetSegmentationModule< NDimension >::InputSpatialObjectType = typename Superclass::InputSpatialObjectType
template<unsigned int NDimension>
using itk::ShapeDetectionLevelSetSegmentationModule< NDimension >::OutputImageType = typename Superclass::OutputImageType
template<unsigned int NDimension>
using itk::ShapeDetectionLevelSetSegmentationModule< NDimension >::OutputPixelType = typename Superclass::OutputPixelType

Types of images and spatial objects inherited from the superclass.

Definition at line 63 of file itkShapeDetectionLevelSetSegmentationModule.h.

template<unsigned int NDimension>
using itk::ShapeDetectionLevelSetSegmentationModule< NDimension >::OutputSpatialObjectType = typename Superclass::OutputSpatialObjectType
template<unsigned int NDimension>
using itk::ShapeDetectionLevelSetSegmentationModule< NDimension >::Pointer = SmartPointer<Self>
template<unsigned int NDimension>
using itk::ShapeDetectionLevelSetSegmentationModule< NDimension >::Self = ShapeDetectionLevelSetSegmentationModule

Standard class type alias.

Definition at line 43 of file itkShapeDetectionLevelSetSegmentationModule.h.

template<unsigned int NDimension>
using itk::ShapeDetectionLevelSetSegmentationModule< NDimension >::SpatialObjectPointer = typename Superclass::SpatialObjectPointer
template<unsigned int NDimension>
using itk::ShapeDetectionLevelSetSegmentationModule< NDimension >::SpatialObjectType = typename Superclass::SpatialObjectType

Type of spatialObject that will be passed as input and output of this segmentation method.

Definition at line 59 of file itkShapeDetectionLevelSetSegmentationModule.h.

template<unsigned int NDimension>
using itk::ShapeDetectionLevelSetSegmentationModule< NDimension >::Superclass = SinglePhaseLevelSetSegmentationModule<NDimension>

Constructor & Destructor Documentation

template<unsigned int NDimension>
itk::ShapeDetectionLevelSetSegmentationModule< NDimension >::ShapeDetectionLevelSetSegmentationModule ( )
protected
template<unsigned int NDimension>
itk::ShapeDetectionLevelSetSegmentationModule< NDimension >::~ShapeDetectionLevelSetSegmentationModule ( )
overrideprotected

Member Function Documentation

template<unsigned int NDimension>
virtual::itk::LightObject::Pointer itk::ShapeDetectionLevelSetSegmentationModule< NDimension >::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::SegmentationModule< NDimension >.

template<unsigned int NDimension>
void itk::ShapeDetectionLevelSetSegmentationModule< NDimension >::GenerateData ( )
overrideprotectedvirtual

Method invoked by the pipeline in order to trigger the computation of the segmentation.

Reimplemented from itk::ProcessObject.

template<unsigned int NDimension>
virtual const char* itk::ShapeDetectionLevelSetSegmentationModule< NDimension >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::SinglePhaseLevelSetSegmentationModule< NDimension >.

template<unsigned int NDimension>
static Pointer itk::ShapeDetectionLevelSetSegmentationModule< NDimension >::New ( )
static

Method for creation through the object factory.

template<unsigned int NDimension>
void itk::ShapeDetectionLevelSetSegmentationModule< NDimension >::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::SegmentationModule< NDimension >.

Member Data Documentation

template<unsigned int NDimension>
constexpr unsigned int itk::ShapeDetectionLevelSetSegmentationModule< NDimension >::Dimension = NDimension
static

Dimension of the space

Definition at line 55 of file itkShapeDetectionLevelSetSegmentationModule.h.


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