#include <itkCannyEdgeDetectionImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage>
class itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >

This filter is an implementation of a Canny edge detector for scalar-valued images.

Based on John Canny's paper "A Computational Approach to Edge Detection"(IEEE Transactions on Pattern Analysis and Machine Intelligence, Vol. PAMI-8, No.6, November 1986), there are four major steps used in the edge-detection scheme: (1) Smooth the input image with Gaussian filter. (2) Calculate the second directional derivatives of the smoothed image. (3) Non-Maximum Suppression: the zero-crossings of 2nd derivative are found, and the sign of third derivative is used to find the correct extrema. (4) The hysteresis thresholding is applied to the gradient magnitude (multiplied with zero-crossings) of the smoothed image to find and link edges.

Inputs and Outputs: The input to this filter should be a scalar, real-valued Itk image of arbitrary dimension. The output should also be a scalar, real-value Itk image of the same dimensionality.

Parameters: There are four parameters for this filter that control the sub-filters used by the algorithm.

: Variance and Maximum error are used in the Gaussian smoothing of the input image. See itkDiscreteGaussianImageFilter for information on these parameters.

: Threshold is the lowest allowed value in the output image. Its data type is the same as the data type of the output image. Any values below the Threshold level will be replaced with the OutsideValue parameter value, whose default is zero.

Todo:: Edge-linking will be added when an itk connected component labeling algorithm is available.

See also: DiscreteGaussianImageFilter; ZeroCrossingImageFilter; ThresholdImageFilter

Definition at line 88 of file itkCannyEdgeDetectionImageFilter.h.

Inheritance diagram for itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >:

Public Types
using	ArrayType = FixedArray< double, Self::ImageDimension >

using	ConstPointer = SmartPointer< const Self >

using	DefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition< OutputImageType >

using	IndexType = typename TInputImage::IndexType

using	InputImagePixelType = typename TInputImage::PixelType

using	InputImageRegionType = typename TInputImage::RegionType

using	InputImageType = TInputImage

using	ListNodeStorageType = ObjectStore< ListNodeType >

using	ListNodeType = ListNode< IndexType >

using	ListPointerType = typename ListType::Pointer

using	ListType = SparseFieldLayer< ListNodeType >

using	NeighborhoodType = ConstNeighborhoodIterator< OutputImageType, DefaultBoundaryConditionType >

using	OutputImagePixelType = typename TOutputImage::PixelType

using	OutputImageRegionType = typename TOutputImage::RegionType

using	OutputImageType = TOutputImage

using	Pointer = SmartPointer< Self >

using	Self = CannyEdgeDetectionImageFilter

using	SizeValueType = typename TInputImage::SizeValueType

using	Superclass = ImageToImageFilter< TInputImage, TOutputImage >

Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
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< TOutputImage >

Public Types inherited from itk::ImageSource< TOutputImage >
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 = TOutputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageSource

using	Superclass = ProcessObject

Public Types inherited from itk::ProcessObject
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = DataObject::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArray = std::vector< DataObjectPointer >

using	DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

using	MultiThreaderType = MultiThreaderBase

using	NameArray = std::vector< DataObjectIdentifierType >

using	Pointer = SmartPointer< Self >

using	Self = ProcessObject

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
virtual OutputImagePixelType	GetLowerThreshold () const

const char *	GetNameOfClass () const override

OutputImageType *	GetNonMaximumSuppressionImage ()

virtual OutputImagePixelType	GetUpperThreshold () const

virtual void	SetLowerThreshold (OutputImagePixelType _arg)

virtual void	SetUpperThreshold (OutputImagePixelType _arg)


virtual void	SetVariance (ArrayType _arg)

virtual const ArrayType	GetVariance () const


virtual void	SetMaximumError (ArrayType _arg)

virtual const ArrayType	GetMaximumError () const


void	SetVariance (const typename ArrayType::ValueType v)


void	SetMaximumError (const typename ArrayType::ValueType v)

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
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< TOutputImage >
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::ImageToImageFilter< TInputImage, TOutputImage >
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 ()

Static Public Attributes
static constexpr unsigned int	ImageDimension = TInputImage::ImageDimension

static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

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

static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Protected Types
using	GaussianImageFilterType = DiscreteGaussianImageFilter< InputImageType, OutputImageType >

using	MultiplyImageFilterType = MultiplyImageFilter< OutputImageType, OutputImageType, OutputImageType >

Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >

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

Protected Member Functions
	CannyEdgeDetectionImageFilter ()

void	GenerateData () override

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

Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
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< TOutputImage >
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 Member Functions
void	AllocateUpdateBuffer ()

OutputImagePixelType	ComputeCannyEdge (const NeighborhoodType &it, void *globalData)

void	FollowEdge (IndexType index, const OutputImageType *multiplyImageFilterOutput)

void	HysteresisThresholding ()

void	ThreadedCompute2ndDerivative (const OutputImageRegionType &outputRegionForThread)

void	ThreadedCompute2ndDerivativePos (const OutputImageRegionType &outputRegionForThread)

	~CannyEdgeDetectionImageFilter () override=default

Additional Inherited Members
Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
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::ImageSource< TOutputImage >
bool	m_DynamicMultiThreading { true }

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

bool	m_Updating {}

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

Member Typedef Documentation

◆ ArrayType

template<typename TInputImage , typename TOutputImage >

using itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::ArrayType = FixedArray<double, Self::ImageDimension>

Typedef of double containers.

Definition at line 140 of file itkCannyEdgeDetectionImageFilter.h.

◆ ConstPointer

template<typename TInputImage , typename TOutputImage >

using itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 103 of file itkCannyEdgeDetectionImageFilter.h.

◆ DefaultBoundaryConditionType

template<typename TInputImage , typename TOutputImage >

using itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::DefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition<OutputImageType>

The default boundary condition is used unless overridden in the Evaluate() method.

Definition at line 113 of file itkCannyEdgeDetectionImageFilter.h.

◆ GaussianImageFilterType

template<typename TInputImage , typename TOutputImage >

using itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::GaussianImageFilterType = DiscreteGaussianImageFilter<InputImageType, OutputImageType>

protected

Definition at line 220 of file itkCannyEdgeDetectionImageFilter.h.

◆ IndexType

template<typename TInputImage , typename TOutputImage >

using itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::IndexType = typename TInputImage::IndexType

Definition at line 108 of file itkCannyEdgeDetectionImageFilter.h.

◆ InputImagePixelType

template<typename TInputImage , typename TOutputImage >

using itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::InputImagePixelType = typename TInputImage::PixelType

Define pixel types.

Definition at line 106 of file itkCannyEdgeDetectionImageFilter.h.

◆ InputImageRegionType

template<typename TInputImage , typename TOutputImage >

using itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::InputImageRegionType = typename TInputImage::RegionType

Definition at line 130 of file itkCannyEdgeDetectionImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TOutputImage >

using itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage

Image type alias support

Definition at line 98 of file itkCannyEdgeDetectionImageFilter.h.

◆ ListNodeStorageType

template<typename TInputImage , typename TOutputImage >

using itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::ListNodeStorageType = ObjectStore<ListNodeType>

Definition at line 121 of file itkCannyEdgeDetectionImageFilter.h.

◆ ListNodeType

template<typename TInputImage , typename TOutputImage >

using itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::ListNodeType = ListNode<IndexType>

Definition at line 120 of file itkCannyEdgeDetectionImageFilter.h.

◆ ListPointerType

template<typename TInputImage , typename TOutputImage >

using itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::ListPointerType = typename ListType::Pointer

Definition at line 123 of file itkCannyEdgeDetectionImageFilter.h.

◆ ListType

template<typename TInputImage , typename TOutputImage >

using itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::ListType = SparseFieldLayer<ListNodeType>

Definition at line 122 of file itkCannyEdgeDetectionImageFilter.h.

◆ MultiplyImageFilterType

template<typename TInputImage , typename TOutputImage >

using itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::MultiplyImageFilterType = MultiplyImageFilter<OutputImageType, OutputImageType, OutputImageType>

protected

Definition at line 221 of file itkCannyEdgeDetectionImageFilter.h.

◆ NeighborhoodType

template<typename TInputImage , typename TOutputImage >

using itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::NeighborhoodType = ConstNeighborhoodIterator<OutputImageType, DefaultBoundaryConditionType>

The type of data structure that is passed to this function object to evaluate at a pixel that does not lie on a data set boundary.

Definition at line 118 of file itkCannyEdgeDetectionImageFilter.h.

◆ OutputImagePixelType

template<typename TInputImage , typename TOutputImage >

using itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::OutputImagePixelType = typename TOutputImage::PixelType

Definition at line 107 of file itkCannyEdgeDetectionImageFilter.h.

◆ OutputImageRegionType

template<typename TInputImage , typename TOutputImage >

using itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::OutputImageRegionType = typename TOutputImage::RegionType

Typedef to describe the output image region type.

Definition at line 129 of file itkCannyEdgeDetectionImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TOutputImage >

using itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage

Definition at line 99 of file itkCannyEdgeDetectionImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage >

using itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self>

SmartPointer type alias support

Definition at line 102 of file itkCannyEdgeDetectionImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage >

using itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::Self = CannyEdgeDetectionImageFilter

Standard "Self" & Superclass type alias.

Definition at line 94 of file itkCannyEdgeDetectionImageFilter.h.

◆ SizeValueType

template<typename TInputImage , typename TOutputImage >

using itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::SizeValueType = typename TInputImage::SizeValueType

Definition at line 109 of file itkCannyEdgeDetectionImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage >

using itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 95 of file itkCannyEdgeDetectionImageFilter.h.

Constructor & Destructor Documentation

◆ CannyEdgeDetectionImageFilter()

template<typename TInputImage , typename TOutputImage >

itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::CannyEdgeDetectionImageFilter ( )

protected

◆ ~CannyEdgeDetectionImageFilter()

template<typename TInputImage , typename TOutputImage >

itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::~CannyEdgeDetectionImageFilter ( )

overrideprivatedefault

Member Function Documentation

◆ AllocateUpdateBuffer()

template<typename TInputImage , typename TOutputImage >

void itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::AllocateUpdateBuffer ( )

private

Allocate storage for update buffers used during calculation of multiple steps.

◆ ComputeCannyEdge()

template<typename TInputImage , typename TOutputImage >

OutputImagePixelType itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::ComputeCannyEdge	(	const NeighborhoodType &	it,
		void *	globalData
	)

private

This method is used to calculate the 2nd derivative for non-boundary pixels. It is called by the ThreadedCompute2ndDerivative method.

◆ FollowEdge()

template<typename TInputImage , typename TOutputImage >

void itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::FollowEdge	(	IndexType	index,
		const OutputImageType *	multiplyImageFilterOutput
	)

private

Edge linking function.

◆ GenerateData()

template<typename TInputImage , typename TOutputImage >

void itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::GenerateData ( )

overrideprotectedvirtual

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

See also: ThreadedGenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GetLowerThreshold()

template<typename TInputImage , typename TOutputImage >

virtual OutputImagePixelType itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::GetLowerThreshold ( ) const

virtual

◆ GetMaximumError()

template<typename TInputImage , typename TOutputImage >

virtual const ArrayType itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::GetMaximumError ( ) const

virtual

Set/Get the maximum error of the Gaussian smoothing kernel in each dimensional direction.

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage >

const char * itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

◆ GetNonMaximumSuppressionImage()

template<typename TInputImage , typename TOutputImage >

OutputImageType * itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::GetNonMaximumSuppressionImage ( )

inline

Definition at line 197 of file itkCannyEdgeDetectionImageFilter.h.

◆ GetUpperThreshold()

template<typename TInputImage , typename TOutputImage >

virtual OutputImagePixelType itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::GetUpperThreshold ( ) const

virtual

◆ GetVariance()

template<typename TInputImage , typename TOutputImage >

virtual const ArrayType itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::GetVariance ( ) const

virtual

Set/Get the variance of the Gaussian smoothing filter.

◆ HysteresisThresholding()

template<typename TInputImage , typename TOutputImage >

void itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::HysteresisThresholding ( )

private

Implement hysteresis thresholding.

◆ New()

template<typename TInputImage , typename TOutputImage >

static Pointer itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::New ( )

static

Method for creation through the object factory.

Referenced by itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::CannySegmentationLevelSetFunction().

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage >

void itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::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::ImageToImageFilter< TInputImage, TOutputImage >.

◆ SetLowerThreshold()

template<typename TInputImage , typename TOutputImage >

virtual void itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::SetLowerThreshold ( OutputImagePixelType _arg )

virtual

Set the lower threshold value for detected edges.

◆ SetMaximumError() [1/2]

template<typename TInputImage , typename TOutputImage >

virtual void itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::SetMaximumError ( ArrayType _arg )

virtual

Set/Get the maximum error of the Gaussian smoothing kernel in each dimensional direction.

◆ SetMaximumError() [2/2]

template<typename TInputImage , typename TOutputImage >

void itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::SetMaximumError ( const typename ArrayType::ValueType v )

inline

Set/Get the MaximumError parameter used by the Gaussian smoothing filter in this algorithm

Definition at line 172 of file itkCannyEdgeDetectionImageFilter.h.

References itk::Math::NotExactlyEquals().

◆ SetUpperThreshold()

template<typename TInputImage , typename TOutputImage >

virtual void itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::SetUpperThreshold ( OutputImagePixelType _arg )

virtual

Set the upper threshold value for detected edges.

◆ SetVariance() [1/2]

template<typename TInputImage , typename TOutputImage >

virtual void itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::SetVariance ( ArrayType _arg )

virtual

Set/Get the variance of the Gaussian smoothing filter.

◆ SetVariance() [2/2]

template<typename TInputImage , typename TOutputImage >

void itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::SetVariance ( const typename ArrayType::ValueType v )

inline

Set/Get the variance of the Gaussian smoothing filter.

Definition at line 155 of file itkCannyEdgeDetectionImageFilter.h.

References itk::Math::NotExactlyEquals().

◆ ThreadedCompute2ndDerivative()

template<typename TInputImage , typename TOutputImage >

void itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::ThreadedCompute2ndDerivative ( const OutputImageRegionType & outputRegionForThread )

private

Calculate the second derivative of the smoothed image, it writes the result to the update buffer

◆ ThreadedCompute2ndDerivativePos()

template<typename TInputImage , typename TOutputImage >

void itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::ThreadedCompute2ndDerivativePos ( const OutputImageRegionType & outputRegionForThread )

private

Calculate the gradient of the second derivative of the smoothed image, it writes the result to m_UpdateBuffer1

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TOutputImage >

constexpr unsigned int itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::ImageDimension = TInputImage::ImageDimension

staticconstexpr

ImageDimension constant.

Definition at line 136 of file itkCannyEdgeDetectionImageFilter.h.

◆ m_Center

template<typename TInputImage , typename TOutputImage >

SizeValueType itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::m_Center {}

private

Definition at line 278 of file itkCannyEdgeDetectionImageFilter.h.

◆ m_ComputeCannyEdge1stDerivativeOper

template<typename TInputImage , typename TOutputImage >

DerivativeOperator<OutputImagePixelType, Self::ImageDimension> itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::m_ComputeCannyEdge1stDerivativeOper {}

private

Function objects that are used in the inner loops of derivative calculations.

Definition at line 272 of file itkCannyEdgeDetectionImageFilter.h.

◆ m_ComputeCannyEdge2ndDerivativeOper

template<typename TInputImage , typename TOutputImage >

DerivativeOperator<OutputImagePixelType, Self::ImageDimension> itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::m_ComputeCannyEdge2ndDerivativeOper {}

private

Definition at line 273 of file itkCannyEdgeDetectionImageFilter.h.

◆ m_ComputeCannyEdgeSlice

template<typename TInputImage , typename TOutputImage >

std::slice itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::m_ComputeCannyEdgeSlice[ImageDimension] {}

private

Definition at line 275 of file itkCannyEdgeDetectionImageFilter.h.

◆ m_GaussianFilter

template<typename TInputImage , typename TOutputImage >

GaussianImageFilterType::Pointer itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::m_GaussianFilter {}

private

Gaussian filter to smooth the input image.

Definition at line 264 of file itkCannyEdgeDetectionImageFilter.h.

◆ m_LowerThreshold

template<typename TInputImage , typename TOutputImage >

OutputImagePixelType itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::m_LowerThreshold {}

private

Definition at line 259 of file itkCannyEdgeDetectionImageFilter.h.

◆ m_MaximumError

template<typename TInputImage , typename TOutputImage >

ArrayType itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::m_MaximumError {}

private

Definition at line 256 of file itkCannyEdgeDetectionImageFilter.h.

◆ m_MultiplyImageFilter

template<typename TInputImage , typename TOutputImage >

MultiplyImageFilterType::Pointer itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::m_MultiplyImageFilter {}

private

Multiply image filter to multiply with the zero crossings of the second derivative.

Definition at line 268 of file itkCannyEdgeDetectionImageFilter.h.

◆ m_NodeList

template<typename TInputImage , typename TOutputImage >

ListPointerType itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::m_NodeList {}

private

Definition at line 281 of file itkCannyEdgeDetectionImageFilter.h.

◆ m_NodeStore

template<typename TInputImage , typename TOutputImage >

ListNodeStorageType::Pointer itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::m_NodeStore {}

private

Definition at line 280 of file itkCannyEdgeDetectionImageFilter.h.

◆ m_OutputImage

template<typename TInputImage , typename TOutputImage >

OutputImageType* itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::m_OutputImage {}

private

Definition at line 283 of file itkCannyEdgeDetectionImageFilter.h.

◆ m_Stride

template<typename TInputImage , typename TOutputImage >

SizeValueType itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::m_Stride[ImageDimension] {}

private

Definition at line 277 of file itkCannyEdgeDetectionImageFilter.h.

◆ m_UpdateBuffer1

template<typename TInputImage , typename TOutputImage >

OutputImageType::Pointer itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::m_UpdateBuffer1 {}

private

Definition at line 261 of file itkCannyEdgeDetectionImageFilter.h.

◆ m_UpperThreshold

template<typename TInputImage , typename TOutputImage >

OutputImagePixelType itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::m_UpperThreshold {}

private

Definition at line 258 of file itkCannyEdgeDetectionImageFilter.h.

◆ m_Variance

template<typename TInputImage , typename TOutputImage >

ArrayType itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::m_Variance {}

private

Definition at line 255 of file itkCannyEdgeDetectionImageFilter.h.

◆ OutputImageDimension

template<typename TInputImage , typename TOutputImage >

constexpr unsigned int itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension

staticconstexpr

Definition at line 137 of file itkCannyEdgeDetectionImageFilter.h.

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

itkCannyEdgeDetectionImageFilter.h

Private Attributes
SizeValueType	m_Center {}

DerivativeOperator< OutputImagePixelType, Self::ImageDimension >	m_ComputeCannyEdge1stDerivativeOper {}

DerivativeOperator< OutputImagePixelType, Self::ImageDimension >	m_ComputeCannyEdge2ndDerivativeOper {}

std::slice	m_ComputeCannyEdgeSlice [ImageDimension] {}

GaussianImageFilterType::Pointer	m_GaussianFilter {}

OutputImagePixelType	m_LowerThreshold {}

ArrayType	m_MaximumError {}

MultiplyImageFilterType::Pointer	m_MultiplyImageFilter {}

ListPointerType	m_NodeList {}

ListNodeStorageType::Pointer	m_NodeStore {}

OutputImageType *	m_OutputImage {}

SizeValueType	m_Stride [ImageDimension] {}

OutputImageType::Pointer	m_UpdateBuffer1 {}

OutputImagePixelType	m_UpperThreshold {}

ArrayType	m_Variance {}

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ArrayType

◆ ConstPointer

◆ DefaultBoundaryConditionType

◆ GaussianImageFilterType

◆ IndexType

◆ InputImagePixelType

◆ InputImageRegionType

◆ InputImageType

◆ ListNodeStorageType

◆ ListNodeType

◆ ListPointerType

◆ ListType

◆ MultiplyImageFilterType

◆ NeighborhoodType

◆ OutputImagePixelType

◆ OutputImageRegionType

◆ OutputImageType

◆ Pointer

◆ Self

◆ SizeValueType

◆ Superclass

Constructor & Destructor Documentation

◆ CannyEdgeDetectionImageFilter()

◆ ~CannyEdgeDetectionImageFilter()

Member Function Documentation

◆ AllocateUpdateBuffer()

◆ ComputeCannyEdge()

◆ FollowEdge()

◆ GenerateData()

◆ GetLowerThreshold()

◆ GetMaximumError()

◆ GetNameOfClass()

◆ GetNonMaximumSuppressionImage()

◆ GetUpperThreshold()

◆ GetVariance()

◆ HysteresisThresholding()

◆ New()

◆ PrintSelf()

◆ SetLowerThreshold()

◆ SetMaximumError() [1/2]

◆ SetMaximumError() [2/2]

◆ SetUpperThreshold()

◆ SetVariance() [1/2]

◆ SetVariance() [2/2]

◆ ThreadedCompute2ndDerivative()

◆ ThreadedCompute2ndDerivativePos()

Member Data Documentation

◆ ImageDimension

◆ m_Center

◆ m_ComputeCannyEdge1stDerivativeOper

◆ m_ComputeCannyEdge2ndDerivativeOper

◆ m_ComputeCannyEdgeSlice

◆ m_GaussianFilter

◆ m_LowerThreshold

◆ m_MaximumError

◆ m_MultiplyImageFilter

◆ m_NodeList

◆ m_NodeStore

◆ m_OutputImage

◆ m_Stride

◆ m_UpdateBuffer1

◆ m_UpperThreshold

◆ m_Variance

◆ OutputImageDimension