#include <itkValuedRegionalExtremaImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage, typename TFunction1, typename TFunction2>
class itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >

Uses a flooding algorithm to set all voxels that are not a regional extrema to the max or min of the pixel type.

This is the class used by ValuedRegionalMinimaImageFilter and ValuedRegionalMaximaImageFilter. There is no suppression of regional minima based on dynamics, as available in HMinimaImageFilter. This flooding algorithm is a very simple one, but I'm not sure where it came from - I certainly didn't invent it.

Let's consider the case of regional minima. The basic algorithm is: Boundary conditions are such that the image is logically surrounded by a border that is either maximal or minimal for the pixel type. An optimized version could explicitly set the border to avoid the need for boundary checks. For regional minima the boundary is set to the maximal value for the pixel type.

Pixels are visited in raster order. The neighbors of each pixel are examined. If any neighbor is greater than the centre, then the centre pixel cannot be a regional minima. The centre pixel is part of a flat region (consisting of at least one pixel) that is therefore not a regional minima either. This region is set to the maximum value for the pixel type using a flooding algorithm.

There are some minor complications that prevent pixels being examined more than once – basically check that the output value is less than the maximum for the pixel type.

The implementation uses the functor model from itkMaximumImageFilter.

This code was contributed in the Insight Journal paper: "Finding regional extrema - methods and performance" by Beare R., Lehmann G. https://doi.org/10.54294/hva3gz

Author: Richard Beare. Department of Medicine, Monash University, Melbourne, Australia.

See also: ValuedRegionalMinimaImageFilter, ValuedRegionalMaximaImageFilter,; HMinimaImageFilter

Definition at line 77 of file itkValuedRegionalExtremaImageFilter.h.

Inheritance diagram for itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >:

Collaboration diagram for itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >:

Public Types
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	ISizeType = typename InputImageType::SizeType

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 = ValuedRegionalExtremaImageFilter

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 bool	GetFlat () const

const char *	GetNameOfClass () const override


virtual void	SetFullyConnected (bool _arg)

virtual const bool &	GetFullyConnected () const

virtual void	FullyConnectedOn ()


virtual void	SetMarkerValue (typename TInputImage::PixelType _arg)

virtual const TInputImage::PixelType &	GetMarkerValue () const

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

const InputImageType *	GetInput (unsigned int idx) const

const char *	GetNameOfClass () const override

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

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

virtual void	SetInput (const InputImageType *input)

virtual void	SetInput (unsigned int, const TInputImage *image)

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

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

OutputImageType *	GetOutput (unsigned int idx)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *graft)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)

virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)

ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

const char *	GetNameOfClass () const override

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

const char *	GetNameOfClass () const override

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

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

virtual Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

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

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	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 Member Functions
void	EnlargeOutputRequestedRegion (DataObject *) override

void	GenerateData () override

void	GenerateInputRequestedRegion () override

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

	ValuedRegionalExtremaImageFilter ()

	~ValuedRegionalExtremaImageFilter () 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 Types
using	ConstInputIterator = ConstShapedNeighborhoodIterator< InputImageType >

using	IndexStack = std::stack< OutIndexType >

using	InIndexType = typename InputImageType::IndexType

using	NOutputIterator = ShapedNeighborhoodIterator< OutputImageType >

using	OutIndexType = typename OutputImageType::IndexType

Private Attributes
bool	m_Flat { false }

bool	m_FullyConnected { false }

TInputImage::PixelType	m_MarkerValue {}

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

◆ ConstInputIterator

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

using itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::ConstInputIterator = ConstShapedNeighborhoodIterator<InputImageType>

private

Definition at line 168 of file itkValuedRegionalExtremaImageFilter.h.

◆ ConstPointer

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

using itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::ConstPointer = SmartPointer<const Self>

Definition at line 86 of file itkValuedRegionalExtremaImageFilter.h.

◆ IndexStack

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

using itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::IndexStack = std::stack<OutIndexType>

private

Definition at line 170 of file itkValuedRegionalExtremaImageFilter.h.

◆ InIndexType

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

using itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::InIndexType = typename InputImageType::IndexType

private

Definition at line 167 of file itkValuedRegionalExtremaImageFilter.h.

◆ InputImageConstPointer

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

using itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::InputImageConstPointer = typename InputImageType::ConstPointer

Definition at line 92 of file itkValuedRegionalExtremaImageFilter.h.

◆ InputImagePixelType

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

using itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::InputImagePixelType = typename InputImageType::PixelType

Definition at line 94 of file itkValuedRegionalExtremaImageFilter.h.

◆ InputImagePointer

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

using itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::InputImagePointer = typename InputImageType::Pointer

Definition at line 91 of file itkValuedRegionalExtremaImageFilter.h.

◆ InputImageRegionType

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

using itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::InputImageRegionType = typename InputImageType::RegionType

Definition at line 93 of file itkValuedRegionalExtremaImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

using itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::InputImageType = TInputImage

Some convenient type alias.

Definition at line 89 of file itkValuedRegionalExtremaImageFilter.h.

◆ ISizeType

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

using itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::ISizeType = typename InputImageType::SizeType

Definition at line 95 of file itkValuedRegionalExtremaImageFilter.h.

◆ NOutputIterator

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

using itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::NOutputIterator = ShapedNeighborhoodIterator<OutputImageType>

private

Definition at line 169 of file itkValuedRegionalExtremaImageFilter.h.

◆ OutIndexType

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

using itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::OutIndexType = typename OutputImageType::IndexType

private

Definition at line 166 of file itkValuedRegionalExtremaImageFilter.h.

◆ OutputImageConstPointer

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

using itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::OutputImageConstPointer = typename OutputImageType::ConstPointer

Definition at line 97 of file itkValuedRegionalExtremaImageFilter.h.

◆ OutputImagePixelType

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

using itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::OutputImagePixelType = typename OutputImageType::PixelType

Definition at line 99 of file itkValuedRegionalExtremaImageFilter.h.

◆ OutputImagePointer

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

using itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::OutputImagePointer = typename OutputImageType::Pointer

Definition at line 96 of file itkValuedRegionalExtremaImageFilter.h.

◆ OutputImageRegionType

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

using itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::OutputImageRegionType = typename OutputImageType::RegionType

Definition at line 98 of file itkValuedRegionalExtremaImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

using itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::OutputImageType = TOutputImage

Definition at line 90 of file itkValuedRegionalExtremaImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

using itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::Pointer = SmartPointer<Self>

Definition at line 85 of file itkValuedRegionalExtremaImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

using itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::Self = ValuedRegionalExtremaImageFilter

Standard class type aliases.

Definition at line 83 of file itkValuedRegionalExtremaImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

using itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 84 of file itkValuedRegionalExtremaImageFilter.h.

Constructor & Destructor Documentation

◆ ValuedRegionalExtremaImageFilter()

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::ValuedRegionalExtremaImageFilter ( )

protected

◆ ~ValuedRegionalExtremaImageFilter()

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::~ValuedRegionalExtremaImageFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ EnlargeOutputRequestedRegion()

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

void itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::EnlargeOutputRequestedRegion ( DataObject * )

overrideprotectedvirtual

ValuedRegionalExtremaImageFilter will produce the entire output.

Reimplemented from itk::ProcessObject.

◆ FullyConnectedOn()

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

virtual void itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::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 , typename TFunction1 , typename TFunction2 >

void itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::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 , typename TFunction1 , typename TFunction2 >

void itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::GenerateInputRequestedRegion ( )

overrideprotectedvirtual

ValuedRegionalExtremaImageFilter needs the entire input be available. Thus, it needs to provide an implementation of GenerateInputRequestedRegion().

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

◆ GetFlat()

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

virtual bool itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::GetFlat ( ) const

virtual

Get whether the image is flat or not.

◆ GetFullyConnected()

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

virtual const bool & itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::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.

◆ GetMarkerValue()

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

virtual const TInputImage::PixelType & itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::GetMarkerValue ( ) const

virtual

Set/Get the value used to mark all pixels which are not extrema.

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

const char * itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

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

◆ New()

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

static Pointer itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::New ( )

static

Standard New method.

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

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

overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

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

◆ SetFullyConnected()

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

virtual void itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::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.

◆ SetMarkerValue()

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

virtual void itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::SetMarkerValue ( typename TInputImage::PixelType _arg )

virtual

Set/Get the value used to mark all pixels which are not extrema.

Member Data Documentation

◆ InputImageDimension

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

constexpr unsigned int itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::InputImageDimension = TInputImage::ImageDimension

staticconstexpr

ImageDimension constants

Definition at line 102 of file itkValuedRegionalExtremaImageFilter.h.

◆ m_Flat

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

bool itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::m_Flat { false }

private

Definition at line 164 of file itkValuedRegionalExtremaImageFilter.h.

◆ m_FullyConnected

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

bool itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::m_FullyConnected { false }

private

Definition at line 163 of file itkValuedRegionalExtremaImageFilter.h.

◆ m_MarkerValue

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

TInputImage::PixelType itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::m_MarkerValue {}

private

Definition at line 161 of file itkValuedRegionalExtremaImageFilter.h.

◆ OutputImageDimension

template<typename TInputImage , typename TOutputImage , typename TFunction1 , typename TFunction2 >

constexpr unsigned int itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::OutputImageDimension = TOutputImage::ImageDimension

staticconstexpr

Definition at line 103 of file itkValuedRegionalExtremaImageFilter.h.

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

itkValuedRegionalExtremaImageFilter.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Types

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstInputIterator

◆ ConstPointer

◆ IndexStack

◆ InIndexType

◆ InputImageConstPointer

◆ InputImagePixelType

◆ InputImagePointer

◆ InputImageRegionType

◆ InputImageType

◆ ISizeType

◆ NOutputIterator

◆ OutIndexType

◆ OutputImageConstPointer

◆ OutputImagePixelType

◆ OutputImagePointer

◆ OutputImageRegionType

◆ OutputImageType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ ValuedRegionalExtremaImageFilter()

◆ ~ValuedRegionalExtremaImageFilter()

Member Function Documentation

◆ EnlargeOutputRequestedRegion()

◆ FullyConnectedOn()

◆ GenerateData()

◆ GenerateInputRequestedRegion()

◆ GetFlat()

◆ GetFullyConnected()

◆ GetMarkerValue()

◆ GetNameOfClass()

◆ New()

◆ PrintSelf()

◆ SetFullyConnected()

◆ SetMarkerValue()

Member Data Documentation

◆ InputImageDimension

◆ m_Flat

◆ m_FullyConnected

◆ m_MarkerValue

◆ OutputImageDimension