#include <itkBlackTopHatImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage, typename TKernel>
class itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >

Black top hat extracts local minima that are smaller than the structuring element.

Black top hat extracts local minima that are smaller than the structuring element. It subtracts the background from the input image. The output of the filter transforms the black valleys into white peaks.

Top-hats are described in Chapter 4.5 of Pierre Soille's book "Morphological Image Analysis: Principles and Applications", Second Edition, Springer, 2003.

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

Definition at line 43 of file itkBlackTopHatImageFilter.h.

Inheritance diagram for itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >:

Collaboration diagram for itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >:

Public Types
using	AlgorithmEnum = MathematicalMorphologyEnums::Algorithm

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	KernelType = TKernel

using	OutputImageConstPointer = typename OutputImageType::ConstPointer

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TOutputImage

using	Pointer = SmartPointer< Self >

using	Self = BlackTopHatImageFilter

using	Superclass = KernelImageFilter< TInputImage, TOutputImage, TKernel >

Public Types inherited from itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >
using	ConstPointer = SmartPointer< const Self >

using	FlatKernelType = FlatStructuringElement<(Self::ImageDimension)>

using	IndexType = typename TInputImage::IndexType

using	InputImageType = TInputImage

using	InputPixelType = typename TInputImage::PixelType

using	KernelType = TKernel

using	OffsetType = typename TInputImage::OffsetType

using	OutputImageType = TOutputImage

using	OutputPixelType = typename TOutputImage::PixelType

using	Pointer = SmartPointer< Self >

using	RadiusType = typename TInputImage::SizeType

using	RegionType = typename TInputImage::RegionType

using	Self = KernelImageFilter

using	SizeType = typename TInputImage::SizeType

using	Superclass = BoxImageFilter< TInputImage, TOutputImage >

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

using	IndexType = typename TInputImage::IndexType

using	InputImageType = TInputImage

using	InputPixelType = typename TInputImage::PixelType

using	OffsetType = typename TInputImage::OffsetType

using	OutputImageType = TOutputImage

using	OutputPixelType = typename TOutputImage::PixelType

using	Pointer = SmartPointer< Self >

using	RadiusType = typename TInputImage::SizeType

using	RadiusValueType = typename TInputImage::SizeValueType

using	RegionType = typename TInputImage::RegionType

using	Self = BoxImageFilter

using	SizeType = typename TInputImage::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
virtual void	ForceAlgorithmOn ()

virtual const bool &	GetForceAlgorithm () const

const char *	GetNameOfClass () const override

virtual void	SetForceAlgorithm (bool _arg)


virtual void	SetSafeBorder (bool _arg)

virtual const bool &	GetSafeBorder () const

virtual void	SafeBorderOn ()


virtual void	SetAlgorithm (AlgorithmEnum _arg)

virtual AlgorithmEnum	GetAlgorithm () const

Public Member Functions inherited from itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >
virtual const KernelType &	GetKernel () const

const char *	GetNameOfClass () const override

virtual void	SetKernel (const KernelType &kernel)

void	SetRadius (const RadiusType &radius) override

void	SetRadius (const SizeValueType &radius) override

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

virtual const RadiusType &	GetRadius () const

virtual void	SetRadius (const RadiusType &radius)

virtual void	SetRadius (const RadiusValueType &radius)

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::KernelImageFilter< TInputImage, TOutputImage, TKernel >
static Pointer	New ()

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

static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >
static constexpr unsigned int	ImageDimension = TInputImage::ImageDimension

Static Public Attributes inherited from itk::BoxImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int	ImageDimension = TInputImage::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 Member Functions
	BlackTopHatImageFilter ()

void	GenerateData () override

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

	~BlackTopHatImageFilter () override=default

Protected Member Functions inherited from itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >
	KernelImageFilter ()

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

	~KernelImageFilter () override=default

Protected Member Functions inherited from itk::BoxImageFilter< TInputImage, TOutputImage >
	BoxImageFilter ()

void	GenerateInputRequestedRegion () override

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

	~BoxImageFilter () 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 void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)

virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

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

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

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

Private Attributes
AlgorithmEnum	m_Algorithm {}

bool	m_ForceAlgorithm {}

bool	m_SafeBorder {}

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

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

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)

Protected Attributes inherited from itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >
KernelType	m_Kernel {}

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

◆ AlgorithmEnum

template<typename TInputImage , typename TOutputImage , typename TKernel >

using itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::AlgorithmEnum = MathematicalMorphologyEnums::Algorithm

Definition at line 73 of file itkBlackTopHatImageFilter.h.

◆ ConstPointer

template<typename TInputImage , typename TOutputImage , typename TKernel >

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

Definition at line 52 of file itkBlackTopHatImageFilter.h.

◆ InputImageConstPointer

template<typename TInputImage , typename TOutputImage , typename TKernel >

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

Definition at line 58 of file itkBlackTopHatImageFilter.h.

◆ InputImagePixelType

template<typename TInputImage , typename TOutputImage , typename TKernel >

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

Definition at line 60 of file itkBlackTopHatImageFilter.h.

◆ InputImagePointer

template<typename TInputImage , typename TOutputImage , typename TKernel >

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

Definition at line 57 of file itkBlackTopHatImageFilter.h.

◆ InputImageRegionType

template<typename TInputImage , typename TOutputImage , typename TKernel >

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

Definition at line 59 of file itkBlackTopHatImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TOutputImage , typename TKernel >

using itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::InputImageType = TInputImage

Some convenient type alias.

Definition at line 55 of file itkBlackTopHatImageFilter.h.

◆ KernelType

template<typename TInputImage , typename TOutputImage , typename TKernel >

using itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::KernelType = TKernel

Kernel type alias.

Definition at line 67 of file itkBlackTopHatImageFilter.h.

◆ OutputImageConstPointer

template<typename TInputImage , typename TOutputImage , typename TKernel >

using itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::OutputImageConstPointer = typename OutputImageType::ConstPointer

Definition at line 62 of file itkBlackTopHatImageFilter.h.

◆ OutputImagePixelType

template<typename TInputImage , typename TOutputImage , typename TKernel >

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

Definition at line 64 of file itkBlackTopHatImageFilter.h.

◆ OutputImagePointer

template<typename TInputImage , typename TOutputImage , typename TKernel >

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

Definition at line 61 of file itkBlackTopHatImageFilter.h.

◆ OutputImageRegionType

template<typename TInputImage , typename TOutputImage , typename TKernel >

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

Definition at line 63 of file itkBlackTopHatImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TOutputImage , typename TKernel >

using itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::OutputImageType = TOutputImage

Definition at line 56 of file itkBlackTopHatImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage , typename TKernel >

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

Definition at line 51 of file itkBlackTopHatImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage , typename TKernel >

using itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::Self = BlackTopHatImageFilter

Standard class type aliases.

Definition at line 49 of file itkBlackTopHatImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage , typename TKernel >

using itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::Superclass = KernelImageFilter<TInputImage, TOutputImage, TKernel>

Definition at line 50 of file itkBlackTopHatImageFilter.h.

Constructor & Destructor Documentation

◆ BlackTopHatImageFilter()

template<typename TInputImage , typename TOutputImage , typename TKernel >

itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::BlackTopHatImageFilter ( )

protected

◆ ~BlackTopHatImageFilter()

template<typename TInputImage , typename TOutputImage , typename TKernel >

itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::~BlackTopHatImageFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ ForceAlgorithmOn()

template<typename TInputImage , typename TOutputImage , typename TKernel >

virtual void itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::ForceAlgorithmOn ( )

virtual

◆ GenerateData()

template<typename TInputImage , typename TOutputImage , typename TKernel >

void itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::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 >.

◆ GetAlgorithm()

template<typename TInputImage , typename TOutputImage , typename TKernel >

virtual AlgorithmEnum itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::GetAlgorithm ( ) const

virtual

Set/Get the backend filter class.

◆ GetForceAlgorithm()

template<typename TInputImage , typename TOutputImage , typename TKernel >

virtual const bool & itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::GetForceAlgorithm ( ) const

virtual

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage , typename TKernel >

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >.

◆ GetSafeBorder()

template<typename TInputImage , typename TOutputImage , typename TKernel >

virtual const bool & itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::GetSafeBorder ( ) const

virtual

A safe border is added to input image to avoid borders effects and remove it once the closing is done

◆ New()

template<typename TInputImage , typename TOutputImage , typename TKernel >

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

static

Standard New method.

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage , typename TKernel >

void itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::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::KernelImageFilter< TInputImage, TOutputImage, TKernel >.

◆ SafeBorderOn()

template<typename TInputImage , typename TOutputImage , typename TKernel >

virtual void itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::SafeBorderOn ( )

virtual

A safe border is added to input image to avoid borders effects and remove it once the closing is done

◆ SetAlgorithm()

template<typename TInputImage , typename TOutputImage , typename TKernel >

virtual void itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::SetAlgorithm ( AlgorithmEnum _arg )

virtual

Set/Get the backend filter class.

◆ SetForceAlgorithm()

template<typename TInputImage , typename TOutputImage , typename TKernel >

virtual void itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::SetForceAlgorithm ( bool _arg )

virtual

◆ SetSafeBorder()

template<typename TInputImage , typename TOutputImage , typename TKernel >

virtual void itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::SetSafeBorder ( bool _arg )

virtual

A safe border is added to input image to avoid borders effects and remove it once the closing is done

Member Data Documentation

◆ InputImageDimension

template<typename TInputImage , typename TOutputImage , typename TKernel >

constexpr unsigned int itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::InputImageDimension = TInputImage::ImageDimension

staticconstexpr

ImageDimension constants

Definition at line 70 of file itkBlackTopHatImageFilter.h.

◆ m_Algorithm

template<typename TInputImage , typename TOutputImage , typename TKernel >

AlgorithmEnum itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::m_Algorithm {}

private

Definition at line 120 of file itkBlackTopHatImageFilter.h.

◆ m_ForceAlgorithm

template<typename TInputImage , typename TOutputImage , typename TKernel >

bool itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::m_ForceAlgorithm {}

private

Definition at line 122 of file itkBlackTopHatImageFilter.h.

◆ m_SafeBorder

template<typename TInputImage , typename TOutputImage , typename TKernel >

bool itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::m_SafeBorder {}

private

Definition at line 118 of file itkBlackTopHatImageFilter.h.

◆ OutputImageDimension

template<typename TInputImage , typename TOutputImage , typename TKernel >

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

staticconstexpr

Definition at line 71 of file itkBlackTopHatImageFilter.h.

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

itkBlackTopHatImageFilter.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ AlgorithmEnum

◆ ConstPointer

◆ InputImageConstPointer

◆ InputImagePixelType

◆ InputImagePointer

◆ InputImageRegionType

◆ InputImageType

◆ KernelType

◆ OutputImageConstPointer

◆ OutputImagePixelType

◆ OutputImagePointer

◆ OutputImageRegionType

◆ OutputImageType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ BlackTopHatImageFilter()

◆ ~BlackTopHatImageFilter()

Member Function Documentation

◆ ForceAlgorithmOn()

◆ GenerateData()

◆ GetAlgorithm()

◆ GetForceAlgorithm()

◆ GetNameOfClass()

◆ GetSafeBorder()

◆ New()

◆ PrintSelf()

◆ SafeBorderOn()

◆ SetAlgorithm()

◆ SetForceAlgorithm()

◆ SetSafeBorder()

Member Data Documentation

◆ InputImageDimension

◆ m_Algorithm

◆ m_ForceAlgorithm

◆ m_SafeBorder

◆ OutputImageDimension