#include <itkBinaryContourImageFilter.h>

Detailed Description

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

Labels the pixels on the border of the objects in a binary image.

BinaryContourImageFilter takes a binary image as input, where the pixels in the objects are the pixels with a value equal to ForegroundValue. Only the pixels on the contours of the objects are kept. The pixels not on the border are changed to BackgroundValue.

The connectivity can be changed to minimum or maximum connectivity with SetFullyConnected(). Full connectivity produces thicker contours.

https://doi.org/10.54294/c7d3gv

Author: Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.

See also: LabelContourImageFilter BinaryErodeImageFilter SimpleContourExtractorImageFilter

ITK Sphinx Examples:

All ITK Sphinx Examples

Examples: SphinxExamples/src/Filtering/ImageLabel/ExtractBoundariesOfConnectedRegionsInBinaryImage/Code.cxx, and SphinxExamples/src/Filtering/ImageLabel/ExtractInnerAndOuterBoundariesOfBlobsInBinaryImage/Code.cxx.

Definition at line 53 of file itkBinaryContourImageFilter.h.

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

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

Public Types
using	ConstPointer = SmartPointer< const Self >

using	IndexType = typename InputImageType::IndexType

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageType = TInputImage

using	InputInternalPixelType = typename InputImageType::InternalPixelType

using	OffsetType = typename InputImageType::OffsetType

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageType = TOutputImage

using	OutputIndexType = typename OutputImageType::IndexType

using	OutputInternalPixelType = typename OutputImageType::InternalPixelType

using	OutputOffsetType = typename OutputImageType::OffsetType

using	OutputSizeType = typename OutputImageType::SizeType

using	Pointer = SmartPointer< Self >

using	RegionType = typename OutputImageType::RegionType

using	Self = BinaryContourImageFilter

using	SizeType = typename InputImageType::SizeType

using	Superclass = InPlaceImageFilter< TInputImage, TOutputImage >

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

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


virtual void	SetFullyConnected (bool _arg)

virtual const bool &	GetFullyConnected () const

virtual void	FullyConnectedOn ()


virtual void	SetBackgroundValue (OutputImagePixelType _arg)

virtual OutputImagePixelType	GetBackgroundValue () const


virtual void	SetForegroundValue (InputImagePixelType _arg)

virtual InputImagePixelType	GetForegroundValue () const

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

virtual void	SetInPlace (bool _arg)

virtual bool	GetInPlace () const

virtual void	InPlaceOn ()

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

Static Public Attributes inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int	InputImageDimension = 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	ConsecutiveVectorType = typename ScanlineFunctions::ConsecutiveVectorType

using	InternalLabelType = typename ScanlineFunctions::InternalLabelType

using	LineEncodingConstIterator = typename ScanlineFunctions::LineEncodingConstIterator

using	LineEncodingIterator = typename ScanlineFunctions::LineEncodingIterator

using	LineEncodingType = typename ScanlineFunctions::LineEncodingType

using	LineMapType = typename ScanlineFunctions::LineMapType

using	OffsetVectorConstIterator = typename ScanlineFunctions::OffsetVectorConstIterator

using	OffsetVectorType = typename ScanlineFunctions::OffsetVectorType

using	OutSizeType = typename ScanlineFunctions::OutSizeType

using	RunLength = typename ScanlineFunctions::RunLength

using	ScanlineFunctions = ScanlineFilterCommon< TInputImage, TOutputImage >

using	UnionFindType = typename ScanlineFunctions::UnionFindType

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 Types inherited from itk::ScanlineFilterCommon< TInputImage, TOutputImage >
using	CompareLinesCallback = std::function< void(const LineEncodingConstIterator &currentRun, const LineEncodingConstIterator &neighborRun, OffsetValueType oStart, OffsetValueType oLast)>

using	ConsecutiveVectorType = std::vector< OutputPixelType >

using	InternalLabelType = SizeValueType

using	LineEncodingConstIterator = typename LineEncodingType::const_iterator

using	LineEncodingIterator = typename LineEncodingType::iterator

using	LineEncodingType = std::vector< RunLength >

using	LineMapType = std::vector< LineEncodingType >

using	OffsetVectorConstIterator = typename OffsetVectorType::const_iterator

using	OffsetVectorType = std::vector< OffsetValueType >

using	OutSizeType = typename TOutputImage::RegionType::SizeType

using	UnionFindType = std::vector< InternalLabelType >

using	ConstPointer = SmartPointer< const Self >

using	EnclosingFilter = ImageToImageFilter< TInputImage, TOutputImage >

using	IndexType = typename TInputImage::IndexType

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageType = TInputImage

using	InputPixelType = typename TInputImage::PixelType

using	OffsetType = typename TInputImage::OffsetType

using	OutputImagePixelType = typename TOutputImage::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageType = TOutputImage

using	OutputIndexType = typename TOutputImage::IndexType

using	OutputOffsetType = typename TOutputImage::OffsetType

using	OutputPixelType = typename TOutputImage::PixelType

using	OutputRegionType = typename TOutputImage::RegionType

using	OutputSizeType = typename TOutputImage::SizeType

using	Pointer = SmartPointer< Self >

using	RegionType = OutputRegionType

using	Self = ScanlineFilterCommon

using	SizeType = typename TInputImage::SizeType

Protected Member Functions
void	AfterThreadedGenerateData () override

void	BeforeThreadedGenerateData () override

	BinaryContourImageFilter ()

void	DynamicThreadedGenerateData (const RegionType &outputRegionForThread) override

void	EnlargeOutputRequestedRegion (DataObject *) override

void	GenerateData () override

void	GenerateInputRequestedRegion () override

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

void	ThreadedIntegrateData (const RegionType &outputRegionForThread)

	~BinaryContourImageFilter () override=default

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

	InPlaceImageFilter ()=default

void	ReleaseInputs () override

	~InPlaceImageFilter () override=default

void	AllocateOutputs () override

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

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

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

Protected Member Functions inherited from itk::ScanlineFilterCommon< TInputImage, TOutputImage >
bool	CheckNeighbors (const OutputIndexType &A, const OutputIndexType &B) const

void	CompareLines (const LineEncodingType &current, const LineEncodingType &Neighbour, bool sameLineOffset, bool labelCompare, OutputPixelType background, CompareLinesCallback callback)

void	ComputeEquivalence (const SizeValueType workUnitResultsIndex, bool strictlyLess)

SizeValueType	CreateConsecutive (OutputPixelType backgroundValue)

WorkUnitData	CreateWorkUnitData (const RegionType &outputRegionForThread)

SizeValueType	IndexToLinearIndex (const IndexType &index) const

void	InitUnion (InternalLabelType numberOfLabels)

void	LinkLabels (const InternalLabelType label1, const InternalLabelType label2)

InternalLabelType	LookupSet (const InternalLabelType label)

void	SetupLineOffsets (bool wholeNeighborhood)

void	Register () const

	ScanlineFilterCommon (EnclosingFilter *enclosingFilter)

void	UnRegister () const noexcept

	~ScanlineFilterCommon ()=default

Private Attributes
LineMapType	m_BackgroundLineMap {}

OutputImagePixelType	m_BackgroundValue {}

LineMapType	m_ForegroundLineMap {}

InputImagePixelType	m_ForegroundValue {}

Additional Inherited Members
Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Static Protected Member Functions inherited from itk::ScanlineFilterCommon< TInputImage, TOutputImage >
static Pointer	New ()

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

Protected Attributes inherited from itk::ScanlineFilterCommon< TInputImage, TOutputImage >
ConsecutiveVectorType	m_Consecutive

WeakPointer< EnclosingFilter >	m_EnclosingFilter

bool	m_FullyConnected { false }

LineMapType	m_LineMap

OffsetVectorType	m_LineOffsets

std::mutex	m_Mutex

std::atomic< SizeValueType >	m_NumberOfLabels

UnionFindType	m_UnionFind

std::deque< WorkUnitData >	m_WorkUnitResults

Static Protected Attributes inherited from itk::ScanlineFilterCommon< TInputImage, TOutputImage >
static constexpr unsigned int	ImageDimension = TOutputImage::ImageDimension

static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension

static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Member Typedef Documentation

◆ ConsecutiveVectorType

template<typename TInputImage , typename TOutputImage >

using itk::BinaryContourImageFilter< TInputImage, TOutputImage >::ConsecutiveVectorType = typename ScanlineFunctions::ConsecutiveVectorType

protected

Definition at line 176 of file itkBinaryContourImageFilter.h.

◆ ConstPointer

template<typename TInputImage , typename TOutputImage >

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

Definition at line 66 of file itkBinaryContourImageFilter.h.

◆ IndexType

template<typename TInputImage , typename TOutputImage >

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

Definition at line 86 of file itkBinaryContourImageFilter.h.

◆ InputImageConstPointer

template<typename TInputImage , typename TOutputImage >

using itk::BinaryContourImageFilter< TInputImage, TOutputImage >::InputImageConstPointer = typename InputImageType::ConstPointer

Definition at line 85 of file itkBinaryContourImageFilter.h.

◆ InputImagePixelType

template<typename TInputImage , typename TOutputImage >

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

Definition at line 89 of file itkBinaryContourImageFilter.h.

◆ InputImagePointer

template<typename TInputImage , typename TOutputImage >

using itk::BinaryContourImageFilter< TInputImage, TOutputImage >::InputImagePointer = typename InputImageType::Pointer

Definition at line 84 of file itkBinaryContourImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TOutputImage >

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

Image type alias support

Definition at line 83 of file itkBinaryContourImageFilter.h.

◆ InputInternalPixelType

template<typename TInputImage , typename TOutputImage >

using itk::BinaryContourImageFilter< TInputImage, TOutputImage >::InputInternalPixelType = typename InputImageType::InternalPixelType

Definition at line 90 of file itkBinaryContourImageFilter.h.

◆ InternalLabelType

template<typename TInputImage , typename TOutputImage >

using itk::BinaryContourImageFilter< TInputImage, TOutputImage >::InternalLabelType = typename ScanlineFunctions::InternalLabelType

protected

Definition at line 166 of file itkBinaryContourImageFilter.h.

◆ LineEncodingConstIterator

template<typename TInputImage , typename TOutputImage >

using itk::BinaryContourImageFilter< TInputImage, TOutputImage >::LineEncodingConstIterator = typename ScanlineFunctions::LineEncodingConstIterator

protected

Definition at line 171 of file itkBinaryContourImageFilter.h.

◆ LineEncodingIterator

template<typename TInputImage , typename TOutputImage >

using itk::BinaryContourImageFilter< TInputImage, TOutputImage >::LineEncodingIterator = typename ScanlineFunctions::LineEncodingIterator

protected

Definition at line 170 of file itkBinaryContourImageFilter.h.

◆ LineEncodingType

template<typename TInputImage , typename TOutputImage >

using itk::BinaryContourImageFilter< TInputImage, TOutputImage >::LineEncodingType = typename ScanlineFunctions::LineEncodingType

protected

Definition at line 169 of file itkBinaryContourImageFilter.h.

◆ LineMapType

template<typename TInputImage , typename TOutputImage >

using itk::BinaryContourImageFilter< TInputImage, TOutputImage >::LineMapType = typename ScanlineFunctions::LineMapType

protected

Definition at line 174 of file itkBinaryContourImageFilter.h.

◆ OffsetType

template<typename TInputImage , typename TOutputImage >

using itk::BinaryContourImageFilter< TInputImage, TOutputImage >::OffsetType = typename InputImageType::OffsetType

Definition at line 88 of file itkBinaryContourImageFilter.h.

◆ OffsetVectorConstIterator

template<typename TInputImage , typename TOutputImage >

using itk::BinaryContourImageFilter< TInputImage, TOutputImage >::OffsetVectorConstIterator = typename ScanlineFunctions::OffsetVectorConstIterator

protected

Definition at line 173 of file itkBinaryContourImageFilter.h.

◆ OffsetVectorType

template<typename TInputImage , typename TOutputImage >

using itk::BinaryContourImageFilter< TInputImage, TOutputImage >::OffsetVectorType = typename ScanlineFunctions::OffsetVectorType

protected

Definition at line 172 of file itkBinaryContourImageFilter.h.

◆ OutputImagePixelType

template<typename TInputImage , typename TOutputImage >

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

Definition at line 98 of file itkBinaryContourImageFilter.h.

◆ OutputImagePointer

template<typename TInputImage , typename TOutputImage >

using itk::BinaryContourImageFilter< TInputImage, TOutputImage >::OutputImagePointer = typename OutputImageType::Pointer

Definition at line 93 of file itkBinaryContourImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TOutputImage >

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

Definition at line 92 of file itkBinaryContourImageFilter.h.

◆ OutputIndexType

template<typename TInputImage , typename TOutputImage >

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

Definition at line 95 of file itkBinaryContourImageFilter.h.

◆ OutputInternalPixelType

template<typename TInputImage , typename TOutputImage >

using itk::BinaryContourImageFilter< TInputImage, TOutputImage >::OutputInternalPixelType = typename OutputImageType::InternalPixelType

Definition at line 99 of file itkBinaryContourImageFilter.h.

◆ OutputOffsetType

template<typename TInputImage , typename TOutputImage >

using itk::BinaryContourImageFilter< TInputImage, TOutputImage >::OutputOffsetType = typename OutputImageType::OffsetType

Definition at line 97 of file itkBinaryContourImageFilter.h.

◆ OutputSizeType

template<typename TInputImage , typename TOutputImage >

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

Definition at line 96 of file itkBinaryContourImageFilter.h.

◆ OutSizeType

template<typename TInputImage , typename TOutputImage >

using itk::BinaryContourImageFilter< TInputImage, TOutputImage >::OutSizeType = typename ScanlineFunctions::OutSizeType

protected

Definition at line 167 of file itkBinaryContourImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage >

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

Definition at line 65 of file itkBinaryContourImageFilter.h.

◆ RegionType

template<typename TInputImage , typename TOutputImage >

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

Definition at line 94 of file itkBinaryContourImageFilter.h.

◆ RunLength

template<typename TInputImage , typename TOutputImage >

using itk::BinaryContourImageFilter< TInputImage, TOutputImage >::RunLength = typename ScanlineFunctions::RunLength

protected

Definition at line 168 of file itkBinaryContourImageFilter.h.

◆ ScanlineFunctions

template<typename TInputImage , typename TOutputImage >

using itk::BinaryContourImageFilter< TInputImage, TOutputImage >::ScanlineFunctions = ScanlineFilterCommon<TInputImage, TOutputImage>

protected

Definition at line 164 of file itkBinaryContourImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage >

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

Standard "Self" & Superclass typedef.

Definition at line 63 of file itkBinaryContourImageFilter.h.

◆ SizeType

template<typename TInputImage , typename TOutputImage >

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

Definition at line 87 of file itkBinaryContourImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage >

using itk::BinaryContourImageFilter< TInputImage, TOutputImage >::Superclass = InPlaceImageFilter<TInputImage, TOutputImage>

Definition at line 64 of file itkBinaryContourImageFilter.h.

◆ UnionFindType

template<typename TInputImage , typename TOutputImage >

using itk::BinaryContourImageFilter< TInputImage, TOutputImage >::UnionFindType = typename ScanlineFunctions::UnionFindType

protected

Definition at line 175 of file itkBinaryContourImageFilter.h.

Constructor & Destructor Documentation

◆ BinaryContourImageFilter()

template<typename TInputImage , typename TOutputImage >

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

protected

◆ ~BinaryContourImageFilter()

template<typename TInputImage , typename TOutputImage >

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

overrideprotecteddefault

Member Function Documentation

◆ AfterThreadedGenerateData()

template<typename TInputImage , typename TOutputImage >

void itk::BinaryContourImageFilter< TInputImage, TOutputImage >::AfterThreadedGenerateData ( )

overrideprotectedvirtual

If an imaging filter needs to perform processing after all processing threads have completed, the filter can can provide an implementation for AfterThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Reimplemented from itk::ImageSource< TOutputImage >.

◆ BeforeThreadedGenerateData()

template<typename TInputImage , typename TOutputImage >

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

overrideprotectedvirtual

If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Reimplemented from itk::ImageSource< TOutputImage >.

◆ DynamicThreadedGenerateData()

template<typename TInputImage , typename TOutputImage >

void itk::BinaryContourImageFilter< TInputImage, TOutputImage >::DynamicThreadedGenerateData ( const RegionType & outputRegionForThread )

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

◆ EnlargeOutputRequestedRegion()

template<typename TInputImage , typename TOutputImage >

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

overrideprotectedvirtual

BinaryContourImageFilter will produce all of the output. Therefore it must provide an implementation of EnlargeOutputRequestedRegion().

See also: ProcessObject::EnlargeOutputRequestedRegion()

Reimplemented from itk::ProcessObject.

◆ FullyConnectedOn()

template<typename TInputImage , typename TOutputImage >

virtual void itk::BinaryContourImageFilter< TInputImage, TOutputImage >::FullyConnectedOn ( )

virtual

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

◆ GenerateData()

template<typename TInputImage , typename TOutputImage >

void itk::BinaryContourImageFilter< 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::BinaryContourImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( )

overrideprotectedvirtual

BinaryContourImageFilter needs the entire input. Therefore it must provide an implementation GenerateInputRequestedRegion().

See also: ProcessObject::GenerateInputRequestedRegion().

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

◆ GetBackgroundValue()

template<typename TInputImage , typename TOutputImage >

virtual OutputImagePixelType itk::BinaryContourImageFilter< TInputImage, TOutputImage >::GetBackgroundValue ( ) const

virtual

Set/Get the background value used to mark the pixels not on the border of the objects.

◆ GetForegroundValue()

template<typename TInputImage , typename TOutputImage >

virtual InputImagePixelType itk::BinaryContourImageFilter< TInputImage, TOutputImage >::GetForegroundValue ( ) const

virtual

Set/Get the foreground value used to identify the objects in the input and output images.

◆ GetFullyConnected()

template<typename TInputImage , typename TOutputImage >

virtual const bool& itk::BinaryContourImageFilter< TInputImage, TOutputImage >::GetFullyConnected ( ) const

virtual

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage >

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

overridevirtual

Run-time type information (and related methods)

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

◆ New()

template<typename TInputImage , typename TOutputImage >

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

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage >

void itk::BinaryContourImageFilter< 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::InPlaceImageFilter< TInputImage, TOutputImage >.

◆ SetBackgroundValue()

template<typename TInputImage , typename TOutputImage >

virtual void itk::BinaryContourImageFilter< TInputImage, TOutputImage >::SetBackgroundValue ( OutputImagePixelType _arg )

virtual

Set/Get the background value used to mark the pixels not on the border of the objects.

◆ SetForegroundValue()

template<typename TInputImage , typename TOutputImage >

virtual void itk::BinaryContourImageFilter< TInputImage, TOutputImage >::SetForegroundValue ( InputImagePixelType _arg )

virtual

Set/Get the foreground value used to identify the objects in the input and output images.

◆ SetFullyConnected()

template<typename TInputImage , typename TOutputImage >

virtual void itk::BinaryContourImageFilter< TInputImage, TOutputImage >::SetFullyConnected ( bool _arg )

virtual

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

◆ ThreadedIntegrateData()

template<typename TInputImage , typename TOutputImage >

void itk::BinaryContourImageFilter< TInputImage, TOutputImage >::ThreadedIntegrateData ( const RegionType & outputRegionForThread )

protected

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TOutputImage >

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

staticconstexpr

Definition at line 101 of file itkBinaryContourImageFilter.h.

◆ m_BackgroundLineMap

template<typename TInputImage , typename TOutputImage >

LineMapType itk::BinaryContourImageFilter< TInputImage, TOutputImage >::m_BackgroundLineMap {}

private

Definition at line 180 of file itkBinaryContourImageFilter.h.

◆ m_BackgroundValue

template<typename TInputImage , typename TOutputImage >

OutputImagePixelType itk::BinaryContourImageFilter< TInputImage, TOutputImage >::m_BackgroundValue {}

private

Definition at line 183 of file itkBinaryContourImageFilter.h.

◆ m_ForegroundLineMap

template<typename TInputImage , typename TOutputImage >

LineMapType itk::BinaryContourImageFilter< TInputImage, TOutputImage >::m_ForegroundLineMap {}

private

Definition at line 179 of file itkBinaryContourImageFilter.h.

◆ m_ForegroundValue

template<typename TInputImage , typename TOutputImage >

InputImagePixelType itk::BinaryContourImageFilter< TInputImage, TOutputImage >::m_ForegroundValue {}

private

Definition at line 182 of file itkBinaryContourImageFilter.h.

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

itkBinaryContourImageFilter.h

Detailed Description

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConsecutiveVectorType

◆ ConstPointer

◆ IndexType

◆ InputImageConstPointer

◆ InputImagePixelType

◆ InputImagePointer

◆ InputImageType

◆ InputInternalPixelType

◆ InternalLabelType

◆ LineEncodingConstIterator

◆ LineEncodingIterator

◆ LineEncodingType

◆ LineMapType

◆ OffsetType

◆ OffsetVectorConstIterator

◆ OffsetVectorType

◆ OutputImagePixelType

◆ OutputImagePointer

◆ OutputImageType

◆ OutputIndexType

◆ OutputInternalPixelType

◆ OutputOffsetType

◆ OutputSizeType

◆ OutSizeType

◆ Pointer

◆ RegionType

◆ RunLength

◆ ScanlineFunctions

◆ Self

◆ SizeType

◆ Superclass

◆ UnionFindType

Constructor & Destructor Documentation

◆ BinaryContourImageFilter()

◆ ~BinaryContourImageFilter()

Member Function Documentation

◆ AfterThreadedGenerateData()

◆ BeforeThreadedGenerateData()

◆ DynamicThreadedGenerateData()

◆ EnlargeOutputRequestedRegion()

◆ FullyConnectedOn()

◆ GenerateData()

◆ GenerateInputRequestedRegion()

◆ GetBackgroundValue()

◆ GetForegroundValue()

◆ GetFullyConnected()

◆ GetNameOfClass()

◆ New()

◆ PrintSelf()

◆ SetBackgroundValue()

◆ SetForegroundValue()

◆ SetFullyConnected()

◆ ThreadedIntegrateData()

Member Data Documentation

◆ ImageDimension

◆ m_BackgroundLineMap

◆ m_BackgroundValue

◆ m_ForegroundLineMap

◆ m_ForegroundValue

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