ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | List of all members
itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType > Class Template Reference

#include <itkSegmentationLevelSetImageFilter.h>

+ Inheritance diagram for itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >:
+ Collaboration diagram for itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using FeatureImageType = TFeatureImage
 
using IndexType = typename Superclass::IndexType
 
using InputImageType = typename Superclass::InputImageType
 
using OutputImageType = Image< TOutputPixelType, Self::InputImageDimension >
 
using Pointer = SmartPointer< Self >
 
using SegmentationFunctionType = SegmentationLevelSetFunction< OutputImageType, FeatureImageType >
 
using Self = SegmentationLevelSetImageFilter
 
using SpeedImageType = typename SegmentationFunctionType::ImageType
 
using Superclass = SparseFieldLevelSetImageFilter< TInputImage, OutputImageType >
 
using TimeStepType = typename Superclass::TimeStepType
 
using ValueType = typename Superclass::ValueType
 
using VectorImageType = typename SegmentationFunctionType::VectorImageType
 
- Public Types inherited from itk::SparseFieldLevelSetImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >
using ConstPointer = SmartPointer< const Self >
 
using IndexType = typename OutputImageType::IndexType
 
using InputImageType = TInputImage
 
using LayerListType = std::vector< LayerPointerType >
 
using LayerNodeStorageType = ObjectStore< LayerNodeType >
 
using LayerNodeType = SparseFieldLevelSetNode< IndexType >
 
using LayerPointerType = typename LayerType::Pointer
 
using LayerType = SparseFieldLayer< LayerNodeType >
 
using NeighborhoodScalesType = typename Superclass::NeighborhoodScalesType
 
using OutputImageType = Image< TOutputPixelType, TInputImage::ImageDimension >
 
using Pointer = SmartPointer< Self >
 
using RadiusType = typename Superclass::RadiusType
 
using Self = SparseFieldLevelSetImageFilter
 
using StatusImageType = Image< StatusType, Self::ImageDimension >
 
using StatusType = signed char
 
using Superclass = FiniteDifferenceImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >
 
using TimeStepType = typename Superclass::TimeStepType
 
using UpdateBufferType = std::vector< ValueType >
 
using ValueType = typename OutputImageType::ValueType
 
- Public Types inherited from itk::FiniteDifferenceImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >
using ConstPointer = SmartPointer< const Self >
 
using FiniteDifferenceFunctionType = FiniteDifferenceFunction< Image< TOutputPixelType, TInputImage::ImageDimension > >
 
using InputImageType = TInputImage
 
using InputPixelType = typename TInputImage::PixelType
 
using InputPixelValueType = typename NumericTraits< InputPixelType >::ValueType
 
using NeighborhoodScalesType = typename FiniteDifferenceFunctionType::NeighborhoodScalesType
 
using OutputImageType = Image< TOutputPixelType, TInputImage::ImageDimension >
 
using OutputPixelType = typename Image< TOutputPixelType, TInputImage::ImageDimension > ::PixelType
 
using OutputPixelValueType = typename NumericTraits< OutputPixelType >::ValueType
 
using PixelType = OutputPixelType
 
using Pointer = SmartPointer< Self >
 
using RadiusType = typename FiniteDifferenceFunctionType::RadiusType
 
using Self = FiniteDifferenceImageFilter
 
using Superclass = InPlaceImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >
 
using TimeStepType = typename FiniteDifferenceFunctionType::TimeStepType
 
- Public Types inherited from itk::InPlaceImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >
using ConstPointer = SmartPointer< const Self >
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage
 
using OutputImagePixelType = typename Superclass::OutputImagePixelType
 
using OutputImagePointer = typename Superclass::OutputImagePointer
 
using OutputImageRegionType = typename Superclass::OutputImageRegionType
 
using OutputImageType = typename Superclass::OutputImageType
 
using Pointer = SmartPointer< Self >
 
using Self = InPlaceImageFilter
 
using Superclass = ImageToImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >
using ConstPointer = SmartPointer< const Self >
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage
 
using OutputImagePixelType = typename Superclass::OutputImagePixelType
 
using OutputImageRegionType = typename Superclass::OutputImageRegionType
 
using Pointer = SmartPointer< Self >
 
using Self = ImageToImageFilter
 
using Superclass = ImageSource< Image< TOutputPixelType, TInputImage::ImageDimension > >
 
- Public Types inherited from itk::ImageSource< Image< TOutputPixelType, TInputImage::ImageDimension > >
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = Superclass::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType
 
using OutputImagePixelType = typename OutputImageType::PixelType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = Image< TOutputPixelType, TInputImage::ImageDimension >
 
using Pointer = SmartPointer< Self >
 
using Self = ImageSource
 
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 const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::SparseFieldLevelSetImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual void SetNumberOfLayers (unsigned int _arg)
 
virtual unsigned int GetNumberOfLayers () const
 
virtual void SetIsoSurfaceValue (ValueType _arg)
 
virtual ValueType GetIsoSurfaceValue () const
 
virtual void SetInterpolateSurfaceLocation (bool _arg)
 
virtual bool GetInterpolateSurfaceLocation () const
 
void InterpolateSurfaceLocationOn ()
 
void InterpolateSurfaceLocationOff ()
 
- Public Member Functions inherited from itk::FiniteDifferenceImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >
virtual const FiniteDifferenceFunctionType ::PointerGetDifferenceFunction () const
 
virtual const IdentifierTypeGetElapsedIterations () const
 
virtual void SetDifferenceFunction (FiniteDifferenceFunctionType *_arg)
 
virtual void SetNumberOfIterations (IdentifierType _arg)
 
virtual const IdentifierTypeGetNumberOfIterations () const
 
virtual void SetUseImageSpacing (bool _arg)
 
virtual void UseImageSpacingOn ()
 
virtual void UseImageSpacingOff ()
 
virtual const bool & GetUseImageSpacing () const
 
virtual void SetMaximumRMSError (double _arg)
 
virtual const double & GetMaximumRMSError () const
 
virtual void SetRMSChange (double _arg)
 
virtual const double & GetRMSChange () const
 
virtual void SetManualReinitialization (bool _arg)
 
virtual const bool & GetManualReinitialization () const
 
virtual void ManualReinitializationOn ()
 
virtual void ManualReinitializationOff ()
 
virtual void SetIsInitialized (bool _arg)
 
virtual bool GetIsInitialized ()
 
void SetStateToUninitialized ()
 
void SetStateToInitialized ()
 
- Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >
virtual void SetInPlace (bool _arg)
 
virtual bool GetInPlace () const
 
virtual void InPlaceOn ()
 
virtual void InPlaceOff ()
 
virtual bool CanRunInPlace () const
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
void PopBackInput () override
 
void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetInput (const InputImageType *image)
 
virtual void SetInput (unsigned int, const TInputImage *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< Image< TOutputPixelType, TInputImage::ImageDimension > >
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- 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 ()
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
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)
 
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
 
MultiThreaderTypeGetMultiThreader () const
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void PrepareOutputs ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) 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 noexcept override
 
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
 
bool m_ReverseExpansionDirection
 
bool m_AutoGenerateSpeedAdvection
 
SegmentationFunctionTypem_SegmentationFunction
 
void SetMaximumIterations (unsigned int i)
 
unsigned int GetMaximumIterations ()
 
virtual void SetFeatureImage (const FeatureImageType *f)
 
virtual const FeatureImageTypeGetFeatureImage () const
 
virtual void SetInitialImage (const InputImageType *input)
 
virtual const InputImageTypeGetInitialImage () const
 
void SetInput2 (const FeatureImageType *input)
 
void SetSpeedImage (SpeedImageType *s)
 
void SetAdvectionImage (VectorImageType *v)
 
virtual const SpeedImageTypeGetSpeedImage () const
 
virtual const VectorImageTypeGetAdvectionImage () const
 
void SetUseNegativeFeaturesOn ()
 
void SetUseNegativeFeaturesOff ()
 
void SetUseNegativeFeatures (bool u)
 
bool GetUseNegativeFeatures () const
 
virtual void SetReverseExpansionDirection (bool _arg)
 
virtual bool GetReverseExpansionDirection () const
 
virtual void ReverseExpansionDirectionOn ()
 
virtual void ReverseExpansionDirectionOff ()
 
virtual void SetAutoGenerateSpeedAdvection (bool _arg)
 
virtual bool GetAutoGenerateSpeedAdvection () const
 
virtual void AutoGenerateSpeedAdvectionOn ()
 
virtual void AutoGenerateSpeedAdvectionOff ()
 
void SetFeatureScaling (ValueType v)
 
void SetPropagationScaling (ValueType v)
 
ValueType GetPropagationScaling () const
 
void SetAdvectionScaling (ValueType v)
 
ValueType GetAdvectionScaling () const
 
void SetCurvatureScaling (ValueType v)
 
ValueType GetCurvatureScaling () const
 
void SetUseMinimalCurvature (bool b)
 
bool GetUseMinimalCurvature () const
 
void UseMinimalCurvatureOn ()
 
void UseMinimalCurvatureOff ()
 
virtual void SetSegmentationFunction (SegmentationFunctionType *s)
 
virtual SegmentationFunctionTypeGetSegmentationFunction ()
 
void SetMaximumCurvatureTimeStep (double n)
 
double GetMaximumCurvatureTimeStep () const
 
void SetMaximumPropagationTimeStep (double n)
 
double GetMaximumPropagationTimeStep () const
 
void GenerateSpeedImage ()
 
void GenerateAdvectionImage ()
 
 ~SegmentationLevelSetImageFilter () override=default
 
 SegmentationLevelSetImageFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void InitializeIteration () override
 
void GenerateData () override
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::SparseFieldLevelSetImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >
static void SetGlobalDefaultDirectionTolerance (double)
 
static double GetGlobalDefaultDirectionTolerance ()
 
static void SetGlobalDefaultCoordinateTolerance (double)
 
static double GetGlobalDefaultCoordinateTolerance ()
 
- 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 inherited from itk::SparseFieldLevelSetImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >
static constexpr unsigned int ImageDimension
 
- Static Public Attributes inherited from itk::FiniteDifferenceImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >
static constexpr unsigned int ImageDimension
 
- Static Public Attributes inherited from itk::InPlaceImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >
static constexpr unsigned int InputImageDimension
 
static constexpr unsigned int OutputImageDimension
 
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >
static constexpr unsigned int InputImageDimension
 
static constexpr unsigned int OutputImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< Image< TOutputPixelType, TInputImage::ImageDimension > >
static constexpr unsigned int OutputImageDimension
 
- Protected Types inherited from itk::ImageToImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >
using InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
 
using OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
 
- Protected Member Functions inherited from itk::SparseFieldLevelSetImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >
 SparseFieldLevelSetImageFilter ()
 
 ~SparseFieldLevelSetImageFilter () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual ValueType CalculateUpdateValue (const IndexType &, const TimeStepType &dt, const ValueType &value, const ValueType &change)
 
void PostProcessOutput () override
 
virtual void InitializeBackgroundPixels ()
 
void Initialize () override
 
void CopyInputToOutput () override
 
void AllocateUpdateBuffer () override
 
void ApplyUpdate (const TimeStepType &dt) override
 
TimeStepType CalculateChange () override
 
void ConstructLayer (StatusType from, StatusType to)
 
void ConstructActiveLayer ()
 
void InitializeActiveLayerValues ()
 
void PropagateLayerValues (StatusType from, StatusType to, StatusType promote, int InOrOut)
 
void PropagateAllLayerValues ()
 
void UpdateActiveLayerValues (TimeStepType dt, LayerType *StatusUpList, LayerType *StatusDownList)
 
void ProcessStatusList (LayerType *InputList, LayerType *OutputList, StatusType ChangeToStatus, StatusType SearchForStatus)
 
void ProcessOutsideList (LayerType *OutsideList, StatusType ChangeToStatus)
 
virtual ValueType GetValueZero () const
 
virtual ValueType GetValueOne () const
 
- Protected Member Functions inherited from itk::FiniteDifferenceImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >
 FiniteDifferenceImageFilter ()
 
 ~FiniteDifferenceImageFilter () override=default
 
void GenerateData () override
 
void GenerateInputRequestedRegion () override
 
virtual bool Halt ()
 
virtual bool ThreadedHalt (void *)
 
virtual TimeStepType ResolveTimeStep (const std::vector< TimeStepType > &timeStepList, const std::vector< bool > &valid) const
 
virtual void SetElapsedIterations (IdentifierType _arg)
 
- Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >
 InPlaceImageFilter ()=default
 
 ~InPlaceImageFilter () override=default
 
void AllocateOutputs () override
 
void ReleaseInputs () override
 
virtual bool GetRunningInPlace () const
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
 ImageToImageFilter ()
 
 ~ImageToImageFilter () override=default
 
void VerifyInputInformation () ITKv5_CONST override
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
- Protected Member Functions inherited from itk::ImageSource< Image< TOutputPixelType, TInputImage::ImageDimension > >
 ImageSource ()
 
 ~ImageSource () override=default
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual void BeforeThreadedGenerateData ()
 
virtual void AfterThreadedGenerateData ()
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
virtual void DynamicMultiThreadingOff ()
 
- Protected Member Functions inherited from itk::ProcessObject
 ProcessObject ()
 
 ~ProcessObject () override
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void AddInput (DataObject *input)
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *input)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
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
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
virtual void VerifyPreconditions () ITKv5_CONST
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual void GenerateOutputInformation ()
 
virtual void PropagateResetPipeline ()
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void ThreaderUpdateProgressOff ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 ()
 
- Static Protected Member Functions inherited from itk::ImageSource< Image< TOutputPixelType, TInputImage::ImageDimension > >
static const ImageRegionSplitterBaseGetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::SparseFieldLevelSetImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >
SparseFieldCityBlockNeighborList< NeighborhoodIterator< OutputImageType > > m_NeighborList
 
double m_ConstantGradientValue
 
OutputImageType::Pointer m_ShiftedImage
 
LayerListType m_Layers
 
unsigned int m_NumberOfLayers
 
StatusImageType::Pointer m_StatusImage
 
LayerNodeStorageType::Pointer m_LayerNodeStore
 
ValueType m_IsoSurfaceValue
 
UpdateBufferType m_UpdateBuffer
 
bool m_InterpolateSurfaceLocation
 
const InputImageTypem_InputImage
 
OutputImageTypem_OutputImage
 
- Protected Attributes inherited from itk::FiniteDifferenceImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >
bool m_IsInitialized
 
IdentifierType m_NumberOfIterations
 
IdentifierType m_ElapsedIterations
 
bool m_ManualReinitialization
 
double m_RMSChange
 
double m_MaximumRMSError
 
- Protected Attributes inherited from itk::ImageSource< Image< TOutputPixelType, TInputImage::ImageDimension > >
bool m_DynamicMultiThreading
 
- Protected Attributes inherited from itk::ProcessObject
bool m_Updating
 
TimeStamp m_OutputInformationMTime
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 
- Static Protected Attributes inherited from itk::SparseFieldLevelSetImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >
static ValueType m_ValueOne
 
static ValueType m_ValueZero
 
static StatusType m_StatusChanging
 
static StatusType m_StatusActiveChangingUp
 
static StatusType m_StatusActiveChangingDown
 
static StatusType m_StatusBoundaryPixel
 
static StatusType m_StatusNull
 

Detailed Description

template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>
class itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >

A base class which defines the API for implementing a special class of image segmentation filters using level set methods.

OVERVIEW
This object defines the framework for a class of segmentation filters which use level set methods. These filters work by constructing a "feature image" onto which the evolving level set locks as it moves. In the feature image, values that are close to zero are associated with object boundaries. An original (or preprocessed) image is given to the filter as the feature image and a seed for the level set is given as the input of the filter. The seed is converted into a level set embedding which propagates according to the features calculated from the original image.
TEMPLATE PARAMETERS
There are two required and one optional template parameter for these filters.

TInputImage is the image type of the initial model you will input to the filter using SetInput() or SetInitialImage().

TFeatureImage is the image type of the image from which the filter will calculate the speed term for segmentation (see INPUTS).

TOutputPixelType is the data type used for the output image phi, the implicit level set image. This should really only ever be set as float (default) or double.

INPUTS
The input to any subclass of this filter is the seed image for the initial level set embedding. As with other subclasses of the SparseLevelSetImageFilter, the type of the input image is is not important. The (RequestedRegion) size of the seed image must, however, match the (RequestedRegion) size of the feature image.

You must identify the initial front (surface) in the input image. You do this by specifying its isovalue through the method SetIsoSurfaceValue(float f). The algorithm will then initialize its solution using the front represented by value f. Note that the front is always represented by isosurface zero in the output and not the isosurface you specified for the input. This is because, for simplicity, the filter will shift your input image so that the active front has zero values.

Depending on the particular application and filter that you are using, the feature image should be preprocessed with some type of noise reduction filtering. The feature image input can be of any type, but it will be cast to floating point before calculations are done.
OUTPUTS
The output of any subclass of this filter is a level set embedding as described in SparseFieldLevelSetImageFilter. The zero crossings of the output image give the pixels closest to the level set boundary. By ITK convention, NEGATIVE values are pixels INSIDE the segmented region and POSITIVE values are pixels OUTSIDE the segmented region.
PARAMETERS
The MaximumRMSChange parameter is used to determine when the solution has converged. A lower value will result in a tighter-fitting solution, but will require more computations. Too low a value could put the solver into an infinite loop unless a reasonable NumberOfIterations parameter is set. Values should always be greater than 0.0 and less than 1.0.
The NumberOfIterations parameter can be used to halt the solution after a specified number of iterations, overriding the MaximumRMSChange halting criteria.
The standard convention for ITK level-set segmentation filters is that POSITIVE propagation (speed) and advection terms cause the surface to EXPAND while negative terms cause the surface to CONTRACT. When the ReverseExpansionDirection parameter is set to TRUE (on), it tells the function object to reverse the standard ITK convention so that NEGATIVE terms cause EXPANSION and positive terms cause CONTRACTION.

This parameter can be safely changed as appropriate for a particular application or data set to achieve the desired behavior.

The FeatureScaling parameter controls the magnitude of the features calculated for use in the level set propagation and advection speeds. This value simply sets both parameters to equal values at once. Some filters may only use on of these two terms and this method is a generic way to set either or both without having to know which is in use.
The CurvatureScaling parameter controls the magnitude of the curvature values which are calculated on the evolving isophote. This is important in controlling the relative effect of curvature in the calculation. Default value is 1.0. Higher values relative to the other level set equation terms (propagation and advection) will give a smoother result.
The PropagationScaling parameter controls the scaling of the scalar propagation (speed) term relative to other terms in the level set equation. Setting this value will override any value already set by FeatureScaling.
The AdvectionScaling parameter controls the scaling of the vector advection field term relative to other terms in the level set equation. Setting this value will override any value already set by FeatureScaling.
Warning
This is an abstract class. It is not intended to be instantiated by itself. Instead, you should use the derived classes. This is the reason why the New() operator (itkNewMacro) is missing from the class API.
See LevelSetFunction for more information.

Definition at line 144 of file itkSegmentationLevelSetImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
using itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::ConstPointer = SmartPointer<const Self>

Definition at line 161 of file itkSegmentationLevelSetImageFilter.h.

◆ FeatureImageType

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
using itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::FeatureImageType = TFeatureImage

Local image type alias

Definition at line 170 of file itkSegmentationLevelSetImageFilter.h.

◆ IndexType

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
using itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::IndexType = typename Superclass::IndexType

Definition at line 165 of file itkSegmentationLevelSetImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
using itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::InputImageType = typename Superclass::InputImageType

Definition at line 167 of file itkSegmentationLevelSetImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
using itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::OutputImageType = Image<TOutputPixelType, Self::InputImageDimension>

Output image type type alias

Definition at line 156 of file itkSegmentationLevelSetImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
using itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::Pointer = SmartPointer<Self>

Definition at line 160 of file itkSegmentationLevelSetImageFilter.h.

◆ SegmentationFunctionType

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
using itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SegmentationFunctionType = SegmentationLevelSetFunction<OutputImageType, FeatureImageType>

The generic level set function type

Definition at line 173 of file itkSegmentationLevelSetImageFilter.h.

◆ Self

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
using itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::Self = SegmentationLevelSetImageFilter

Inherited type alias from the superclass. Needs to be placed before the next macro.

Definition at line 151 of file itkSegmentationLevelSetImageFilter.h.

◆ SpeedImageType

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
using itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SpeedImageType = typename SegmentationFunctionType::ImageType

Definition at line 177 of file itkSegmentationLevelSetImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
using itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::Superclass = SparseFieldLevelSetImageFilter<TInputImage, OutputImageType>

Standard class type aliases

Definition at line 159 of file itkSegmentationLevelSetImageFilter.h.

◆ TimeStepType

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
using itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::TimeStepType = typename Superclass::TimeStepType

Definition at line 166 of file itkSegmentationLevelSetImageFilter.h.

◆ ValueType

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
using itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::ValueType = typename Superclass::ValueType

Inherited type alias from the superclass.

Definition at line 164 of file itkSegmentationLevelSetImageFilter.h.

◆ VectorImageType

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
using itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::VectorImageType = typename SegmentationFunctionType::VectorImageType

The type used for the advection field

Definition at line 176 of file itkSegmentationLevelSetImageFilter.h.

Constructor & Destructor Documentation

◆ ~SegmentationLevelSetImageFilter()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::~SegmentationLevelSetImageFilter ( )
overrideprotecteddefault

Flag which sets the inward/outward direction of propagation speed. See SetReverseExpansionDirection for more information.

◆ SegmentationLevelSetImageFilter()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SegmentationLevelSetImageFilter ( )
protected

Flag which sets the inward/outward direction of propagation speed. See SetReverseExpansionDirection for more information.

Member Function Documentation

◆ AutoGenerateSpeedAdvectionOff()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
virtual void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::AutoGenerateSpeedAdvectionOff ( )
virtual

Flag which sets the inward/outward direction of propagation speed. See SetReverseExpansionDirection for more information.

◆ AutoGenerateSpeedAdvectionOn()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
virtual void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::AutoGenerateSpeedAdvectionOn ( )
virtual

Flag which sets the inward/outward direction of propagation speed. See SetReverseExpansionDirection for more information.

◆ GenerateAdvectionImage()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GenerateAdvectionImage ( )

Allocate and calculate the advection term image in the SegmentationFunction object This method is called automatically on filter execution unless AutoGenerateSpeedAdvection is set to Off.

◆ GenerateData()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GenerateData ( )
overrideprotectedvirtual

Overridden from ProcessObject to set certain values before starting the finite difference solver and then create an appropriate output

Reimplemented from itk::ProcessObject.

Reimplemented in itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, and itk::ShapeDetectionLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >.

◆ GenerateSpeedImage()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GenerateSpeedImage ( )

Allocate and calculate the speed term image in the SegmentationFunction object. This method is called automatically on filter execution unless AutoGenerateSpeedAdvection is set to Off.

◆ GetAdvectionImage()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
virtual const VectorImageType* itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetAdvectionImage ( ) const
inlinevirtual

Return a pointer to the image sampled as the advection term of the segmentation algorithm.

Definition at line 257 of file itkSegmentationLevelSetImageFilter.h.

◆ GetAdvectionScaling()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
ValueType itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetAdvectionScaling ( ) const
inline

Flag which sets the inward/outward direction of propagation speed. See SetReverseExpansionDirection for more information.

Definition at line 388 of file itkSegmentationLevelSetImageFilter.h.

◆ GetAutoGenerateSpeedAdvection()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
virtual bool itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetAutoGenerateSpeedAdvection ( ) const
virtual

Flag which sets the inward/outward direction of propagation speed. See SetReverseExpansionDirection for more information.

◆ GetCurvatureScaling()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
ValueType itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetCurvatureScaling ( ) const
inline

Flag which sets the inward/outward direction of propagation speed. See SetReverseExpansionDirection for more information.

Definition at line 409 of file itkSegmentationLevelSetImageFilter.h.

◆ GetFeatureImage()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
virtual const FeatureImageType* itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetFeatureImage ( ) const
virtual

Flag which sets the inward/outward direction of propagation speed. See SetReverseExpansionDirection for more information.

◆ GetInitialImage()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
virtual const InputImageType* itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetInitialImage ( ) const
virtual

Flag which sets the inward/outward direction of propagation speed. See SetReverseExpansionDirection for more information.

◆ GetMaximumCurvatureTimeStep()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
double itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetMaximumCurvatureTimeStep ( ) const
inline

Flag which sets the inward/outward direction of propagation speed. See SetReverseExpansionDirection for more information.

Definition at line 484 of file itkSegmentationLevelSetImageFilter.h.

◆ GetMaximumIterations()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
unsigned int itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetMaximumIterations ( )
inline

Flag which sets the inward/outward direction of propagation speed. See SetReverseExpansionDirection for more information.

Definition at line 193 of file itkSegmentationLevelSetImageFilter.h.

◆ GetMaximumPropagationTimeStep()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
double itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetMaximumPropagationTimeStep ( ) const
inline

Flag which sets the inward/outward direction of propagation speed. See SetReverseExpansionDirection for more information.

Definition at line 505 of file itkSegmentationLevelSetImageFilter.h.

◆ GetNameOfClass()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
virtual const char* itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetNameOfClass ( ) const
virtual

◆ GetPropagationScaling()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
ValueType itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetPropagationScaling ( ) const
inline

Flag which sets the inward/outward direction of propagation speed. See SetReverseExpansionDirection for more information.

Definition at line 369 of file itkSegmentationLevelSetImageFilter.h.

◆ GetReverseExpansionDirection()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
virtual bool itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetReverseExpansionDirection ( ) const
virtual

Flag which sets the inward/outward direction of propagation speed. See SetReverseExpansionDirection for more information.

◆ GetSegmentationFunction()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
virtual SegmentationFunctionType* itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetSegmentationFunction ( )
inlinevirtual

Flag which sets the inward/outward direction of propagation speed. See SetReverseExpansionDirection for more information.

Definition at line 463 of file itkSegmentationLevelSetImageFilter.h.

◆ GetSpeedImage()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
virtual const SpeedImageType* itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetSpeedImage ( ) const
inlinevirtual

Return a pointer to the image sampled as the speed term of the segmentation algorithm.

Definition at line 249 of file itkSegmentationLevelSetImageFilter.h.

◆ GetUseMinimalCurvature()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
bool itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetUseMinimalCurvature ( ) const
inline

Flag which sets the inward/outward direction of propagation speed. See SetReverseExpansionDirection for more information.

Definition at line 427 of file itkSegmentationLevelSetImageFilter.h.

◆ GetUseNegativeFeatures()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
bool itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetUseNegativeFeatures ( ) const
inline

Flag which sets the inward/outward direction of propagation speed. See SetReverseExpansionDirection for more information.

Definition at line 300 of file itkSegmentationLevelSetImageFilter.h.

◆ InitializeIteration()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::InitializeIteration ( )
inlineoverrideprotectedvirtual

◆ PrintSelf()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

◆ ReverseExpansionDirectionOff()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
virtual void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::ReverseExpansionDirectionOff ( )
virtual

Flag which sets the inward/outward direction of propagation speed. See SetReverseExpansionDirection for more information.

◆ ReverseExpansionDirectionOn()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
virtual void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::ReverseExpansionDirectionOn ( )
virtual

Flag which sets the inward/outward direction of propagation speed. See SetReverseExpansionDirection for more information.

◆ SetAdvectionImage()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetAdvectionImage ( VectorImageType v)
inline

This function is for advanced applications. Set the image sampled as the advection term of this segmentation method. In general, the advection image is generated automatically by a subclass of this filter.

Definition at line 241 of file itkSegmentationLevelSetImageFilter.h.

◆ SetAdvectionScaling()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetAdvectionScaling ( ValueType  v)
inline

Set/Get the scaling of the advection field. Setting the FeatureScaling parameter will override any existing value for AdvectionScaling.

Definition at line 377 of file itkSegmentationLevelSetImageFilter.h.

References itk::Math::NotExactlyEquals().

◆ SetAutoGenerateSpeedAdvection()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
virtual void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetAutoGenerateSpeedAdvection ( bool  _arg)
virtual

Turn On/Off automatic generation of Speed and Advection terms when Update is called. If set to Off, the Speed and Advection images must be set explicitly using SetSpeedImage, SetAdvectionImage OR the methods GenerateSpeedImage() and GenerateAdvectionImage() should be called prior to updating the filter.

◆ SetCurvatureScaling()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetCurvatureScaling ( ValueType  v)
inline

Set/Get the scaling of the curvature. Use this parameter to increase the influence of curvature on the movement of the surface. Higher values relative to Advection and Propagation values will give smoother surfaces.

Definition at line 398 of file itkSegmentationLevelSetImageFilter.h.

References itk::Math::NotExactlyEquals().

◆ SetFeatureImage()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
virtual void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetFeatureImage ( const FeatureImageType f)
inlinevirtual

Set/Get the feature image to be used for speed function of the level set equation. Equivalent to calling Set/GetInput(1, ..)

Definition at line 202 of file itkSegmentationLevelSetImageFilter.h.

References itk::ProcessObject::GetInput(), and itk::ProcessObject::SetInput().

◆ SetFeatureScaling()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetFeatureScaling ( ValueType  v)
inline

Combined scaling of the propagation and advection speed terms. You should use either this -or- Get/SetPropagationScaling and Get/SetAdvectionScaling (if appropriate). See subclasses for details on when and whether to set these parameters.

Definition at line 342 of file itkSegmentationLevelSetImageFilter.h.

References itk::Math::NotExactlyEquals().

◆ SetInitialImage()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
virtual void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetInitialImage ( const InputImageType input)
virtual

Set/Get the initial level set model. Equivalent to calling SetInput(..)

◆ SetInput2()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetInput2 ( const FeatureImageType input)
inline

Set the feature image

Definition at line 223 of file itkSegmentationLevelSetImageFilter.h.

◆ SetMaximumCurvatureTimeStep()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetMaximumCurvatureTimeStep ( double  n)
inline

Set/Get the maximum constraint for the curvature term factor in the time step calculation. Changing this value from the default is not recommended or necessary but could be used to speed up the surface evolution at the risk of creating an unstable solution.

Definition at line 473 of file itkSegmentationLevelSetImageFilter.h.

◆ SetMaximumIterations()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetMaximumIterations ( unsigned int  i)
inline

Set/Get the maximum number of iterations allowed for the solver. This prevents infinite loops if a solution "bounces".

Definition at line 185 of file itkSegmentationLevelSetImageFilter.h.

◆ SetMaximumPropagationTimeStep()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetMaximumPropagationTimeStep ( double  n)
inline

Set/Get the maximum constraint for the scalar/vector term factor of the time step calculation. Changing this value from the default is not recommended or necessary but could be used to speed up the surface evolution at the risk of creating an unstable solution.

Definition at line 494 of file itkSegmentationLevelSetImageFilter.h.

◆ SetPropagationScaling()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetPropagationScaling ( ValueType  v)
inline

Set/Get the scaling of the propagation speed. Setting the FeatureScaling parameter overrides any previous values set for PropagationScaling.

Definition at line 358 of file itkSegmentationLevelSetImageFilter.h.

References itk::Math::NotExactlyEquals().

◆ SetReverseExpansionDirection()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
virtual void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetReverseExpansionDirection ( bool  _arg)
virtual

Turn On/Off the flag which determines whether Positive or Negative speed terms will cause surface expansion. If set to TRUE then negative speed terms will cause the surface to expand and positive speed terms will cause the surface to contract. If set to FALSE (default) then positive speed terms will cause the surface to expand and negative speed terms will cause the surface to contract. This method can be safely used to reverse the expansion/contraction as appropriate to a particular application or data set.

◆ SetSegmentationFunction()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
virtual void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetSegmentationFunction ( SegmentationFunctionType s)
inlinevirtual

Set the segmentation function. In general, this should only be called by a subclass of this object. It is made public to allow itk::Command objects access. The method is inline to avoid a problem with the gcc 2.95 compiler matching the declaration with the definition.

Definition at line 450 of file itkSegmentationLevelSetImageFilter.h.

References itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::Initialize().

◆ SetSpeedImage()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetSpeedImage ( SpeedImageType s)
inline

This function is for advanced applications. Set the image sampled as the speed term of this segmentation method. In general, the speed image is generated automatically by a subclass of this filter.

Definition at line 232 of file itkSegmentationLevelSetImageFilter.h.

◆ SetUseMinimalCurvature()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetUseMinimalCurvature ( bool  b)
inline

Flag which sets the inward/outward direction of propagation speed. See SetReverseExpansionDirection for more information.

Definition at line 416 of file itkSegmentationLevelSetImageFilter.h.

◆ SetUseNegativeFeatures()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetUseNegativeFeatures ( bool  u)
inline

THIS METHOD IS DEPRECATED AND SHOULD NOT BE USED. Set/Get the value of the UseNegativeFeatures flag. This method is deprecated. Use Set/Get ReverseExpansionDirection instead.

Definition at line 285 of file itkSegmentationLevelSetImageFilter.h.

◆ SetUseNegativeFeaturesOff()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetUseNegativeFeaturesOff ( )
inline

Flag which sets the inward/outward direction of propagation speed. See SetReverseExpansionDirection for more information.

Definition at line 275 of file itkSegmentationLevelSetImageFilter.h.

◆ SetUseNegativeFeaturesOn()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetUseNegativeFeaturesOn ( )
inline

THIS METHOD IS DEPRECATED AND SHOULD NOT BE USED. This method reverses the speed function direction, effectively changing inside feature values to outside feature values and vice versa.

Definition at line 266 of file itkSegmentationLevelSetImageFilter.h.

◆ UseMinimalCurvatureOff()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::UseMinimalCurvatureOff ( )
inline

Flag which sets the inward/outward direction of propagation speed. See SetReverseExpansionDirection for more information.

Definition at line 439 of file itkSegmentationLevelSetImageFilter.h.

◆ UseMinimalCurvatureOn()

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::UseMinimalCurvatureOn ( )
inline

Flag which sets the inward/outward direction of propagation speed. See SetReverseExpansionDirection for more information.

Definition at line 433 of file itkSegmentationLevelSetImageFilter.h.

Member Data Documentation

◆ m_AutoGenerateSpeedAdvection

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
bool itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::m_AutoGenerateSpeedAdvection
protected

Flag to indicate whether Speed and Advection images are automatically generated when running the filter. Otherwise, a pointer to images must be explicitly set or GenerateSpeedImage() and/or GenerateAdvectionImage() called directly before updating the filter

Definition at line 558 of file itkSegmentationLevelSetImageFilter.h.

◆ m_ReverseExpansionDirection

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
bool itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::m_ReverseExpansionDirection
protected

Flag which sets the inward/outward direction of propagation speed. See SetReverseExpansionDirection for more information.

Definition at line 552 of file itkSegmentationLevelSetImageFilter.h.

◆ m_SegmentationFunction

template<typename TInputImage , typename TFeatureImage , typename TOutputPixelType = float>
SegmentationFunctionType* itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::m_SegmentationFunction
private

Flag which sets the inward/outward direction of propagation speed. See SetReverseExpansionDirection for more information.

Definition at line 561 of file itkSegmentationLevelSetImageFilter.h.


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