#include <itkSegmentationLevelSetImageFilter.h>

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.

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

using	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	ValueType

using	VectorImageType = typename SegmentationFunctionType::VectorImageType

Public Types inherited from itk::SparseFieldLevelSetImageFilter< TInputImage, Image< float, TInputImage::ImageDimension > >
using	ConstPointer

using	IndexType

using	InputImageType

using	LayerListType

using	LayerNodeStorageType

using	LayerNodeType

using	LayerPointerType

using	LayerType

typedef typename FiniteDifferenceFunctionType::NeighborhoodScalesType	NeighborhoodScalesType

using	NeighborhoodScalesType

using	OutputImageType

using	Pointer

typedef typename FiniteDifferenceFunctionType::RadiusType	RadiusType

using	RadiusType

using	Self

using	StatusImageType

using	StatusType

using	Superclass

typedef typename FiniteDifferenceFunctionType::TimeStepType	TimeStepType

using	TimeStepType

using	UpdateBufferType

using	ValueType

Public Types inherited from itk::FiniteDifferenceImageFilter< TInputImage, Image< float, TInputImage::ImageDimension > >
using	ConstPointer

using	FiniteDifferenceFunctionType

using	InputImageType

using	InputPixelType

using	InputPixelValueType

using	NeighborhoodScalesType

using	OutputImageType

using	OutputPixelType

using	OutputPixelValueType

using	PixelType

using	Pointer

using	RadiusType

using	Self

using	Superclass

using	TimeStepType

Public Types inherited from itk::InPlaceImageFilter< TInputImage, Image< float, TInputImage::ImageDimension > >
using	ConstPointer

using	InputImageConstPointer

using	InputImagePixelType

using	InputImagePointer

using	InputImageRegionType

using	InputImageType

typedef typename OutputImageType::PixelType	OutputImagePixelType

using	OutputImagePixelType

typedef typename OutputImageType::RegionType	OutputImageRegionType

using	OutputImageRegionType

using	Pointer

using	Self

using	Superclass

Public Types inherited from itk::ImageToImageFilter< TInputImage, Image< float, TInputImage::ImageDimension > >
using	ConstPointer

using	InputImageConstPointer

using	InputImagePixelType

using	InputImagePointer

using	InputImageRegionType

using	InputImageType

typedef typename OutputImageType::PixelType	OutputImagePixelType

using	OutputImagePixelType

typedef typename OutputImageType::RegionType	OutputImageRegionType

using	OutputImageRegionType

using	Pointer

using	Self

using	Superclass

Public Types inherited from itk::ImageSource< Image< float, TInputImage::ImageDimension > >
using	ConstPointer

using	DataObjectIdentifierType

using	DataObjectPointer

using	DataObjectPointerArraySizeType

using	OutputImagePixelType

using	OutputImagePointer

using	OutputImageRegionType

using	OutputImageType

using	Pointer

using	Self

using	Superclass

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
void	GenerateAdvectionImage ()

void	GenerateSpeedImage ()

virtual const VectorImageType *	GetAdvectionImage () const

const char *	GetNameOfClass () const override

virtual SegmentationFunctionType *	GetSegmentationFunction ()

virtual const SpeedImageType *	GetSpeedImage () const

void	SetAdvectionImage (VectorImageType *v)

void	SetFeatureScaling (ValueType v)

void	SetInput2 (const FeatureImageType *input)

virtual void	SetSegmentationFunction (SegmentationFunctionType *s)

void	SetSpeedImage (SpeedImageType *s)

void	UseMinimalCurvatureOff ()

void	UseMinimalCurvatureOn ()


void	SetMaximumIterations (unsigned int i)

unsigned int	GetMaximumIterations ()


virtual void	SetFeatureImage (const FeatureImageType *f)

	itkGetInputMacro (FeatureImage, FeatureImageType)


	itkSetInputMacro (InitialImage, InputImageType)

	itkGetInputMacro (InitialImage, InputImageType)


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	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	SetMaximumCurvatureTimeStep (double n)

double	GetMaximumCurvatureTimeStep () const


void	SetMaximumPropagationTimeStep (double n)

double	GetMaximumPropagationTimeStep () const

Public Member Functions inherited from itk::SparseFieldLevelSetImageFilter< TInputImage, Image< float, TInputImage::ImageDimension > >
virtual::itk::LightObject::Pointer	CreateAnother () const

const char *	GetNameOfClass () const override

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< float, TInputImage::ImageDimension > >
virtual const FiniteDifferenceFunctionType::Pointer &	GetDifferenceFunction () const

virtual const IdentifierType &	GetElapsedIterations () const

virtual bool	GetIsInitialized ()

virtual void	SetDifferenceFunction (FiniteDifferenceFunctionType *_arg)

virtual void	SetIsInitialized (bool _arg)

void	SetStateToInitialized ()

void	SetStateToUninitialized ()

virtual void	SetNumberOfIterations (IdentifierType _arg)

virtual const IdentifierType &	GetNumberOfIterations () 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 ()

Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, Image< float, TInputImage::ImageDimension > >
virtual bool	CanRunInPlace () const

virtual void	SetInPlace (bool _arg)

virtual bool	GetInPlace () const

virtual void	InPlaceOn ()

virtual void	InPlaceOff ()

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, Image< float, TInputImage::ImageDimension > >
const InputImageType *	GetInput () const

const InputImageType *	GetInput (unsigned int idx) const

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	SetInput (const InputImageType *input)

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< float, TInputImage::ImageDimension > >
OutputImageType *	GetOutput (unsigned int idx)

virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)

virtual void	GraftOutput (DataObject *graft)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

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 *output)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

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	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 val)

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 ThreadIdType &	GetNumberOfWorkUnits () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () 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) const

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
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

Protected Member Functions
void	GenerateData () override

void	InitializeIteration () override

void	PrintSelf (std::ostream &os, Indent indent) const override

	SegmentationLevelSetImageFilter ()

	~SegmentationLevelSetImageFilter () override=default

Protected Member Functions inherited from itk::SparseFieldLevelSetImageFilter< TInputImage, Image< float, TInputImage::ImageDimension > >
void	AllocateUpdateBuffer () override

void	ApplyUpdate (const TimeStepType &dt) override

TimeStepType	CalculateChange () override

virtual ValueType	CalculateUpdateValue (const IndexType &idx, const TimeStepType &dt, const ValueType &value, const ValueType &change)

void	ConstructActiveLayer ()

void	ConstructLayer (StatusType from, StatusType to)

void	CopyInputToOutput () override

virtual ValueType	GetValueOne () const

virtual ValueType	GetValueZero () const

void	Initialize () override

void	InitializeActiveLayerValues ()

virtual void	InitializeBackgroundPixels ()

void	PostProcessOutput () override

void	PrintSelf (std::ostream &os, Indent indent) const override

void	ProcessOutsideList (LayerType *OutsideList, StatusType ChangeToStatus)

void	ProcessStatusList (LayerType InputList, LayerType OutputList, StatusType ChangeToStatus, StatusType SearchForStatus)

void	PropagateAllLayerValues ()

void	PropagateLayerValues (StatusType from, StatusType to, StatusType promote, int InOrOut)

	SparseFieldLevelSetImageFilter ()

void	UpdateActiveLayerValues (TimeStepType dt, LayerType UpList, LayerType DownList)

	~SparseFieldLevelSetImageFilter () override=default

Protected Member Functions inherited from itk::FiniteDifferenceImageFilter< TInputImage, Image< float, TInputImage::ImageDimension > >
virtual void	ApplyUpdate (const TimeStepType &dt)=0

	FiniteDifferenceImageFilter ()

void	GenerateInputRequestedRegion () override

virtual bool	Halt ()

virtual TimeStepType	ResolveTimeStep (const std::vector< TimeStepType > &timeStepList, const BooleanStdVectorType &valid) const

virtual void	SetElapsedIterations (IdentifierType _arg)

virtual bool	ThreadedHalt (void *threadInfo)

	~FiniteDifferenceImageFilter () override=default

Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage, Image< float, TInputImage::ImageDimension > >
void	AllocateOutputs () override

virtual bool	GetRunningInPlace () const

	InPlaceImageFilter ()=default

void	ReleaseInputs () override

	~InPlaceImageFilter () override=default

Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, Image< float, TInputImage::ImageDimension > >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

void	GenerateInputRequestedRegion () override

	ImageToImageFilter ()

void	VerifyInputInformation () const override

	~ImageToImageFilter () override=default

Protected Member Functions inherited from itk::ImageSource< Image< float, TInputImage::ImageDimension > >
virtual void	AfterThreadedGenerateData ()

virtual void	BeforeThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

	~ImageSource () override=default

virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)

virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

virtual void	DynamicMultiThreadingOff ()

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	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (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

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

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 idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyPreconditions () const

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	ThreaderUpdateProgressOff ()

virtual void	SetThreaderUpdateProgress (bool arg)

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~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 ()

Protected Attributes
bool	m_AutoGenerateSpeedAdvection {}

bool	m_ReverseExpansionDirection {}

Protected Attributes inherited from itk::SparseFieldLevelSetImageFilter< TInputImage, Image< float, TInputImage::ImageDimension > >
double	m_ConstantGradientValue

const InputImageType *	m_InputImage

bool	m_InterpolateSurfaceLocation

ValueType	m_IsoSurfaceValue

LayerNodeStorageType::Pointer	m_LayerNodeStore

LayerListType	m_Layers

SparseFieldCityBlockNeighborList< NeighborhoodIterator< OutputImageType > >	m_NeighborList

unsigned int	m_NumberOfLayers

OutputImageType *	m_OutputImage

OutputImageType::Pointer	m_ShiftedImage

StatusImageType::Pointer	m_StatusImage

UpdateBufferType	m_UpdateBuffer

Protected Attributes inherited from itk::FiniteDifferenceImageFilter< TInputImage, Image< float, TInputImage::ImageDimension > >
IdentifierType	m_ElapsedIterations

bool	m_IsInitialized

bool	m_ManualReinitialization

double	m_MaximumRMSError

IdentifierType	m_NumberOfIterations

double	m_RMSChange

Protected Attributes inherited from itk::ImageSource< Image< float, TInputImage::ImageDimension > >
bool	m_DynamicMultiThreading

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Private Attributes
SegmentationFunctionType *	m_SegmentationFunction {}

Additional Inherited Members
Static Public Member Functions inherited from itk::SparseFieldLevelSetImageFilter< TInputImage, Image< float, TInputImage::ImageDimension > >
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, Image< float, TInputImage::ImageDimension > >
static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes inherited from itk::SparseFieldLevelSetImageFilter< TInputImage, Image< float, TInputImage::ImageDimension > >
static constexpr unsigned int	ImageDimension

Static Public Attributes inherited from itk::FiniteDifferenceImageFilter< TInputImage, Image< float, TInputImage::ImageDimension > >
static constexpr unsigned int	ImageDimension

Static Public Attributes inherited from itk::InPlaceImageFilter< TInputImage, Image< float, TInputImage::ImageDimension > >
static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, Image< float, TInputImage::ImageDimension > >
static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageSource< Image< float, TInputImage::ImageDimension > >
static constexpr unsigned int	OutputImageDimension

Protected Types inherited from itk::ImageToImageFilter< TInputImage, Image< float, TInputImage::ImageDimension > >
using	InputToOutputRegionCopierType

using	OutputToInputRegionCopierType

Static Protected Member Functions inherited from itk::ImageSource< Image< float, TInputImage::ImageDimension > >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject>
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Static Protected Attributes inherited from itk::SparseFieldLevelSetImageFilter< TInputImage, Image< float, TInputImage::ImageDimension > >
static StatusType	m_StatusActiveChangingDown

static StatusType	m_StatusActiveChangingUp

static StatusType	m_StatusBoundaryPixel

static StatusType	m_StatusChanging

static StatusType	m_StatusNull

static ValueType	m_ValueOne

static ValueType	m_ValueZero

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::SparseFieldLevelSetImageFilter< TInputImage, OutputImageType >::IndexType

Definition at line 264 of file itkSparseFieldLevelSetImageFilter.h.

◆ InputImageType

template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>

using itk::SparseFieldLevelSetImageFilter< TInputImage, OutputImageType >::InputImageType

Information derived from the image types.

Definition at line 262 of file itkSparseFieldLevelSetImageFilter.h.

◆ OutputImageType

template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>

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

Output image 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.

◆ ValueType

template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>

using itk::SparseFieldLevelSetImageFilter< TInputImage, OutputImageType >::ValueType

The data type used in numerical computations. Derived from the output image type.

Definition at line 269 of file itkSparseFieldLevelSetImageFilter.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

◆ SegmentationLevelSetImageFilter()

template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>

itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SegmentationLevelSetImageFilter ( )

protected

Member Function Documentation

◆ AutoGenerateSpeedAdvectionOff()

template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>

virtual void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::AutoGenerateSpeedAdvectionOff ( )

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.

◆ AutoGenerateSpeedAdvectionOn()

template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>

virtual void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::AutoGenerateSpeedAdvectionOn ( )

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.

◆ 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::FiniteDifferenceImageFilter< TInputImage, Image< float, TInputImage::ImageDimension > >.

Reimplemented in itk::ShapeDetectionLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, float >, itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, and itk::ShapePriorSegmentationLevelSetImageFilter< 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 260 of file itkSegmentationLevelSetImageFilter.h.

◆ GetAdvectionScaling()

template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>

ValueType itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetAdvectionScaling ( ) const

inline

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

Definition at line 393 of file itkSegmentationLevelSetImageFilter.h.

◆ GetAutoGenerateSpeedAdvection()

template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>

virtual bool itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetAutoGenerateSpeedAdvection ( ) const

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.

◆ GetCurvatureScaling()

template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>

ValueType itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetCurvatureScaling ( ) const

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 415 of file itkSegmentationLevelSetImageFilter.h.

◆ GetMaximumCurvatureTimeStep()

template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>

double itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetMaximumCurvatureTimeStep ( ) const

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 491 of file itkSegmentationLevelSetImageFilter.h.

◆ GetMaximumIterations()

template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>

unsigned int itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetMaximumIterations ( )

inline

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

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

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 513 of file itkSegmentationLevelSetImageFilter.h.

◆ GetNameOfClass()

template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>

const char * itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::FiniteDifferenceImageFilter< TInputImage, Image< float, TInputImage::ImageDimension > >.

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

◆ GetPropagationScaling()

template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>

ValueType itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetPropagationScaling ( ) const

inline

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

Definition at line 373 of file itkSegmentationLevelSetImageFilter.h.

◆ GetReverseExpansionDirection()

template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>

virtual bool itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetReverseExpansionDirection ( ) const

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.

◆ GetSegmentationFunction()

template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>

virtual SegmentationFunctionType * itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetSegmentationFunction ( )

inlinevirtual

Definition at line 470 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 252 of file itkSegmentationLevelSetImageFilter.h.

◆ GetUseMinimalCurvature()

template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>

bool itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetUseMinimalCurvature ( ) const

inline

Definition at line 434 of file itkSegmentationLevelSetImageFilter.h.

◆ GetUseNegativeFeatures()

template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>

bool itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetUseNegativeFeatures ( ) const

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 304 of file itkSegmentationLevelSetImageFilter.h.

◆ InitializeIteration()

template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>

void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::InitializeIteration ( )

inlineoverrideprotectedvirtual

Overrides parent implementation

Reimplemented from itk::FiniteDifferenceImageFilter< TInputImage, Image< float, TInputImage::ImageDimension > >.

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

Definition at line 542 of file itkSegmentationLevelSetImageFilter.h.

◆ itkGetInputMacro() [1/2]

template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>

itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::itkGetInputMacro	(	FeatureImage	,
		FeatureImageType	)

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

◆ itkGetInputMacro() [2/2]

template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>

itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::itkGetInputMacro	(	InitialImage	,
		InputImageType	)

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

◆ itkSetInputMacro()

template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>

itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::itkSetInputMacro	(	InitialImage	,
		InputImageType	)

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

◆ PrintSelf()

template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>

void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::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::FiniteDifferenceImageFilter< TInputImage, Image< float, TInputImage::ImageDimension > >.

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

◆ ReverseExpansionDirectionOff()

template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>

virtual void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::ReverseExpansionDirectionOff ( )

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.

◆ ReverseExpansionDirectionOn()

template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>

virtual void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::ReverseExpansionDirectionOn ( )

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.

◆ 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 244 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 383 of file itkSegmentationLevelSetImageFilter.h.

◆ 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 405 of file itkSegmentationLevelSetImageFilter.h.

◆ 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 204 of file itkSegmentationLevelSetImageFilter.h.

◆ 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 347 of file itkSegmentationLevelSetImageFilter.h.

◆ 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 226 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 481 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 186 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 503 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 363 of file itkSegmentationLevelSetImageFilter.h.

◆ 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 458 of file itkSegmentationLevelSetImageFilter.h.

◆ 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 235 of file itkSegmentationLevelSetImageFilter.h.

◆ SetUseMinimalCurvature()

template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>

void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetUseMinimalCurvature ( bool b )

inline

Definition at line 424 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 290 of file itkSegmentationLevelSetImageFilter.h.

◆ SetUseNegativeFeaturesOff()

template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>

void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetUseNegativeFeaturesOff ( )

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 278 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 270 of file itkSegmentationLevelSetImageFilter.h.

◆ UseMinimalCurvatureOff()

template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>

void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::UseMinimalCurvatureOff ( )

inline

Definition at line 447 of file itkSegmentationLevelSetImageFilter.h.

◆ UseMinimalCurvatureOn()

template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>

void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::UseMinimalCurvatureOn ( )

inline

Definition at line 441 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 563 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 557 of file itkSegmentationLevelSetImageFilter.h.

◆ m_SegmentationFunction

template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>

SegmentationFunctionType* itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::m_SegmentationFunction {}

private

Definition at line 566 of file itkSegmentationLevelSetImageFilter.h.

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

itkSegmentationLevelSetImageFilter.h

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ FeatureImageType

◆ IndexType

◆ InputImageType

◆ OutputImageType

◆ Pointer

◆ SegmentationFunctionType

◆ Self

◆ SpeedImageType

◆ Superclass

◆ ValueType

◆ VectorImageType

Constructor & Destructor Documentation

◆ ~SegmentationLevelSetImageFilter()

◆ SegmentationLevelSetImageFilter()

Member Function Documentation

◆ AutoGenerateSpeedAdvectionOff()

◆ AutoGenerateSpeedAdvectionOn()

◆ GenerateAdvectionImage()

◆ GenerateData()

◆ GenerateSpeedImage()

◆ GetAdvectionImage()

◆ GetAdvectionScaling()

◆ GetAutoGenerateSpeedAdvection()

◆ GetCurvatureScaling()

◆ GetMaximumCurvatureTimeStep()

◆ GetMaximumIterations()

◆ GetMaximumPropagationTimeStep()

◆ GetNameOfClass()

◆ GetPropagationScaling()

◆ GetReverseExpansionDirection()

◆ GetSegmentationFunction()

◆ GetSpeedImage()

◆ GetUseMinimalCurvature()

◆ GetUseNegativeFeatures()

◆ InitializeIteration()

◆ itkGetInputMacro() [1/2]

◆ itkGetInputMacro() [2/2]

◆ itkSetInputMacro()

◆ PrintSelf()

◆ ReverseExpansionDirectionOff()

◆ ReverseExpansionDirectionOn()

◆ SetAdvectionImage()

◆ SetAdvectionScaling()

◆ SetAutoGenerateSpeedAdvection()

◆ SetCurvatureScaling()

◆ SetFeatureImage()

◆ SetFeatureScaling()

◆ SetInput2()

◆ SetMaximumCurvatureTimeStep()

◆ SetMaximumIterations()

◆ SetMaximumPropagationTimeStep()

◆ SetPropagationScaling()

◆ SetReverseExpansionDirection()

◆ SetSegmentationFunction()

◆ SetSpeedImage()

◆ SetUseMinimalCurvature()

◆ SetUseNegativeFeatures()

◆ SetUseNegativeFeaturesOff()

◆ SetUseNegativeFeaturesOn()

◆ UseMinimalCurvatureOff()

◆ UseMinimalCurvatureOn()

Member Data Documentation

◆ m_AutoGenerateSpeedAdvection

◆ m_ReverseExpansionDirection

◆ m_SegmentationFunction