#include <itkCannySegmentationLevelSetImageFilter.h>

Detailed Description

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

Segments structures in images based on image features derived from pseudo-canny-edges.

IMPORTANT: The SegmentationLevelSetImageFilter class and the CannySegmentationLevelSetFunction class contain additional information necessary to the full understanding of how to use this filter.

OVERVIEW: This class is a level set method segmentation filter. It constructs a speed function which is designed to lock onto edges as detected by a Canny filter.

: The CannySegmentationLevelSetImageFilter can be a tool for refining an existing segmentation, or it can be used to try to segment a region by itself. Like all other level-set based segmentation filters (see SegmentationLevelSetImageFilter), it works by first constructing a scalar speed term and a vector advection field based on edge features in the image. The level set front is then moved according to these two terms with the addition of a third curvature term to control the smoothness of the solution.

: The speed term is constructed as the Danielsson distance transform of the Canny edge image, as calculated by the CannyEdgeDetectionImageFilter. This scalar speed can be tuned in and out of the final evolution equation by setting the PropagationScaling parameter (a value of 0 removes the speed term).

: The advection field term is constructed by minimizing Danielsson distance squared. i.e. \( \mbox{min} \int D^2 \Rightarrow D \nabla D \). This term moves the level set down the gradient of the distance transform.

: In practice, you may set the speed (propagation) term to zero if your initialization is already close to the edge you are interested in. If you are trying to segment a region by seeding with a small surface (blob, sphere) then you will likely want to add speed (propagation) to the equation so that the levelsets can expand along zero gradients. The relative influence of these two terms are controlled by the SetPropagationScaling and SetAdvectionScaling parameters.

INPUTS: This filter requires two inputs. The first input is a seed image. This seed image must contain an isosurface that you want to use as the seed for your segmentation. It can be a binary, graylevel, or floating point image. The only requirement is that it contain a closed isosurface that you will identify as the seed by setting the IsosurfaceValue parameter of the filter. For a binary image you will want to set your isosurface value halfway between your on and off values (i.e. for 0's and 1's, use an isosurface value of 0.5).

: The second input is the feature image. This is the image from which the speed function will be calculated. For most applications, this is the image that you want to segment. The desired isosurface in your seed image should lie within the region of your feature image that you are trying to segment.

: See SegmentationLevelSetImageFilter for more information on Inputs.

OUTPUTS: The filter outputs a single, scalar, real-valued image. Positive *values in the output image are inside the segmented region and negative *values in the image are outside of the inside region. The zero crossings of *the image correspond to the position of the level set front.

: See SparseFieldLevelSetImageFilter and SegmentationLevelSetImageFilter for more information.

PARAMETERS: There are five parameters important for controlling the behavior of this filter.

: (1) Threshold. Sets the thresholding value of the Canny edge detection. See CannyEdgeDetectionImageFilter for more information.

: (2) Variance. Controls the smoothing parameter of the gaussian filtering done during Canny edge detection.

: (3) CurvatureScaling. Controls the degree to which curvature influences the evolution of the level set. Higher values relative to Propagation and Advection scalings will yield a smoother surface.

: (4) PropagationScaling. Scales the propagation (speed) term of the level set equation. Set this term to zero to allow the level set to flow only down the gradient of the distance transform.

: (5) AdvectionScaling. Scales influence of the advection field relative to curvature and propagation terms.

See also: SegmentationLevelSetImageFilter; CannySegmentationLevelSetFunction,; SparseFieldLevelSetImageFilter

Definition at line 130 of file itkCannySegmentationLevelSetImageFilter.h.

Inheritance diagram for itk::CannySegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >:

Collaboration diagram for itk::CannySegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >:

Public Types
using	CannyFunctionType = itk::CannySegmentationLevelSetFunction< OutputImageType, FeatureImageType >

using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	ScalarValueType = typename CannyFunctionType::ScalarValueType

using	Self = CannySegmentationLevelSetImageFilter

using	Superclass = SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >

Public Types inherited from itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, float >
using	ConstPointer = SmartPointer< const Self >

using	FeatureImageType = TFeatureImage

using	OutputImageType = Image< float, 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	VectorImageType = typename SegmentationFunctionType::VectorImageType

Public Types inherited from itk::SparseFieldLevelSetImageFilter< TInputImage, Image< float, 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	OutputImageType = Image< float, TInputImage::ImageDimension >

using	Pointer = SmartPointer< Self >

using	Self = SparseFieldLevelSetImageFilter

using	StatusImageType = Image< StatusType, Self::ImageDimension >

using	StatusType = signed char

using	Superclass = FiniteDifferenceImageFilter< TInputImage, Image< float, TInputImage::ImageDimension > >

using	UpdateBufferType = std::vector< ValueType >

using	ValueType = typename OutputImageType::ValueType

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

using	FiniteDifferenceFunctionType = FiniteDifferenceFunction< Image< float, TInputImage::ImageDimension > >

using	InputImageType = TInputImage

using	InputPixelType = typename TInputImage::PixelType

using	InputPixelValueType = typename NumericTraits< InputPixelType >::ValueType

using	NeighborhoodScalesType = typename FiniteDifferenceFunctionType::NeighborhoodScalesType

using	OutputImageType = Image< float, TInputImage::ImageDimension >

using	OutputPixelType = typename TOutputImage::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< float, TInputImage::ImageDimension > >

using	TimeStepType = typename FiniteDifferenceFunctionType::TimeStepType

Public Types inherited from itk::InPlaceImageFilter< TInputImage, Image< float, 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	Pointer = SmartPointer< Self >

using	Self = InPlaceImageFilter

using	Superclass = ImageToImageFilter< TInputImage, Image< float, TInputImage::ImageDimension > >

Public Types inherited from itk::ImageToImageFilter< TInputImage, Image< float, 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	Pointer = SmartPointer< Self >

using	Self = ImageToImageFilter

using	Superclass = ImageSource< Image< float, TInputImage::ImageDimension > >

Public Types inherited from itk::ImageSource< Image< float, 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< float, 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
OutputImageType *	GetCannyImage ()

const char *	GetNameOfClass () const override


void	SetThreshold (ScalarValueType v)

ScalarValueType	GetThreshold () const


void	SetVariance (double v)

double	GetVariance () const

Public Member Functions inherited from itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, float >
void	GenerateAdvectionImage ()

void	GenerateSpeedImage ()

virtual const VectorImageType *	GetAdvectionImage () const

ValueType	GetAdvectionScaling () const

ValueType	GetCurvatureScaling () const

double	GetMaximumCurvatureTimeStep () const

unsigned int	GetMaximumIterations ()

double	GetMaximumPropagationTimeStep () const

const char *	GetNameOfClass () const override

ValueType	GetPropagationScaling () const

virtual SegmentationFunctionType *	GetSegmentationFunction ()

virtual const SpeedImageType *	GetSpeedImage () const

bool	GetUseMinimalCurvature () const

bool	GetUseNegativeFeatures () const

void	SetAdvectionImage (VectorImageType *v)

void	SetInput2 (const FeatureImageType *input)

virtual void	SetSegmentationFunction (SegmentationFunctionType *s)

void	SetSpeedImage (SpeedImageType *s)

void	SetUseNegativeFeaturesOff ()

void	UseMinimalCurvatureOff ()

void	UseMinimalCurvatureOn ()

void	SetMaximumIterations (unsigned int i)

virtual void	SetFeatureImage (const FeatureImageType *f)

	itkGetInputMacro (FeatureImage, FeatureImageType)

	itkGetInputMacro (InitialImage, InputImageType)

	itkSetInputMacro (InitialImage, InputImageType)

void	SetUseNegativeFeaturesOn ()

void	SetUseNegativeFeatures (bool u)

virtual void	SetReverseExpansionDirection (bool _arg)

virtual bool	GetReverseExpansionDirection () const

virtual void	ReverseExpansionDirectionOn ()

virtual void	SetAutoGenerateSpeedAdvection (bool _arg)

virtual bool	GetAutoGenerateSpeedAdvection () const

virtual void	AutoGenerateSpeedAdvectionOn ()

void	SetFeatureScaling (ValueType v)

void	SetPropagationScaling (ValueType v)

void	SetAdvectionScaling (ValueType v)

void	SetCurvatureScaling (ValueType v)

void	SetUseMinimalCurvature (bool b)

void	SetMaximumCurvatureTimeStep (double n)

void	SetMaximumPropagationTimeStep (double n)

Public Member Functions inherited from itk::SparseFieldLevelSetImageFilter< TInputImage, Image< float, TInputImage::ImageDimension > >
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 ()

const char *	GetNameOfClass () const override

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

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

const char *	GetNameOfClass () const override

virtual void	SetInPlace (bool _arg)

virtual bool	GetInPlace () const

virtual void	InPlaceOn ()

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

const InputImageType *	GetInput (unsigned int idx) const

const char *	GetNameOfClass () const override

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *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 > >
const char *	GetNameOfClass () const override

OutputImageType *	GetOutput (unsigned int idx)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *graft)

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

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

ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

const char *	GetNameOfClass () const override

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 DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)

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

LightObject::Pointer	CreateAnother () const override

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

const char *	GetNameOfClass () const override

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

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

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

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Static Public Member Functions
static Pointer	New ()

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

static void	SetGlobalDefaultCoordinateTolerance (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 ()

Protected Member Functions
	CannySegmentationLevelSetImageFilter ()

	~CannySegmentationLevelSetImageFilter () override=default

Protected Member Functions inherited from itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, float >
void	GenerateData () override

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

	SegmentationLevelSetImageFilter ()

	~SegmentationLevelSetImageFilter () override=default

void	InitializeIteration () override

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 &, 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	AllocateUpdateBuffer ()=0

virtual void	ApplyUpdate (const TimeStepType &dt)=0

virtual TimeStepType	CalculateChange ()=0

virtual void	CopyInputToOutput ()=0

	FiniteDifferenceImageFilter ()

void	GenerateData () override

void	GenerateInputRequestedRegion () override

virtual bool	Halt ()

virtual void	Initialize ()

virtual void	InitializeIteration ()

virtual void	PostProcessOutput ()

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

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

virtual void	SetElapsedIterations (IdentifierType _arg)

virtual bool	ThreadedHalt (void *)

	~FiniteDifferenceImageFilter () override=default

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

	InPlaceImageFilter ()=default

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

void	ReleaseInputs () override

	~InPlaceImageFilter () override=default

void	AllocateOutputs () override

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	PrintSelf (std::ostream &os, Indent indent) const override

void	VerifyInputInformation () const override

	~ImageToImageFilter () override=default

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

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

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

void	GenerateData () override

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

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

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

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

virtual void	GenerateInputRequestedRegion ()

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

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

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

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	ReleaseInputs ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType 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	VerifyInputInformation () const

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	SetThreaderUpdateProgress (bool arg)

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

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

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

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	PrintSelf (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Attributes
CannyFunctionType::Pointer	m_CannyFunction {}

Additional Inherited Members
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 = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >

using	OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >

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)

Protected Attributes inherited from itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, float >
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 {}

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

◆ CannyFunctionType

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

using itk::CannySegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::CannyFunctionType = itk::CannySegmentationLevelSetFunction<OutputImageType, FeatureImageType>

Type of the segmentation function

Definition at line 150 of file itkCannySegmentationLevelSetImageFilter.h.

◆ ConstPointer

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

using itk::CannySegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::ConstPointer = SmartPointer<const Self>

Definition at line 140 of file itkCannySegmentationLevelSetImageFilter.h.

◆ Pointer

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

using itk::CannySegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::Pointer = SmartPointer<Self>

Definition at line 139 of file itkCannySegmentationLevelSetImageFilter.h.

◆ ScalarValueType

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

using itk::CannySegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::ScalarValueType = typename CannyFunctionType::ScalarValueType

Definition at line 152 of file itkCannySegmentationLevelSetImageFilter.h.

◆ Self

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

using itk::CannySegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::Self = CannySegmentationLevelSetImageFilter

Standard class type aliases

Definition at line 137 of file itkCannySegmentationLevelSetImageFilter.h.

◆ Superclass

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

using itk::CannySegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::Superclass = SegmentationLevelSetImageFilter<TInputImage, TFeatureImage, TOutputPixelType>

Definition at line 138 of file itkCannySegmentationLevelSetImageFilter.h.

Constructor & Destructor Documentation

◆ ~CannySegmentationLevelSetImageFilter()

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

itk::CannySegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::~CannySegmentationLevelSetImageFilter ( )

overrideprotecteddefault

◆ CannySegmentationLevelSetImageFilter()

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

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

protected

Member Function Documentation

◆ GetCannyImage()

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

OutputImageType * itk::CannySegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetCannyImage ( )

inline

Get the Canny image that was used to create the speed and advection images

Definition at line 191 of file itkCannySegmentationLevelSetImageFilter.h.

◆ GetNameOfClass()

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

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ProcessObject.

◆ GetThreshold()

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

ScalarValueType itk::CannySegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetThreshold ( ) const

inline

Set the Threshold parameter of the CannyEdgeDetectionImageFilter used by the underlying level set function.

Definition at line 168 of file itkCannySegmentationLevelSetImageFilter.h.

◆ GetVariance()

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

double itk::CannySegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetVariance ( ) const

inline

Set the Variance parameter of the CannyEdgeDetectionImageFilter used by the underlying level set function.

Definition at line 182 of file itkCannySegmentationLevelSetImageFilter.h.

◆ New()

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

static Pointer itk::CannySegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::New ( )

static

Method for creation through the object factory

◆ SetThreshold()

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

void itk::CannySegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetThreshold ( ScalarValueType v )

inline

Set the Threshold parameter of the CannyEdgeDetectionImageFilter used by the underlying level set function.

Definition at line 163 of file itkCannySegmentationLevelSetImageFilter.h.

◆ SetVariance()

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

void itk::CannySegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetVariance ( double v )

inline

Set the Variance parameter of the CannyEdgeDetectionImageFilter used by the underlying level set function.

Definition at line 177 of file itkCannySegmentationLevelSetImageFilter.h.

Member Data Documentation

◆ m_CannyFunction

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

CannyFunctionType::Pointer itk::CannySegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::m_CannyFunction {}

private

Definition at line 207 of file itkCannySegmentationLevelSetImageFilter.h.

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

itkCannySegmentationLevelSetImageFilter.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ CannyFunctionType

◆ ConstPointer

◆ Pointer

◆ ScalarValueType

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ ~CannySegmentationLevelSetImageFilter()

◆ CannySegmentationLevelSetImageFilter()

Member Function Documentation

◆ GetCannyImage()

◆ GetNameOfClass()

◆ GetThreshold()

◆ GetVariance()

◆ New()

◆ SetThreshold()

◆ SetVariance()

Member Data Documentation

◆ m_CannyFunction