Detailed Description

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

Generates a feature image by computing the inverse map to the canny edges in the image.

Overview: The class generates features that can be used as the speed term for computing a canny level set. The class takes an input image

Input -> CastToFloat -> CannyEdgeFilter -> InvertFilter

The resulting feature is ideally used as the speed term for a level set segmentation module. The speed feature generated is designed to lock onto edges (which are extracted by the canny filter).

There are two parameters to this feature generator. (1) UpperThreshold/LowerThreshold: These set the thresholding values of the Canny edge detection. The canny algorithm incorporates a hysteresis thresholding which is applied to the gradient magnitude of the smoothed image to find edges. (2) Sigma. Controls the smoothing parameter of the Gaussian filtering done during Canny edge detection. The first step of canny edge detection is to smooth the input with a Gaussian filter. Second derivatives etc are computed on the smoothed image.

SpatialObjects are used as inputs and outputs of this class.

Definition at line 60 of file itkCannyEdgesFeatureGenerator.h.

Public Types
using	ConstPointer = SmartPointer< const Self >

using	InputImageSpatialObjectPointer = typename InputImageSpatialObjectType::Pointer

using	InputImageSpatialObjectType = ImageSpatialObject< NDimension, InputPixelType >

using	InputImageType = Image< InputPixelType, Dimension >

using	InputPixelType = signed short

using	Pointer = SmartPointer< Self >

using	ScalarRealType = typename NumericTraits< InputPixelType >::ScalarRealType

using	Self = CannyEdgesFeatureGenerator

using	SigmaArrayType = FixedArray< ScalarRealType, itkGetStaticConstMacro(Dimension) >

using	SpatialObjectType = typename Superclass::SpatialObjectType

using	Superclass = FeatureGenerator< NDimension >

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

using	Pointer = SmartPointer< Self >

using	Self = FeatureGenerator

using	SpatialObjectPointer = typename SpatialObjectType::Pointer

using	SpatialObjectType = SpatialObject< NDimension >

using	Superclass = ProcessObject

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

using	DataObjectIdentifierType = DataObject::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArray = std::vector< DataObjectPointer >

using	DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

using	MultiThreaderType = MultiThreaderBase

using	NameArray = std::vector< DataObjectIdentifierType >

using	Pointer = SmartPointer< Self >

using	Self = ProcessObject

using	Superclass = Object

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

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

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

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const

const SpatialObjectType *	GetFeature () const

virtual double	GetLowerThreshold ()

virtual const char *	GetNameOfClass () const

virtual double	GetUpperThreshold ()

virtual void	SetLowerThreshold (double _arg)

virtual void	SetUpperThreshold (double _arg)


void	SetInput (const SpatialObjectType *input)

const SpatialObjectType *	GetInput () const


void	SetSigmaArray (const SigmaArrayType &sigmas)

void	SetSigma (ScalarRealType sigma)

SigmaArrayType	GetSigmaArray () const

ScalarRealType	GetSigma () const

Public Member Functions inherited from itk::FeatureGenerator< NDimension >
virtual ::itk::LightObject::Pointer	CreateAnother () const

const SpatialObjectType *	GetFeature () const

void	SetInput (const SpatialObjectType *input)

const SpatialObjectType *	GetInput () const

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

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

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 const float &	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool flag)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	ReleaseDataBeforeUpdateFlagOff ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

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

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual void	DebugOff () const

virtual void	DebugOn () const

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)

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexceptoverride

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

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

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::FeatureGenerator< NDimension >
static Pointer	New ()

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

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

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

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	Dimension = NDimension

Static Public Attributes inherited from itk::FeatureGenerator< NDimension >
static constexpr unsigned int	Dimension = NDimension

Protected Member Functions
	CannyEdgesFeatureGenerator ()

void	GenerateData () override

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

	~CannyEdgesFeatureGenerator () override

Protected Member Functions inherited from itk::FeatureGenerator< NDimension >
	FeatureGenerator ()

SpatialObjectType *	GetInternalFeature ()

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

	~FeatureGenerator () override

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateInputRequestedRegion ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

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

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	ReleaseInputs ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

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

virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

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

virtual void	SetPrimaryInput (DataObject *input)

virtual void	SetPrimaryOutput (DataObject *output)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyInputInformation () ITKv5_CONST

virtual void	VerifyPreconditions () ITKv5_CONST

	~ProcessObject () override

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

const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

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

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

virtual void	SetTimeStamp (const TimeStamp &time)

	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

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

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

virtual	~LightObject ()

Private Types
using	CannyEdgeFilterPointer = typename CannyEdgeFilterType::Pointer

using	CannyEdgeFilterType = CannyEdgeDetectionRecursiveGaussianImageFilter< InternalImageType, InternalImageType >

using	CastFilterPointer = typename CastFilterType::Pointer

using	CastFilterType = CastImageFilter< InputImageType, InternalImageType >

using	InternalImageType = Image< InternalPixelType, Dimension >

using	InternalPixelType = float

using	OutputImageSpatialObjectType = ImageSpatialObject< NDimension, OutputPixelType >

using	OutputImageType = InternalImageType

using	OutputPixelType = InternalPixelType

using	RescaleFilterPointer = typename RescaleFilterType::Pointer

using	RescaleFilterType = IntensityWindowingImageFilter< InternalImageType, InternalImageType >

Private Attributes
CannyEdgeFilterPointer	m_CannyFilter

CastFilterPointer	m_CastFilter

double	m_LowerThreshold

RescaleFilterPointer	m_RescaleFilter

SigmaArrayType	m_Sigma

double	m_UpperThreshold

Additional Inherited Members
Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime

bool	m_Updating

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