#include <itkIsoContourDistanceImageFilter.h>

Detailed Description

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

Compute an approximate distance from an interpolated isocontour to the close grid points.

For standard level set algorithms, it is useful to periodically reinitialize the evolving image to prevent numerical accuracy problems in computing derivatives. This reinitialization is done by computing a signed distance map to the current level set. This class provides the first step in this reinitialization by computing an estimate of the distance from the interpolated isocontour to the pixels (or voxels) that are close to it, i.e. for which the isocontour crosses a segment between them and one of their direct neighbors. This class supports narrowbanding. If the input narrowband is provided, the algorithm will only locate the level set within the input narrowband.

Implementation of this class is based on Fast and Accurate Redistancing for Level Set Methods ‘Krissian K. and Westin C.F.’, EUROCAST NeuroImaging Workshop Las Palmas Spain, Ninth International Conference on Computer Aided Systems Theory , pages 48-51, Feb 2003.

Definition at line 59 of file itkIsoContourDistanceImageFilter.h.

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

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

Public Types
using	BandIterator = typename NarrowBandType::Iterator

using	BandNodeType = BandNode< IndexType, PixelType >

using	ConstBandIterator = typename NarrowBandType::ConstIterator

using	ConstPointer = SmartPointer< const Self >

using	IndexType = typename OutputImageType::IndexType

using	InputIndexType = typename InputImageType::IndexType

using	InputPixelType = typename InputImageType::PixelType

using	InputSizeType = typename InputImageType::SizeType

using	InputSpacingType = typename InputImageType::SpacingType

using	NarrowBandPointer = typename NarrowBandType::Pointer

using	NarrowBandType = NarrowBand< BandNodeType >

using	OutputImageRegionType = typename OutputImageType::RegionType

using	PixelRealType = typename NumericTraits< InputPixelType >::RealType

using	PixelType = typename OutputImageType::PixelType

using	Pointer = SmartPointer< Self >

using	RegionType = typename NarrowBandType::RegionType

using	Self = IsoContourDistanceImageFilter

using	SizeType = typename OutputImageType::SizeType

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
const char *	GetNameOfClass () const override

NarrowBandPointer	GetNarrowBand () const

void	SetNarrowBand (NarrowBandType *ptr)


virtual void	SetLevelSetValue (PixelRealType _arg)

virtual PixelRealType	GetLevelSetValue () const


virtual void	SetFarValue (PixelType _arg)

virtual PixelType	GetFarValue () const


virtual void	SetNarrowBanding (bool _arg)

virtual bool	GetNarrowBanding () const

virtual void	NarrowBandingOn ()

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	InputNeighbordIteratorType = ConstNeighborhoodIterator< InputImageType >

using	OutputNeighborhoodIteratorType = NeighborhoodIterator< 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
void	BeforeThreadedGenerateData () override

void	ComputeValue (const InputNeighbordIteratorType &inNeigIt, OutputNeighborhoodIteratorType &outNeigIt, unsigned int center, const std::vector< OffsetValueType > &stride)

void	DynamicThreadedGenerateData (const OutputImageRegionType &) override

void	EnlargeOutputRequestedRegion (DataObject *) override

void	GenerateData () override

void	GenerateInputRequestedRegion () override

	IsoContourDistanceImageFilter ()

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

void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId) override

void	ThreadedGenerateDataBand (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)

void	ThreadedGenerateDataFull (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)

	~IsoContourDistanceImageFilter () override=default

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

Static Protected Member Functions
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderFullCallback (void *arg)

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)

Private Attributes
PixelType	m_FarValue {}

PixelRealType	m_LevelSetValue {}

std::mutex	m_Mutex {}

NarrowBandPointer	m_NarrowBand {}

bool	m_NarrowBanding {}

std::vector< RegionType >	m_NarrowBandRegion {}

InputSpacingType	m_Spacing {}

Additional Inherited Members
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

◆ BandIterator

template<typename TInputImage , typename TOutputImage >

using itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::BandIterator = typename NarrowBandType::Iterator

Definition at line 107 of file itkIsoContourDistanceImageFilter.h.

◆ BandNodeType

template<typename TInputImage , typename TOutputImage >

using itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::BandNodeType = BandNode<IndexType, PixelType>

NarrowBand type alias support

Definition at line 102 of file itkIsoContourDistanceImageFilter.h.

◆ ConstBandIterator

template<typename TInputImage , typename TOutputImage >

using itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::ConstBandIterator = typename NarrowBandType::ConstIterator

Definition at line 106 of file itkIsoContourDistanceImageFilter.h.

◆ ConstPointer

template<typename TInputImage , typename TOutputImage >

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

Definition at line 68 of file itkIsoContourDistanceImageFilter.h.

◆ IndexType

template<typename TInputImage , typename TOutputImage >

using itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::IndexType = typename OutputImageType::IndexType

Definition at line 97 of file itkIsoContourDistanceImageFilter.h.

◆ InputIndexType

template<typename TInputImage , typename TOutputImage >

using itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::InputIndexType = typename InputImageType::IndexType

Definition at line 96 of file itkIsoContourDistanceImageFilter.h.

◆ InputNeighbordIteratorType

template<typename TInputImage , typename TOutputImage >

using itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::InputNeighbordIteratorType = ConstNeighborhoodIterator<InputImageType>

protected

Definition at line 188 of file itkIsoContourDistanceImageFilter.h.

◆ InputPixelType

template<typename TInputImage , typename TOutputImage >

using itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::InputPixelType = typename InputImageType::PixelType

Definition at line 88 of file itkIsoContourDistanceImageFilter.h.

◆ InputSizeType

template<typename TInputImage , typename TOutputImage >

using itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::InputSizeType = typename InputImageType::SizeType

Definition at line 93 of file itkIsoContourDistanceImageFilter.h.

◆ InputSpacingType

template<typename TInputImage , typename TOutputImage >

using itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::InputSpacingType = typename InputImageType::SpacingType

Definition at line 99 of file itkIsoContourDistanceImageFilter.h.

◆ NarrowBandPointer

template<typename TInputImage , typename TOutputImage >

using itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::NarrowBandPointer = typename NarrowBandType::Pointer

Definition at line 104 of file itkIsoContourDistanceImageFilter.h.

◆ NarrowBandType

template<typename TInputImage , typename TOutputImage >

using itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::NarrowBandType = NarrowBand<BandNodeType>

Definition at line 103 of file itkIsoContourDistanceImageFilter.h.

◆ OutputImageRegionType

template<typename TInputImage , typename TOutputImage >

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

Definition at line 91 of file itkIsoContourDistanceImageFilter.h.

◆ OutputNeighborhoodIteratorType

template<typename TInputImage , typename TOutputImage >

using itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::OutputNeighborhoodIteratorType = NeighborhoodIterator<OutputImageType>

protected

Definition at line 189 of file itkIsoContourDistanceImageFilter.h.

◆ PixelRealType

template<typename TInputImage , typename TOutputImage >

using itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::PixelRealType = typename NumericTraits<InputPixelType>::RealType

Definition at line 89 of file itkIsoContourDistanceImageFilter.h.

◆ PixelType

template<typename TInputImage , typename TOutputImage >

using itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::PixelType = typename OutputImageType::PixelType

The pixel type of the output image will be used in computations. Inherited from the superclass.

Definition at line 87 of file itkIsoContourDistanceImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage >

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

Definition at line 67 of file itkIsoContourDistanceImageFilter.h.

◆ RegionType

template<typename TInputImage , typename TOutputImage >

using itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::RegionType = typename NarrowBandType::RegionType

Definition at line 105 of file itkIsoContourDistanceImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage >

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

Standard class type aliases.

Definition at line 65 of file itkIsoContourDistanceImageFilter.h.

◆ SizeType

template<typename TInputImage , typename TOutputImage >

using itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::SizeType = typename OutputImageType::SizeType

Definition at line 94 of file itkIsoContourDistanceImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage >

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

Definition at line 66 of file itkIsoContourDistanceImageFilter.h.

Constructor & Destructor Documentation

◆ IsoContourDistanceImageFilter()

template<typename TInputImage , typename TOutputImage >

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

protected

◆ ~IsoContourDistanceImageFilter()

template<typename TInputImage , typename TOutputImage >

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

overrideprotecteddefault

Member Function Documentation

◆ BeforeThreadedGenerateData()

template<typename TInputImage , typename TOutputImage >

void itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData ( )

overrideprotectedvirtual

Split the band if the narrowband mode is used.

Reimplemented from itk::ImageSource< TOutputImage >.

◆ ComputeValue()

template<typename TInputImage , typename TOutputImage >

void itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::ComputeValue	(	const InputNeighbordIteratorType &	inNeigIt,
		OutputNeighborhoodIteratorType &	outNeigIt,
		unsigned int	center,
		const std::vector< OffsetValueType > &	stride
	)

protected

◆ DynamicThreadedGenerateData()

template<typename TInputImage , typename TOutputImage >

void itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::DynamicThreadedGenerateData ( const OutputImageRegionType & outputRegionForThread )

inlineoverrideprotectedvirtual

If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData() or DynamicThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call (Dynamic)ThreadedGenerateData() in each thread. Prior to spawning threads, the BeforeThreadedGenerateData() method is called. After all the threads have completed, the AfterThreadedGenerateData() method is called. If an image processing filter cannot support threading, that filter should provide an implementation of the GenerateData() method instead of providing an implementation of (Dynamic)ThreadedGenerateData(). If a filter provides a GenerateData() method as its implementation, then the filter is responsible for allocating the output data. If a filter provides a (Dynamic)ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The (Dynamic)ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. (Dynamic)ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).

DynamicThreadedGenerateData() is the newer variant without threadId, and is the preferred signature, which is called by default. This variant can split the requested region into different number of pieces depending on current multi-processing load, which allows better load balancing. The non-dynamic (also known as classic) ThreadedGenerateData() signature has threadId, and number of pieces to be split into is known in advance. It is activated by calling this->DynamicMultiThreadingOff(); in derived class constructor. It should be used when the multi-threaded algorithm needs to pre-allocate some data structure with size dependent on the number of pieces (also known as chunks, work units, and sometimes also incorrectly as threads). Only PlatformMultiThreader guarantees that each piece will be processed in its own specific thread. Pool and TBB multi-threaders maintain a pool of threads (normally equal to number of processing cores) which they use to process the pieces. This normally results in a single thread being reused to process multiple work units.

See also: GenerateData(), SplitRequestedRegion()

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 161 of file itkIsoContourDistanceImageFilter.h.

◆ EnlargeOutputRequestedRegion()

template<typename TInputImage , typename TOutputImage >

void itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::EnlargeOutputRequestedRegion ( DataObject * )

overrideprotectedvirtual

Give the process object a chance to indicate that it will produce more output than it was requested to produce. For example, many imaging filters must compute the entire output at once or can only produce output in complete slices. Such filters cannot handle smaller requested regions. These filters must provide an implementation of this method, setting the output requested region to the size they will produce. By default, a process object does not modify the size of the output requested region.

Reimplemented from itk::ProcessObject.

◆ GenerateData()

template<typename TInputImage , typename TOutputImage >

void itk::IsoContourDistanceImageFilter< 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 >.

◆ GenerateInputRequestedRegion()

template<typename TInputImage , typename TOutputImage >

void itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( )

overrideprotectedvirtual

What is the input requested region that is required to produce the output requested region? The base assumption for image processing filters is that the input requested region can be set to match the output requested region. If a filter requires more input (for instance a filter that uses neighborhoods needs more input than output to avoid introducing artificial boundary conditions) or less input (for instance a magnify filter) will have to override this method. In doing so, it should call its superclass' implementation as its first step. Note that imaging filters operate differently than the classes to this point in the class hierarchy. Up till now, the base assumption has been that the largest possible region will be requested of the input.

This implementation of GenerateInputRequestedRegion() only processes the inputs that are a subclass of the ImageBase<InputImageDimension>. If an input is another type of DataObject (including an Image of a different dimension), they are skipped by this method. The subclasses of ImageToImageFilter are responsible for providing an implementation of GenerateInputRequestedRegion() when there are multiple inputs of different types.

See also: ProcessObject::GenerateInputRequestedRegion(), ImageSource::GenerateInputRequestedRegion()

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

◆ GetFarValue()

template<typename TInputImage , typename TOutputImage >

virtual PixelType itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::GetFarValue ( ) const

virtual

Set/Get the value of the level set to be located. The default value is 0.

◆ GetLevelSetValue()

template<typename TInputImage , typename TOutputImage >

virtual PixelRealType itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::GetLevelSetValue ( ) const

virtual

Set/Get the value of the level set to be located. The default value is 0.

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage >

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

overridevirtual

See also: LightObject::GetNameOfClass()

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

◆ GetNarrowBand()

template<typename TInputImage , typename TOutputImage >

NarrowBandPointer itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::GetNarrowBand ( ) const

inline

Definition at line 133 of file itkIsoContourDistanceImageFilter.h.

◆ GetNarrowBanding()

template<typename TInputImage , typename TOutputImage >

virtual bool itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::GetNarrowBanding ( ) const

virtual

Set/Get the narrowbanding flag. By default, narrowbanding is switched off.

◆ NarrowBandingOn()

template<typename TInputImage , typename TOutputImage >

virtual void itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::NarrowBandingOn ( )

virtual

Set/Get the narrowbanding flag. By default, narrowbanding is switched off.

◆ New()

template<typename TInputImage , typename TOutputImage >

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

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage >

void itk::IsoContourDistanceImageFilter< 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 >.

◆ SetFarValue()

template<typename TInputImage , typename TOutputImage >

virtual void itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::SetFarValue ( PixelType _arg )

virtual

Set/Get the value of the level set to be located. The default value is 0.

◆ SetLevelSetValue()

template<typename TInputImage , typename TOutputImage >

virtual void itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::SetLevelSetValue ( PixelRealType _arg )

virtual

Set/Get the value of the level set to be located. The default value is 0.

◆ SetNarrowBand()

template<typename TInputImage , typename TOutputImage >

void itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::SetNarrowBand ( NarrowBandType * ptr )

Set/Get the narrowband.

◆ SetNarrowBanding()

template<typename TInputImage , typename TOutputImage >

virtual void itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::SetNarrowBanding ( bool _arg )

virtual

Set/Get the narrowbanding flag. By default, narrowbanding is switched off.

◆ ThreadedGenerateData()

template<typename TInputImage , typename TOutputImage >

void itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData	(	const OutputImageRegionType &	region,
		ThreadIdType	threadId
	)

overrideprotectedvirtual

If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData() or DynamicThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call (Dynamic)ThreadedGenerateData() in each thread. Prior to spawning threads, the BeforeThreadedGenerateData() method is called. After all the threads have completed, the AfterThreadedGenerateData() method is called. If an image processing filter cannot support threading, that filter should provide an implementation of the GenerateData() method instead of providing an implementation of (Dynamic)ThreadedGenerateData(). If a filter provides a GenerateData() method as its implementation, then the filter is responsible for allocating the output data. If a filter provides a (Dynamic)ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The (Dynamic)ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. (Dynamic)ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).

DynamicThreadedGenerateData() is the newer variant without threadId, and is the preferred signature, which is called by default. This variant can split the requested region into different number of pieces depending on current multi-processing load, which allows better load balancing. The non-dynamic (also known as classic) ThreadedGenerateData() signature has threadId, and number of pieces to be split into is known in advance. It is activated by calling this->DynamicMultiThreadingOff(); in derived class constructor. It should be used when the multi-threaded algorithm needs to pre-allocate some data structure with size dependent on the number of pieces (also known as chunks, work units, and sometimes also incorrectly as threads). Only PlatformMultiThreader guarantees that each piece will be processed in its own specific thread. Pool and TBB multi-threaders maintain a pool of threads (normally equal to number of processing cores) which they use to process the pieces. This normally results in a single thread being reused to process multiple work units.

See also: GenerateData(), SplitRequestedRegion()

Reimplemented from itk::ImageSource< TOutputImage >.

◆ ThreadedGenerateDataBand()

template<typename TInputImage , typename TOutputImage >

void itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::ThreadedGenerateDataBand	(	const OutputImageRegionType &	outputRegionForThread,
		ThreadIdType	threadId
	)

protected

◆ ThreadedGenerateDataFull()

template<typename TInputImage , typename TOutputImage >

void itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::ThreadedGenerateDataFull	(	const OutputImageRegionType &	outputRegionForThread,
		ThreadIdType	threadId
	)

protected

◆ ThreaderFullCallback()

template<typename TInputImage , typename TOutputImage >

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::ThreaderFullCallback ( void * arg )

staticprotected

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TOutputImage >

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

staticconstexpr

Dimensionality of input and output data is assumed to be the same. It is inherited from the superclass.

Definition at line 82 of file itkIsoContourDistanceImageFilter.h.

◆ m_FarValue

template<typename TInputImage , typename TOutputImage >

PixelType itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::m_FarValue {}

private

Definition at line 199 of file itkIsoContourDistanceImageFilter.h.

◆ m_LevelSetValue

template<typename TInputImage , typename TOutputImage >

PixelRealType itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::m_LevelSetValue {}

private

Definition at line 198 of file itkIsoContourDistanceImageFilter.h.

◆ m_Mutex

template<typename TInputImage , typename TOutputImage >

std::mutex itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::m_Mutex {}

private

Definition at line 207 of file itkIsoContourDistanceImageFilter.h.

◆ m_NarrowBand

template<typename TInputImage , typename TOutputImage >

NarrowBandPointer itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::m_NarrowBand {}

private

Definition at line 204 of file itkIsoContourDistanceImageFilter.h.

◆ m_NarrowBanding

template<typename TInputImage , typename TOutputImage >

bool itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::m_NarrowBanding {}

private

Definition at line 203 of file itkIsoContourDistanceImageFilter.h.

◆ m_NarrowBandRegion

template<typename TInputImage , typename TOutputImage >

std::vector<RegionType> itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::m_NarrowBandRegion {}

private

Definition at line 205 of file itkIsoContourDistanceImageFilter.h.

◆ m_Spacing

template<typename TInputImage , typename TOutputImage >

InputSpacingType itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::m_Spacing {}

private

Definition at line 201 of file itkIsoContourDistanceImageFilter.h.

◆ OutputImageDimension

template<typename TInputImage , typename TOutputImage >

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

staticconstexpr

Definition at line 83 of file itkIsoContourDistanceImageFilter.h.

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

itkIsoContourDistanceImageFilter.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ BandIterator

◆ BandNodeType

◆ ConstBandIterator

◆ ConstPointer

◆ IndexType

◆ InputIndexType

◆ InputNeighbordIteratorType

◆ InputPixelType

◆ InputSizeType

◆ InputSpacingType

◆ NarrowBandPointer

◆ NarrowBandType

◆ OutputImageRegionType

◆ OutputNeighborhoodIteratorType

◆ PixelRealType

◆ PixelType

◆ Pointer

◆ RegionType

◆ Self

◆ SizeType

◆ Superclass

Constructor & Destructor Documentation

◆ IsoContourDistanceImageFilter()

◆ ~IsoContourDistanceImageFilter()

Member Function Documentation

◆ BeforeThreadedGenerateData()

◆ ComputeValue()

◆ DynamicThreadedGenerateData()

◆ EnlargeOutputRequestedRegion()

◆ GenerateData()

◆ GenerateInputRequestedRegion()

◆ GetFarValue()

◆ GetLevelSetValue()

◆ GetNameOfClass()

◆ GetNarrowBand()

◆ GetNarrowBanding()

◆ NarrowBandingOn()

◆ New()

◆ PrintSelf()

◆ SetFarValue()

◆ SetLevelSetValue()

◆ SetNarrowBand()

◆ SetNarrowBanding()

◆ ThreadedGenerateData()

◆ ThreadedGenerateDataBand()

◆ ThreadedGenerateDataFull()

◆ ThreaderFullCallback()

Member Data Documentation

◆ ImageDimension

◆ m_FarValue

◆ m_LevelSetValue

◆ m_Mutex

◆ m_NarrowBand

◆ m_NarrowBanding

◆ m_NarrowBandRegion

◆ m_Spacing

◆ OutputImageDimension