itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkIsolatedConnectedImageFilter.h>

Detailed Description

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

Label pixels that are connected to one set of seeds but not another.

IsolatedConnectedImageFilter finds the optimal threshold to separate two regions. It has two modes, one to separate dark regions surrounded by bright regions by automatically finding a minimum isolating upper threshold, and another to separate bright regions surrounded by dark regions by automatically finding a maximum lower isolating threshold. The mode can be chosen by setting FindUpperThresholdOn()/Off(). In both cases, the isolating threshold is retrieved with GetIsolatedValue().

The algorithm labels pixels with ReplaceValue that are connected to Seeds1 AND NOT connected to Seeds2. When finding the threshold to separate two dark regions surrounded by bright regions, given a fixed lower threshold, the filter adjusts the upper threshold until the two sets of seeds are not connected. The algorithm uses a binary search to adjust the upper threshold, starting at Upper. The reverse is true for finding the threshold to separate two bright regions. Lower defaults to the smallest possible value for the InputImagePixelType, and Upper defaults to the largest possible value for the InputImagePixelType.

The user can also supply the Lower and Upper values to restrict the search. However, if the range is too restrictive, it could happen that no isolating threshold can be found between the user specified Lower and Upper values. Therefore, unless the user is sure of the bounds to set, it is recommended that the user set these values to the lowest and highest intensity values in the image, respectively.

The user can specify more than one seed for both regions to separate. The algorithm will try find the threshold that ensures that all of the first seeds are contained in the resulting segmentation and all of the second seeds are not contained in the segmentation.

It is possible that the algorithm may not be able to find the isolating threshold because no such threshold exists. The user can check for this by querying the GetThresholdingFailed() flag.

Examples

Examples/Segmentation/IsolatedConnectedImageFilter.cxx.

Definition at line 72 of file itkIsolatedConnectedImageFilter.h.

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

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

Public Types
using	ConstPointer = SmartPointer<const Self>
using	InputRealType = typename NumericTraits<InputImagePixelType>::RealType
using	OutputImagePixelType = typename OutputImageType::PixelType
using	OutputImagePointer = typename OutputImageType::Pointer
using	OutputImageRegionType = typename OutputImageType::RegionType
using	OutputImageType = TOutputImage
using	Pointer = SmartPointer<Self>
using	SeedsContainerType = std::vector<IndexType>
using	Self = IsolatedConnectedImageFilter
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	OutputImagePixelType
using	OutputImageRegionType
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	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
void	AddSeed1 (const IndexType &seed)
void	AddSeed2 (const IndexType &seed)
void	ClearSeeds1 ()
void	ClearSeeds2 ()
virtual::itk::LightObject::Pointer	CreateAnother () const
virtual const InputImagePixelType &	GetIsolatedValue () const
virtual const bool &	GetThresholdingFailed () const
void	PrintSelf (std::ostream &os, Indent indent) const override
void	SetSeed1 (const IndexType &seed)
void	SetSeed2 (const IndexType &seed)
virtual void	SetSeeds1 (SeedsContainerType _arg)
virtual const SeedsContainerType &	GetSeeds1 () const
virtual void	SetSeeds2 (SeedsContainerType _arg)
virtual const SeedsContainerType &	GetSeeds2 () const
virtual void	SetLower (InputImagePixelType _arg)
virtual const InputImagePixelType &	GetLower () const
virtual void	SetUpper (InputImagePixelType _arg)
virtual const InputImagePixelType &	GetUpper () const
virtual void	SetIsolatedValueTolerance (InputImagePixelType _arg)
virtual const InputImagePixelType &	GetIsolatedValueTolerance () const
virtual void	SetReplaceValue (OutputImagePixelType _arg)
virtual const OutputImagePixelType &	GetReplaceValue () const
virtual void	SetFindUpperThreshold (bool _arg)
virtual void	FindUpperThresholdOn ()
virtual void	FindUpperThresholdOff ()
virtual const bool &	GetFindUpperThreshold () const
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 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)
virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
virtual void	GraftOutput (DataObject *graft)
OutputImageType *	GetOutput ()
const OutputImageType *	GetOutput () const
ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual const bool &	GetAbortGenerateData () const
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
NameArray	GetInputNames () const
DataObjectPointerArray	GetInputs ()
MultiThreaderBase *	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 (MultiThreaderBase *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	ReleaseDataBeforeUpdateFlagOff ()
	itkVirtualSetClampMacro (NumberOfWorkUnits, ThreadIdType, 1, ITK_MAX_THREADS)
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 ()

Protected Member Functions
void	EnlargeOutputRequestedRegion (DataObject *output) override
void	GenerateData () override
void	GenerateInputRequestedRegion () override
	IsolatedConnectedImageFilter ()
	~IsolatedConnectedImageFilter () 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)
	ImageToImageFilter ()
void	VerifyInputInformation () const override
	~ImageToImageFilter () override=default
Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
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 ()
virtual void	DynamicMultiThreadingOff ()
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
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	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	ThreaderUpdateProgressOff ()
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 Attributes
bool	m_FindUpperThreshold {}
InputImagePixelType	m_IsolatedValue {}
InputImagePixelType	m_IsolatedValueTolerance {}
InputImagePixelType	m_Lower {}
OutputImagePixelType	m_ReplaceValue {}
SeedsContainerType	m_Seeds1 {}
SeedsContainerType	m_Seeds2 {}
bool	m_ThresholdingFailed {}
InputImagePixelType	m_Upper {}
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 {}
using	InputImageType = TInputImage
using	InputImagePointer = typename InputImageType::Pointer
using	InputImageConstPointer = typename InputImageType::ConstPointer
using	InputImageRegionType = typename InputImageType::RegionType
using	InputImagePixelType = typename InputImageType::PixelType
using	IndexType = typename InputImageType::IndexType
using	SizeType = typename InputImageType::SizeType
virtual const char *	GetNameOfClass () const

Additional Inherited Members
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 inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	InputToOutputRegionCopierType
using	OutputToInputRegionCopierType
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)

Member Typedef Documentation

ConstPointer

template<typename TInputImage, typename TOutputImage>

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

Definition at line 81 of file itkIsolatedConnectedImageFilter.h.

IndexType

template<typename TInputImage, typename TOutputImage>

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

See also

LightObject::GetNameOfClass()

Definition at line 94 of file itkIsolatedConnectedImageFilter.h.

InputImageConstPointer

template<typename TInputImage, typename TOutputImage>

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

See also

LightObject::GetNameOfClass()

Definition at line 91 of file itkIsolatedConnectedImageFilter.h.

InputImagePixelType

template<typename TInputImage, typename TOutputImage>

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

See also

LightObject::GetNameOfClass()

Definition at line 93 of file itkIsolatedConnectedImageFilter.h.

InputImagePointer

template<typename TInputImage, typename TOutputImage>

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

See also

LightObject::GetNameOfClass()

Definition at line 90 of file itkIsolatedConnectedImageFilter.h.

InputImageRegionType

template<typename TInputImage, typename TOutputImage>

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

See also

LightObject::GetNameOfClass()

Definition at line 92 of file itkIsolatedConnectedImageFilter.h.

InputImageType

template<typename TInputImage, typename TOutputImage>

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

See also

LightObject::GetNameOfClass()

Definition at line 89 of file itkIsolatedConnectedImageFilter.h.

InputRealType

template<typename TInputImage, typename TOutputImage>

using itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::InputRealType = typename NumericTraits<InputImagePixelType>::RealType

Definition at line 104 of file itkIsolatedConnectedImageFilter.h.

OutputImagePixelType

template<typename TInputImage, typename TOutputImage>

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

Definition at line 100 of file itkIsolatedConnectedImageFilter.h.

OutputImagePointer

template<typename TInputImage, typename TOutputImage>

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

Definition at line 98 of file itkIsolatedConnectedImageFilter.h.

OutputImageRegionType

template<typename TInputImage, typename TOutputImage>

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

Definition at line 99 of file itkIsolatedConnectedImageFilter.h.

OutputImageType

template<typename TInputImage, typename TOutputImage>

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

Definition at line 97 of file itkIsolatedConnectedImageFilter.h.

Pointer

template<typename TInputImage, typename TOutputImage>

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

Definition at line 80 of file itkIsolatedConnectedImageFilter.h.

SeedsContainerType

template<typename TInputImage, typename TOutputImage>

using itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::SeedsContainerType = std::vector<IndexType>

Definition at line 102 of file itkIsolatedConnectedImageFilter.h.

Self

template<typename TInputImage, typename TOutputImage>

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

Standard class type aliases.

Definition at line 78 of file itkIsolatedConnectedImageFilter.h.

SizeType

template<typename TInputImage, typename TOutputImage>

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

See also

LightObject::GetNameOfClass()

Definition at line 95 of file itkIsolatedConnectedImageFilter.h.

Superclass

template<typename TInputImage, typename TOutputImage>

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

Definition at line 79 of file itkIsolatedConnectedImageFilter.h.

Constructor & Destructor Documentation

IsolatedConnectedImageFilter()

template<typename TInputImage, typename TOutputImage>

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

protected

Referenced by GetNameOfClass().

~IsolatedConnectedImageFilter()

template<typename TInputImage, typename TOutputImage>

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

overrideprotecteddefault

Member Function Documentation

AddSeed1()

template<typename TInputImage, typename TOutputImage>

void itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::AddSeed1

(

const IndexType &

seed

)

Add seed point 1. This seed will be isolated from Seed2 (if possible). All pixels connected to this seed will be replaced with ReplaceValue.

AddSeed2()

template<typename TInputImage, typename TOutputImage>

void itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::AddSeed2

(

const IndexType &

seed

)

Add seed point 2. This seed will be isolated from Seed1 (if possible).

ClearSeeds1()

template<typename TInputImage, typename TOutputImage>

void itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::ClearSeeds1

(

)

Clear all the seeds1.

ClearSeeds2()

template<typename TInputImage, typename TOutputImage>

void itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::ClearSeeds2

(

)

Clear all the seeds2.

CreateAnother()

template<typename TInputImage, typename TOutputImage>

virtual::itk::LightObject::Pointer itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LightObject.

EnlargeOutputRequestedRegion()

template<typename TInputImage, typename TOutputImage>

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

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.

FindUpperThresholdOff()

template<typename TInputImage, typename TOutputImage>

virtual void itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::FindUpperThresholdOff ( )

virtual

Set/Get whether to find an upper threshold (separating two dark regions) or a lower threshold (separating two bright regions).

FindUpperThresholdOn()

template<typename TInputImage, typename TOutputImage>

virtual void itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::FindUpperThresholdOn ( )

virtual

Set/Get whether to find an upper threshold (separating two dark regions) or a lower threshold (separating two bright regions).

GenerateData()

template<typename TInputImage, typename TOutputImage>

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

GetFindUpperThreshold()

template<typename TInputImage, typename TOutputImage>

virtual const bool & itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::GetFindUpperThreshold ( ) const

virtual

Set/Get whether to find an upper threshold (separating two dark regions) or a lower threshold (separating two bright regions).

GetIsolatedValue()

template<typename TInputImage, typename TOutputImage>

virtual const InputImagePixelType & itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::GetIsolatedValue ( ) const

virtual

Get value that isolates the two seeds.

GetIsolatedValueTolerance()

template<typename TInputImage, typename TOutputImage>

virtual const InputImagePixelType & itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::GetIsolatedValueTolerance ( ) const

virtual

Set/Get the precision required for the intensity threshold value. The default is 1.

GetLower()

template<typename TInputImage, typename TOutputImage>

virtual const InputImagePixelType & itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::GetLower ( ) const

virtual

Set/Get the limit on the lower threshold value. The default is the NonpositiveMin() for the InputPixelType.

GetNameOfClass()

template<typename TInputImage, typename TOutputImage>

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

virtual

See also

LightObject::GetNameOfClass()

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

References IsolatedConnectedImageFilter().

GetReplaceValue()

template<typename TInputImage, typename TOutputImage>

virtual const OutputImagePixelType & itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::GetReplaceValue ( ) const

virtual

Set/Get value to replace thresholded pixels. Pixels that lie within the thresholds will be replaced with this value. The default is 1.

GetSeeds1()

template<typename TInputImage, typename TOutputImage>

virtual const SeedsContainerType & itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::GetSeeds1 ( ) const

virtual

Method to access seed container

GetSeeds2()

template<typename TInputImage, typename TOutputImage>

virtual const SeedsContainerType & itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::GetSeeds2 ( ) const

virtual

Method to access seed container

GetThresholdingFailed()

template<typename TInputImage, typename TOutputImage>

virtual const bool & itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::GetThresholdingFailed ( ) const

virtual

Get the flag that tells whether the algorithm failed to find a threshold.

GetUpper()

template<typename TInputImage, typename TOutputImage>

virtual const InputImagePixelType & itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::GetUpper ( ) const

virtual

Set/Get the limit on the upper threshold value. The default is the max() for the InputPixelType.

References SetUpper().

New()

template<typename TInputImage, typename TOutputImage>

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

static

Method for creation through the object factory.

PrintSelf()

template<typename TInputImage, typename TOutputImage>

void itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream & os, Indent indent ) const

overridevirtual

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

SetFindUpperThreshold()

template<typename TInputImage, typename TOutputImage>

virtual void itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::SetFindUpperThreshold ( bool _arg )

virtual

Set/Get whether to find an upper threshold (separating two dark regions) or a lower threshold (separating two bright regions).

SetIsolatedValueTolerance()

template<typename TInputImage, typename TOutputImage>

virtual void itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::SetIsolatedValueTolerance ( InputImagePixelType _arg )

virtual

Set/Get the precision required for the intensity threshold value. The default is 1.

SetLower()

template<typename TInputImage, typename TOutputImage>

virtual void itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::SetLower ( InputImagePixelType _arg )

virtual

Set/Get the limit on the lower threshold value. The default is the NonpositiveMin() for the InputPixelType.

SetReplaceValue()

template<typename TInputImage, typename TOutputImage>

virtual void itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::SetReplaceValue ( OutputImagePixelType _arg )

virtual

Set/Get value to replace thresholded pixels. Pixels that lie within the thresholds will be replaced with this value. The default is 1.

SetSeed1()

template<typename TInputImage, typename TOutputImage>

void itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::SetSeed1

(

const IndexType &

seed

)

Set a single seed point 1.

This seed will be isolated from Seed2 (if possible). All pixels connected to this seed will be replaced with ReplaceValue.

Deprecated

Please use AddSeed1.

SetSeed2()

template<typename TInputImage, typename TOutputImage>

void itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::SetSeed2

(

const IndexType &

seed

)

Set a single seed point 2.

This seed will be isolated from Seed1 (if possible).

Deprecated

Please use AddSeed2.

SetSeeds1()

template<typename TInputImage, typename TOutputImage>

virtual void itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::SetSeeds1 ( SeedsContainerType _arg )

virtual

Method to access seed container

SetSeeds2()

template<typename TInputImage, typename TOutputImage>

virtual void itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::SetSeeds2 ( SeedsContainerType _arg )

virtual

Method to access seed container

SetUpper()

template<typename TInputImage, typename TOutputImage>

virtual void itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::SetUpper ( InputImagePixelType _arg )

virtual

Set/Get the limit on the upper threshold value. The default is the max() for the InputPixelType.

Referenced by GetUpper().

Member Data Documentation

m_FindUpperThreshold

template<typename TInputImage, typename TOutputImage>

bool itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::m_FindUpperThreshold {}

protected

Definition at line 225 of file itkIsolatedConnectedImageFilter.h.

m_IsolatedValue

template<typename TInputImage, typename TOutputImage>

InputImagePixelType itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::m_IsolatedValue {}

protected

Definition at line 222 of file itkIsolatedConnectedImageFilter.h.

m_IsolatedValueTolerance

template<typename TInputImage, typename TOutputImage>

InputImagePixelType itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::m_IsolatedValueTolerance {}

protected

Definition at line 223 of file itkIsolatedConnectedImageFilter.h.

m_Lower

template<typename TInputImage, typename TOutputImage>

InputImagePixelType itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::m_Lower {}

protected

Definition at line 217 of file itkIsolatedConnectedImageFilter.h.

m_ReplaceValue

template<typename TInputImage, typename TOutputImage>

OutputImagePixelType itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::m_ReplaceValue {}

protected

Definition at line 220 of file itkIsolatedConnectedImageFilter.h.

m_Seeds1

template<typename TInputImage, typename TOutputImage>

SeedsContainerType itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::m_Seeds1 {}

protected

Definition at line 214 of file itkIsolatedConnectedImageFilter.h.

m_Seeds2

template<typename TInputImage, typename TOutputImage>

SeedsContainerType itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::m_Seeds2 {}

protected

Definition at line 215 of file itkIsolatedConnectedImageFilter.h.

m_ThresholdingFailed

template<typename TInputImage, typename TOutputImage>

bool itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::m_ThresholdingFailed {}

protected

Definition at line 226 of file itkIsolatedConnectedImageFilter.h.

m_Upper

template<typename TInputImage, typename TOutputImage>

InputImagePixelType itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >::m_Upper {}

protected

Definition at line 218 of file itkIsolatedConnectedImageFilter.h.

---

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

• itkIsolatedConnectedImageFilter.h