#include <itkImplicitManifoldNormalVectorFilter.h>

Detailed Description

template<typename TInputImage, typename TSparseOutputImage>
class itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >

This class implements the filter for computing the normal vectors from a scalar implicit function (i.e. a levelset image) and processing them.

: This is a ready-to-use class for filtering normal vectors of an implicit manifold image. The normal vectors of the input image are computed and processed in a band where the values of the input image fall in the region [IsoLevelLow, IsoLevelHigh]. The processing is done by m_NormalFunction. This class also defines a Halt method which uses the iteration counter and the parameter m_MaxIteration to determine when to stop the processing.

INPUTS: The input is a scalar image. Even though this can be any scalar image, this filter class is intended to work with the image of an implicit function. One such example is the output of the SparseFieldLevelSetImageFilter class.

OUTPUTS: The output is a sparse image. The m_Data member variables of the nodes of the sparse image will contain the filtered output normal vectors. The sparse image has valid node pointers only in the band [IsoLevelLow, IsoLevelHigh]. Pixels of the sparse image outside this band will be null pointers.

PARAMETERS: IsoLevelLow and IsoLevelHigh define the working band for this filter. Pixels of the input scalar image whose values fall between these low and high limits will be operated on. MaxIteration determines the number of iterations this filter will perform. (Default is 25) The MinVectorNorm parameter determines the minimum vector norm allowed (to avoid divide by 0). The default for MinVectorNorm is 10^-6 which is designed to work with an input image of floats. This value can be lowered to 10^-12 if the input image is doubles.

IMPORTANT: The TSparseOutputImage template parameter must be a sparse image templated over a NodeType which at least has the following members: m_Data, m_InputData, m_Update and m_ManifoldNormal. Depending on the Function object being used it might need other members. For instance, NormalVectorDiffusionFunction will also require that the NodeType has the following additional members: m_Flux.

Definition at line 73 of file itkImplicitManifoldNormalVectorFilter.h.

Inheritance diagram for itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >:

Collaboration diagram for itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	InputImageIteratorType = ConstNeighborhoodIterator< InputImageType >

using	NormalBandNodeType = typename Superclass::OutputNodeType

using	NormalFunctionType = NormalVectorFunctionBase< SparseOutputImageType >

using	NormalVectorType = typename Superclass::NodeDataType

using	Pointer = SmartPointer< Self >

using	RadiusType = typename FiniteDifferenceFunctionType::RadiusType

using	Self = ImplicitManifoldNormalVectorFilter

using	Superclass = FiniteDifferenceSparseImageFilter< TInputImage, TSparseOutputImage >

Public Types inherited from itk::FiniteDifferenceSparseImageFilter< TInputImage, TSparseOutputImage >
using	ConstPointer = SmartPointer< const Self >

using	IndexType = typename SparseOutputImageType::IndexType

using	NodeDataType = typename OutputNodeType::NodeDataType

using	NodeListType = typename SparseOutputImageType::NodeListType

using	NodeValueType = typename OutputNodeType::NodeValueType

using	OutputNodeType = typename SparseOutputImageType::NodeType

using	Pointer = SmartPointer< Self >

using	Self = FiniteDifferenceSparseImageFilter

using	SizeType = typename SparseOutputImageType::SizeType

using	SparseFunctionType = FiniteDifferenceSparseImageFunction< SparseOutputImageType >

using	SparseOutputImageType = typename Superclass::OutputImageType

using	Superclass = FiniteDifferenceImageFilter< TInputImage, TSparseOutputImage >

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

using	FiniteDifferenceFunctionType = FiniteDifferenceFunction< TSparseOutputImage >

using	InputImageType = TInputImage

using	InputPixelType = typename TInputImage::PixelType

using	InputPixelValueType = typename NumericTraits< InputPixelType >::ValueType

using	NeighborhoodScalesType = typename FiniteDifferenceFunctionType::NeighborhoodScalesType

using	OutputImageType = TSparseOutputImage

using	OutputPixelType = typename TSparseOutputImage ::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, TSparseOutputImage >

using	TimeStepType = typename FiniteDifferenceFunctionType::TimeStepType

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

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

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

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 NodeValueType	GetIsoLevelHigh () const

virtual NodeValueType	GetIsoLevelLow () const

virtual unsigned int	GetMaxIteration () const

virtual NodeValueType	GetMinVectorNorm () const

const char *	GetNameOfClass () const override

virtual bool	GetUnsharpMaskingFlag () const

virtual NodeValueType	GetUnsharpMaskingWeight () const

virtual void	SetIsoLevelHigh (NodeValueType _arg)

virtual void	SetIsoLevelLow (NodeValueType _arg)

virtual void	SetMaxIteration (unsigned int _arg)

virtual void	SetMinVectorNorm (NodeValueType _arg)

void	SetNormalFunction (NormalFunctionType *nf)

virtual void	SetUnsharpMaskingFlag (bool _arg)

virtual void	SetUnsharpMaskingWeight (NodeValueType _arg)

Public Member Functions inherited from itk::FiniteDifferenceSparseImageFilter< TInputImage, TSparseOutputImage >
const char *	GetNameOfClass () const override

virtual bool	GetPrecomputeFlag () const

virtual void	SetPrecomputeFlag (bool _arg)

void	SetSparseFunction (SparseFunctionType *sf)

Public Member Functions inherited from itk::FiniteDifferenceImageFilter< TInputImage, TSparseOutputImage >
virtual const FiniteDifferenceFunctionType ::Pointer &	GetDifferenceFunction () const

virtual const IdentifierType &	GetElapsedIterations () const

virtual bool	GetIsInitialized ()

virtual void	SetDifferenceFunction (FiniteDifferenceFunctionType *_arg)

virtual void	SetIsInitialized (bool _arg)

void	SetStateToInitialized ()

void	SetStateToUninitialized ()

virtual void	SetNumberOfIterations (IdentifierType _arg)

virtual const IdentifierType &	GetNumberOfIterations () const

virtual void	SetUseImageSpacing (bool _arg)

virtual void	UseImageSpacingOn ()

virtual 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, TSparseOutputImage >
virtual bool	CanRunInPlace () const

virtual void	SetInPlace (bool _arg)

virtual bool	GetInPlace () const

virtual void	InPlaceOn ()

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

const InputImageType *	GetInput (unsigned int idx) const

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	SetInput (const 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< TSparseOutputImage >
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

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

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

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

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

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TSparseOutputImage >
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 = Superclass::ImageDimension

Static Public Attributes inherited from itk::FiniteDifferenceSparseImageFilter< TInputImage, TSparseOutputImage >
static constexpr unsigned int	ImageDimension

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

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

static constexpr unsigned int	OutputImageDimension

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

static constexpr unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageSource< TSparseOutputImage >
static constexpr unsigned int	OutputImageDimension

Protected Member Functions
void	CopyInputToOutput () override

NormalVectorType	DataConstraint (const NormalVectorType &data) const override

	ImplicitManifoldNormalVectorFilter ()

void	Initialize () override

void	InitializeNormalBandNode (NormalBandNodeType *node, const InputImageIteratorType &it)

void	PostProcessOutput () override

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

void	SetNormalBand ()

	~ImplicitManifoldNormalVectorFilter () override=default


bool	Halt () override

Protected Member Functions inherited from itk::FiniteDifferenceSparseImageFilter< TInputImage, TSparseOutputImage >
void	AllocateUpdateBuffer () override

void	ApplyUpdate (const TimeStepType &dt) override

TimeStepType	CalculateChange () override

virtual NodeDataType	DataConstraint (const NodeDataType &data) const

	FiniteDifferenceSparseImageFilter ()

ThreadIdType	GetSplitRegion (ThreadIdType i, ThreadIdType num, ThreadRegionType &splitRegion)

void	Initialize () override

virtual void	PrecalculateChange ()

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

virtual void	ThreadedApplyUpdate (const TimeStepType &dt, const ThreadRegionType &regionToProcess, ThreadIdType threadId)

virtual TimeStepType	ThreadedCalculateChange (const ThreadRegionType &regionToProcess, ThreadIdType threadId)

virtual void	ThreadedPrecalculateChange (const ThreadRegionType &regionToProcess, ThreadIdType threadId)

	~FiniteDifferenceSparseImageFilter () override=default

Protected Member Functions inherited from itk::FiniteDifferenceImageFilter< TInputImage, TSparseOutputImage >
	FiniteDifferenceImageFilter ()

void	GenerateData () override

void	GenerateInputRequestedRegion () override

virtual void	InitializeIteration ()

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, TSparseOutputImage >
virtual bool	GetRunningInPlace () const

	InPlaceImageFilter ()=default

void	ReleaseInputs () override

	~InPlaceImageFilter () override=default

void	AllocateOutputs () override

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

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

	ImageToImageFilter ()

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< TSparseOutputImage >
virtual void	AfterThreadedGenerateData ()

virtual void	BeforeThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

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

	~ImageSource () override=default

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

virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

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

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

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

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

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

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyPreconditions () const

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	SetThreaderUpdateProgress (bool arg)

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

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

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

	LightObject ()

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

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

virtual	~LightObject ()

Private Attributes
NodeValueType	m_DimConst {}

NodeValueType	m_DimConst2 {}

unsigned long	m_Indicator [Self::ImageDimension] {}

NodeValueType	m_IsoLevelHigh {}

NodeValueType	m_IsoLevelLow

RadiusType	m_ManifoldRadius {}

unsigned int	m_MaxIteration {}

NodeValueType	m_MinVectorNorm {}

NormalFunctionType *	m_NormalFunction {}

unsigned int	m_NumVertex {}

bool	m_UnsharpMaskingFlag {}

NodeValueType	m_UnsharpMaskingWeight {}

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TSparseOutputImage >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >

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

Static Protected Member Functions inherited from itk::FiniteDifferenceSparseImageFilter< TInputImage, TSparseOutputImage >
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ApplyUpdateThreaderCallback (void *arg)

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	CalculateChangeThreaderCallback (void *arg)

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	PrecalculateChangeThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ImageSource< TSparseOutputImage >
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::FiniteDifferenceImageFilter< TInputImage, TSparseOutputImage >
IdentifierType	m_ElapsedIterations

bool	m_IsInitialized

bool	m_ManualReinitialization

double	m_MaximumRMSError

IdentifierType	m_NumberOfIterations

double	m_RMSChange

Protected Attributes inherited from itk::ImageSource< TSparseOutputImage >
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 {}

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TSparseOutputImage >

using itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 84 of file itkImplicitManifoldNormalVectorFilter.h.

◆ InputImageIteratorType

template<typename TInputImage , typename TSparseOutputImage >

using itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::InputImageIteratorType = ConstNeighborhoodIterator<InputImageType>

The iterator for the input image.

Definition at line 107 of file itkImplicitManifoldNormalVectorFilter.h.

◆ NormalBandNodeType

template<typename TInputImage , typename TSparseOutputImage >

using itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::NormalBandNodeType = typename Superclass::OutputNodeType

Definition at line 103 of file itkImplicitManifoldNormalVectorFilter.h.

◆ NormalFunctionType

template<typename TInputImage , typename TSparseOutputImage >

using itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::NormalFunctionType = NormalVectorFunctionBase<SparseOutputImageType>

This is the finite difference function type for processing the normal vectors

Definition at line 111 of file itkImplicitManifoldNormalVectorFilter.h.

◆ NormalVectorType

template<typename TInputImage , typename TSparseOutputImage >

using itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::NormalVectorType = typename Superclass::NodeDataType

Definition at line 98 of file itkImplicitManifoldNormalVectorFilter.h.

◆ Pointer

template<typename TInputImage , typename TSparseOutputImage >

using itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::Pointer = SmartPointer<Self>

Definition at line 83 of file itkImplicitManifoldNormalVectorFilter.h.

◆ RadiusType

template<typename TInputImage , typename TSparseOutputImage >

using itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::RadiusType = typename FiniteDifferenceFunctionType::RadiusType

This is the radius type for the image neighborhoods.

Definition at line 114 of file itkImplicitManifoldNormalVectorFilter.h.

◆ Self

template<typename TInputImage , typename TSparseOutputImage >

using itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::Self = ImplicitManifoldNormalVectorFilter

Standard class type alias

Definition at line 80 of file itkImplicitManifoldNormalVectorFilter.h.

◆ Superclass

template<typename TInputImage , typename TSparseOutputImage >

using itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::Superclass = FiniteDifferenceSparseImageFilter<TInputImage, TSparseOutputImage>

Definition at line 81 of file itkImplicitManifoldNormalVectorFilter.h.

Constructor & Destructor Documentation

◆ ImplicitManifoldNormalVectorFilter()

template<typename TInputImage , typename TSparseOutputImage >

itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::ImplicitManifoldNormalVectorFilter ( )

protected

◆ ~ImplicitManifoldNormalVectorFilter()

template<typename TInputImage , typename TSparseOutputImage >

itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::~ImplicitManifoldNormalVectorFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ CopyInputToOutput()

template<typename TInputImage , typename TSparseOutputImage >

void itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::CopyInputToOutput ( )

inlineoverrideprotectedvirtual

This function does nothing. The output initialization is handled by Initialize.

Implements itk::FiniteDifferenceImageFilter< TInputImage, TSparseOutputImage >.

Definition at line 155 of file itkImplicitManifoldNormalVectorFilter.h.

◆ DataConstraint()

template<typename TInputImage , typename TSparseOutputImage >

NormalVectorType itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::DataConstraint ( const NormalVectorType & data ) const

inlineoverrideprotected

This function implements the unit norm constraint for normal vectors.

Definition at line 177 of file itkImplicitManifoldNormalVectorFilter.h.

◆ GetIsoLevelHigh()

template<typename TInputImage , typename TSparseOutputImage >

virtual NodeValueType itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::GetIsoLevelHigh ( ) const

virtual

◆ GetIsoLevelLow()

template<typename TInputImage , typename TSparseOutputImage >

virtual NodeValueType itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::GetIsoLevelLow ( ) const

virtual

◆ GetMaxIteration()

template<typename TInputImage , typename TSparseOutputImage >

virtual unsigned int itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::GetMaxIteration ( ) const

virtual

◆ GetMinVectorNorm()

template<typename TInputImage , typename TSparseOutputImage >

virtual NodeValueType itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::GetMinVectorNorm ( ) const

virtual

◆ GetNameOfClass()

template<typename TInputImage , typename TSparseOutputImage >

const char* itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ProcessObject.

◆ GetUnsharpMaskingFlag()

template<typename TInputImage , typename TSparseOutputImage >

virtual bool itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::GetUnsharpMaskingFlag ( ) const

virtual

◆ GetUnsharpMaskingWeight()

template<typename TInputImage , typename TSparseOutputImage >

virtual NodeValueType itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::GetUnsharpMaskingWeight ( ) const

virtual

◆ Halt()

template<typename TInputImage , typename TSparseOutputImage >

bool itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::Halt ( )

inlineoverrideprotectedvirtual

This is the stopping criterion function used in the iterative finite difference scheme.

Reimplemented from itk::FiniteDifferenceImageFilter< TInputImage, TSparseOutputImage >.

Definition at line 161 of file itkImplicitManifoldNormalVectorFilter.h.

◆ Initialize()

template<typename TInputImage , typename TSparseOutputImage >

void itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::Initialize ( )

overrideprotectedvirtual

This calls SetNormalBand to create the band of normals to process.

Reimplemented from itk::FiniteDifferenceImageFilter< TInputImage, TSparseOutputImage >.

◆ InitializeNormalBandNode()

template<typename TInputImage , typename TSparseOutputImage >

void itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::InitializeNormalBandNode	(	NormalBandNodeType *	node,
		const InputImageIteratorType &	it
	)

protected

This function precomputes information for normal vector processing.

◆ New()

template<typename TInputImage , typename TSparseOutputImage >

static Pointer itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::New ( )

static

Standard New macro.

◆ PostProcessOutput()

template<typename TInputImage , typename TSparseOutputImage >

void itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::PostProcessOutput ( )

overrideprotectedvirtual

This function implements unsharp masking which is turned ON/OFF by the UnsharpMaskingFlag and controlled by the UnsharpMaskingWeight parameters.

Reimplemented from itk::FiniteDifferenceImageFilter< TInputImage, TSparseOutputImage >.

◆ PrintSelf()

template<typename TInputImage , typename TSparseOutputImage >

void itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::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::ProcessObject.

◆ SetIsoLevelHigh()

template<typename TInputImage , typename TSparseOutputImage >

virtual void itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::SetIsoLevelHigh ( NodeValueType _arg )

virtual

◆ SetIsoLevelLow()

template<typename TInputImage , typename TSparseOutputImage >

virtual void itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::SetIsoLevelLow ( NodeValueType _arg )

virtual

◆ SetMaxIteration()

template<typename TInputImage , typename TSparseOutputImage >

virtual void itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::SetMaxIteration ( unsigned int _arg )

virtual

◆ SetMinVectorNorm()

template<typename TInputImage , typename TSparseOutputImage >

virtual void itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::SetMinVectorNorm ( NodeValueType _arg )

virtual

◆ SetNormalBand()

template<typename TInputImage , typename TSparseOutputImage >

void itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::SetNormalBand ( )

protected

This function sets the band for normal vector processing.

◆ SetNormalFunction()

template<typename TInputImage , typename TSparseOutputImage >

void itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::SetNormalFunction ( NormalFunctionType * nf )

This method is used to set the finite difference function.

◆ SetUnsharpMaskingFlag()

template<typename TInputImage , typename TSparseOutputImage >

virtual void itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::SetUnsharpMaskingFlag ( bool _arg )

virtual

◆ SetUnsharpMaskingWeight()

template<typename TInputImage , typename TSparseOutputImage >

virtual void itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::SetUnsharpMaskingWeight ( NodeValueType _arg )

virtual

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TSparseOutputImage >

constexpr unsigned int itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::ImageDimension = Superclass::ImageDimension

staticconstexpr

Standard get dimension macro.

Definition at line 93 of file itkImplicitManifoldNormalVectorFilter.h.

◆ m_DimConst

template<typename TInputImage , typename TSparseOutputImage >

NodeValueType itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::m_DimConst {}

private

Definition at line 212 of file itkImplicitManifoldNormalVectorFilter.h.

◆ m_DimConst2

template<typename TInputImage , typename TSparseOutputImage >

NodeValueType itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::m_DimConst2 {}

private

Definition at line 213 of file itkImplicitManifoldNormalVectorFilter.h.

◆ m_Indicator

template<typename TInputImage , typename TSparseOutputImage >

unsigned long itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::m_Indicator[Self::ImageDimension] {}

private

Constants used in computations.

Definition at line 210 of file itkImplicitManifoldNormalVectorFilter.h.

◆ m_IsoLevelHigh

template<typename TInputImage , typename TSparseOutputImage >

NodeValueType itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::m_IsoLevelHigh {}

private

Definition at line 197 of file itkImplicitManifoldNormalVectorFilter.h.

◆ m_IsoLevelLow

template<typename TInputImage , typename TSparseOutputImage >

NodeValueType itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::m_IsoLevelLow

private

The upper and lower limits of the band of the scalar image on which we operate.

Definition at line 197 of file itkImplicitManifoldNormalVectorFilter.h.

◆ m_ManifoldRadius

template<typename TInputImage , typename TSparseOutputImage >

RadiusType itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::m_ManifoldRadius {}

private

Definition at line 214 of file itkImplicitManifoldNormalVectorFilter.h.

◆ m_MaxIteration

template<typename TInputImage , typename TSparseOutputImage >

unsigned int itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::m_MaxIteration {}

private

The number of iterations this filter will execute.

Definition at line 193 of file itkImplicitManifoldNormalVectorFilter.h.

◆ m_MinVectorNorm

template<typename TInputImage , typename TSparseOutputImage >

NodeValueType itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::m_MinVectorNorm {}

private

The minimum length a vector is allowed to have to avoid divide by zero.

Definition at line 200 of file itkImplicitManifoldNormalVectorFilter.h.

◆ m_NormalFunction

template<typename TInputImage , typename TSparseOutputImage >

NormalFunctionType* itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::m_NormalFunction {}

private

The finite difference function.

Definition at line 190 of file itkImplicitManifoldNormalVectorFilter.h.

◆ m_NumVertex

template<typename TInputImage , typename TSparseOutputImage >

unsigned int itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::m_NumVertex {}

private

Definition at line 211 of file itkImplicitManifoldNormalVectorFilter.h.

◆ m_UnsharpMaskingFlag

template<typename TInputImage , typename TSparseOutputImage >

bool itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::m_UnsharpMaskingFlag {}

private

The ON/OFF switch for unsharp masking. Default is OFF.

Definition at line 203 of file itkImplicitManifoldNormalVectorFilter.h.

◆ m_UnsharpMaskingWeight

template<typename TInputImage , typename TSparseOutputImage >

NodeValueType itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::m_UnsharpMaskingWeight {}

private

The weight determining the extent of enhancement if unsharp masking is turned on.

Definition at line 207 of file itkImplicitManifoldNormalVectorFilter.h.

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

itkImplicitManifoldNormalVectorFilter.h

Detailed Description

template<typename TInputImage, typename TSparseOutputImage> class itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ InputImageIteratorType

◆ NormalBandNodeType

◆ NormalFunctionType

◆ NormalVectorType

◆ Pointer

◆ RadiusType

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ ImplicitManifoldNormalVectorFilter()

◆ ~ImplicitManifoldNormalVectorFilter()

Member Function Documentation

◆ CopyInputToOutput()

◆ DataConstraint()

◆ GetIsoLevelHigh()

◆ GetIsoLevelLow()

◆ GetMaxIteration()

◆ GetMinVectorNorm()

◆ GetNameOfClass()

◆ GetUnsharpMaskingFlag()

◆ GetUnsharpMaskingWeight()

◆ Halt()

◆ Initialize()

◆ InitializeNormalBandNode()

◆ New()

◆ PostProcessOutput()

◆ PrintSelf()

◆ SetIsoLevelHigh()

◆ SetIsoLevelLow()

◆ SetMaxIteration()

◆ SetMinVectorNorm()

◆ SetNormalBand()

◆ SetNormalFunction()

◆ SetUnsharpMaskingFlag()

◆ SetUnsharpMaskingWeight()

Member Data Documentation

◆ ImageDimension

◆ m_DimConst

◆ m_DimConst2

◆ m_Indicator

◆ m_IsoLevelHigh

◆ m_IsoLevelLow

◆ m_ManifoldRadius

◆ m_MaxIteration

◆ m_MinVectorNorm

◆ m_NormalFunction

◆ m_NumVertex

◆ m_UnsharpMaskingFlag

◆ m_UnsharpMaskingWeight

template<typename TInputImage, typename TSparseOutputImage>
class itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >