#include <itkMovingHistogramImageFilter.h>

Inheritance diagram for itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >:

Collaboration diagram for itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	IndexType = typename TInputImage::IndexType

using	InputImageType = TInputImage

using	KernelIteratorType = typename KernelType::ConstIterator

using	KernelType = TKernel

using	OffsetListType = typename std::list< OffsetType >

using	OffsetMapType = typename std::map< OffsetType, OffsetListType, Functor::LexicographicCompare >

using	OffsetType = typename TInputImage::OffsetType

using	OutputImageRegionType = typename Superclass::OutputImageRegionType

using	OutputImageType = TOutputImage

using	OutputPixelType = typename TOutputImage::PixelType

using	PixelType = typename TInputImage::PixelType

using	Pointer = SmartPointer< Self >

using	RadiusType = typename KernelType::SizeType

using	RegionType = typename TInputImage::RegionType

using	Self = MovingHistogramImageFilter

using	SizeType = typename TInputImage::SizeType

using	Superclass = MovingHistogramImageFilterBase< TInputImage, TOutputImage, TKernel >

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

using	IndexType = typename TInputImage::IndexType

using	InputImageType = TInputImage

using	KernelIteratorType = typename KernelType::ConstIterator

using	KernelType = TKernel

using	OffsetListType = typename std::list< OffsetType >

using	OffsetMapType = typename std::map< OffsetType, OffsetListType, Functor::LexicographicCompare >

using	OffsetType = typename TInputImage::OffsetType

using	OutputImageRegionType = typename Superclass::OutputImageRegionType

using	OutputImageType = TOutputImage

using	OutputPixelType = typename TOutputImage::PixelType

using	PixelType = typename TInputImage::PixelType

using	Pointer = SmartPointer< Self >

using	RadiusType = typename KernelType::SizeType

using	RegionType = typename TInputImage::RegionType

using	Self = MovingHistogramImageFilterBase

using	SizeType = typename TInputImage::SizeType

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	OutputImagePixelType = typename Superclass::OutputImagePixelType

using	OutputImageRegionType = typename Superclass::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	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	ConfigureHistogram (THistogram &)

virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual const char *	GetNameOfClass () const

Public Member Functions inherited from itk::MovingHistogramImageFilterBase< TInputImage, TOutputImage, TKernel >
virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual SizeValueType	GetPixelsPerTranslation () const

void	SetKernel (const KernelType &kernel) override

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

void	SetRadius (const RadiusType &radius) override

void	SetRadius (const SizeValueType &radius) override

Public Member Functions inherited from itk::BoxImageFilter< TInputImage, TOutputImage >
virtual const RadiusType &	GetRadius () const

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

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

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

virtual void	SetInput (const InputImageType *input)

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

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

OutputImageType *	GetOutput (unsigned int idx)

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

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

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	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

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

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

MultiThreaderType *	GetMultiThreader () const

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	PrepareOutputs ()

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

unsigned long	AddObserver (const EventObject &event, Command *) const

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

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)

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::MovingHistogramImageFilterBase< TInputImage, TOutputImage, TKernel >
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 void	SetGlobalDefaultDirectionTolerance (double)

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static double	GetGlobalDefaultCoordinateTolerance ()

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

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

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

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	ImageDimension = TInputImage::ImageDimension

Static Public Attributes inherited from itk::MovingHistogramImageFilterBase< TInputImage, TOutputImage, TKernel >
static constexpr unsigned int	ImageDimension = TInputImage::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 Types
using	HistogramType = THistogram

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

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

Protected Member Functions
void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override

	MovingHistogramImageFilter ()

void	PushHistogram (HistogramType &histogram, const OffsetListType addedList, const OffsetListType removedList, const RegionType &inputRegion, const RegionType &kernRegion, const InputImageType *inputImage, const IndexType currentIdx)

	~MovingHistogramImageFilter () override=default

Protected Member Functions inherited from itk::MovingHistogramImageFilterBase< TInputImage, TOutputImage, TKernel >
void	GetDirAndOffset (const IndexType LineStart, const IndexType PrevLineStart, OffsetType &LineOffset, OffsetType &Changes, int &LineDirection)

	MovingHistogramImageFilterBase ()

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

	~MovingHistogramImageFilterBase () override=default

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

	~KernelImageFilter () override=default

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

void	GenerateInputRequestedRegion () override

	~BoxImageFilter () override=default

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

	~ImageToImageFilter () override=default

void	VerifyInputInformation () ITKv5_CONST override

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

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

void	PushBackInput (const DataObject *input) override

void	PushFrontInput (const DataObject *input) override

Protected Member Functions inherited from itk::ImageSource< TOutputImage >
	ImageSource ()

	~ImageSource () override=default

void	GenerateData () override

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

virtual void	AfterThreadedGenerateData ()

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

virtual void	DynamicMultiThreadingOff ()

Protected Member Functions inherited from itk::ProcessObject
	ProcessObject ()

	~ProcessObject () override

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

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

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	AddInput (DataObject *input)

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

virtual void	SetPrimaryInput (DataObject *object)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

void	SetRequiredInputNames (const NameArray &)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

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

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual void	SetPrimaryOutput (DataObject *object)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

virtual void	AddOutput (DataObject *output)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

virtual void	VerifyPreconditions () ITKv5_CONST

virtual void	GenerateOutputRequestedRegion (DataObject *output)

virtual void	GenerateOutputInformation ()

virtual void	PropagateResetPipeline ()

virtual void	ReleaseInputs ()

virtual void	CacheInputReleaseDataFlags ()

virtual void	RestoreInputReleaseDataFlags ()

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	ThreaderUpdateProgressOff ()

virtual void	SetThreaderUpdateProgress (bool arg)

Protected Member Functions inherited from itk::Object
	Object ()

	~Object () override

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

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

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

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::MovingHistogramImageFilterBase< TInputImage, TOutputImage, TKernel >
OffsetMapType	m_AddedOffsets

FixedArray< int, Self::ImageDimension >	m_Axes

OffsetListType	m_KernelOffsets

SizeValueType	m_PixelsPerTranslation

OffsetMapType	m_RemovedOffsets

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

Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool	m_DynamicMultiThreading

Protected Attributes inherited from itk::ProcessObject
bool	m_Updating

TimeStamp	m_OutputInformationMTime

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Detailed Description

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram>
class itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >

Implements a generic moving histogram algorithm.

This filter is a base class to implement efficiently many neighborhood filters. Instead of visiting all the neighbors of a pixel, the set of pixels in the neighborhood is updated when the filter is moving to a new pixel. The number of pixels read for each pixel can be very smaller than the number of pixels read by a basic algorithm.

This filter moves the neighborhood over all the pixels of the output requested region, and pass the pixel added and removed of the neighborhood to the an histogram class. This filter doesn't implement the histogram class - it must be implement and passed as template parameter. The histogram class is not necessary a real histogram. It can be implemented in many ways, and only has to provide the methods described below.

This filter takes 4 template parameters: the input and output image type, the structuring element (or kernel) type, and the histogram type. The input and output image must have the same number of dimension.

The histogram type is a class which has to implements six methods:

a default constructor which takes no parameter.
void AddPixel( const InputPixelType &p ) is called when a new pixel is added to the histogram.
void RemovePixel( const InputPixelType &p ) is called when a pixel is removed of the histogram.
void AddBoundary() is called when a pixel outside the image is added. No value is provided: it's the responsibility to the histogram class to get it if needed. This method can be kept empty to ignore the boundary pixels.
void RemoveBoundary() is called to when a pixel outside the image is removed. No value is provided: it's the responsibility to the histogram class to get it if needed. This method can be kept empty to ignore the boundary pixels.
AType GetValue() is called to set the value of the output image. AType must be the output pixel type, or a type castable to the output pixel type.

MovingHistogramImageFilter add the new pixels before removing the old ones, so, if AddBoundary() is implemented and/or the kernel is symmetric, it is safe to consider that the histogram will never be empty.

One histogram is created for each thread by the method NewHistogram(). The NewHistogram() method can be overriden to pass some parameters to the histogram.

The neighborhood is defined by a structuring element, and must a itk::Neighborhood object or a subclass. The structuring element is assumed to be composed of binary values (zero or one). Only elements of the structuring element having values > 0 are candidates for affecting the center pixel.

See also: MovingWindowMeanImageFilter, RankImageFilter, MaskedMovingHistogramImageFilter,; MovingHistogramMorphologicalGradientImageFilter

Author: Gaetan Lehmann; Richard Beare

Definition at line 88 of file itkMovingHistogramImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram>

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

Definition at line 98 of file itkMovingHistogramImageFilter.h.

◆ HistogramType

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram>

using itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::HistogramType = THistogram

protected

Definition at line 149 of file itkMovingHistogramImageFilter.h.

◆ IndexType

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram>

using itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::IndexType = typename TInputImage::IndexType

Definition at line 111 of file itkMovingHistogramImageFilter.h.

◆ InputImageType

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram>

using itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::InputImageType = TInputImage

Image related type alias.

Definition at line 107 of file itkMovingHistogramImageFilter.h.

◆ KernelIteratorType

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram>

using itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::KernelIteratorType = typename KernelType::ConstIterator

Kernel (structuring element) iterator.

Definition at line 124 of file itkMovingHistogramImageFilter.h.

◆ KernelType

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram>

using itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::KernelType = TKernel

Kernel type alias.

Definition at line 121 of file itkMovingHistogramImageFilter.h.

◆ OffsetListType

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram>

using itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::OffsetListType = typename std::list<OffsetType>

Definition at line 129 of file itkMovingHistogramImageFilter.h.

◆ OffsetMapType

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram>

using itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::OffsetMapType = typename std::map<OffsetType, OffsetListType, Functor::LexicographicCompare>

Definition at line 131 of file itkMovingHistogramImageFilter.h.

◆ OffsetType

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram>

using itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::OffsetType = typename TInputImage::OffsetType

Definition at line 113 of file itkMovingHistogramImageFilter.h.

◆ OutputImageRegionType

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram>

using itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::OutputImageRegionType = typename Superclass::OutputImageRegionType

Definition at line 114 of file itkMovingHistogramImageFilter.h.

◆ OutputImageType

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram>

using itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::OutputImageType = TOutputImage

Definition at line 108 of file itkMovingHistogramImageFilter.h.

◆ OutputPixelType

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram>

using itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::OutputPixelType = typename TOutputImage::PixelType

Definition at line 115 of file itkMovingHistogramImageFilter.h.

◆ PixelType

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram>

using itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::PixelType = typename TInputImage::PixelType

Definition at line 112 of file itkMovingHistogramImageFilter.h.

◆ Pointer

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram>

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

Definition at line 97 of file itkMovingHistogramImageFilter.h.

◆ RadiusType

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram>

using itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::RadiusType = typename KernelType::SizeType

n-dimensional Kernel radius.

Definition at line 127 of file itkMovingHistogramImageFilter.h.

◆ RegionType

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram>

using itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::RegionType = typename TInputImage::RegionType

Definition at line 109 of file itkMovingHistogramImageFilter.h.

◆ Self

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram>

using itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::Self = MovingHistogramImageFilter

Standard class type aliases.

Definition at line 95 of file itkMovingHistogramImageFilter.h.

◆ SizeType

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram>

using itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::SizeType = typename TInputImage::SizeType

Definition at line 110 of file itkMovingHistogramImageFilter.h.

◆ Superclass

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram>

using itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::Superclass = MovingHistogramImageFilterBase<TInputImage, TOutputImage, TKernel>

Definition at line 96 of file itkMovingHistogramImageFilter.h.

Constructor & Destructor Documentation

◆ MovingHistogramImageFilter()

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram>

itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::MovingHistogramImageFilter ( )

protected

◆ ~MovingHistogramImageFilter()

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram>

itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::~MovingHistogramImageFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ ConfigureHistogram()

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram>

virtual void itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::ConfigureHistogram ( THistogram & )

inlinevirtual

Configure the histogram. Subclasses must override this method.

Reimplemented in itk::MovingHistogramMorphologyImageFilter< TInputImage, TOutputImage, TKernel, THistogram >, itk::MovingHistogramMorphologyImageFilter< TInputImage, TOutputImage, TKernel, Function::MorphologyHistogram< TInputImage::PixelType, std::less< TInputImage::PixelType > > >, and itk::MovingHistogramMorphologyImageFilter< TInputImage, TOutputImage, TKernel, Function::MorphologyHistogram< TInputImage::PixelType, std::greater< TInputImage::PixelType > > >.

Definition at line 136 of file itkMovingHistogramImageFilter.h.

◆ CreateAnother()

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram>

virtual::itk::LightObject::Pointer itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::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::KernelImageFilter< TInputImage, TOutputImage, TKernel >.

Reimplemented in itk::MovingHistogramMorphologyImageFilter< TInputImage, TOutputImage, TKernel, THistogram >, itk::MovingHistogramMorphologyImageFilter< TInputImage, TOutputImage, TKernel, Function::MorphologyHistogram< TInputImage::PixelType, std::less< TInputImage::PixelType > > >, and itk::MovingHistogramMorphologyImageFilter< TInputImage, TOutputImage, TKernel, Function::MorphologyHistogram< TInputImage::PixelType, std::greater< TInputImage::PixelType > > >.

◆ DynamicThreadedGenerateData()

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram>

void itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::DynamicThreadedGenerateData ( const OutputImageRegionType & outputRegionForThread )

overrideprotectedvirtual

Multi-thread version of GenerateData.

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GetNameOfClass()

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram>

virtual const char* itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::GetNameOfClass ( ) const

virtual

Runtime information support.

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

Reimplemented in itk::MovingHistogramMorphologicalGradientImageFilter< TInputImage, TOutputImage, TKernel >, itk::AdaptiveHistogramEqualizationImageFilter< TImageType, TKernel >, itk::RankImageFilter< TInputImage, TOutputImage, TKernel >, itk::MovingHistogramDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::MovingHistogramErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::MovingHistogramMorphologyImageFilter< TInputImage, TOutputImage, TKernel, THistogram >, itk::MovingHistogramMorphologyImageFilter< TInputImage, TOutputImage, TKernel, Function::MorphologyHistogram< TInputImage::PixelType, std::less< TInputImage::PixelType > > >, and itk::MovingHistogramMorphologyImageFilter< TInputImage, TOutputImage, TKernel, Function::MorphologyHistogram< TInputImage::PixelType, std::greater< TInputImage::PixelType > > >.

◆ New()

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram>

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

static

Standard New method.

◆ PushHistogram()

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram>

void itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::PushHistogram	(	HistogramType &	histogram,
		const OffsetListType *	addedList,
		const OffsetListType *	removedList,
		const RegionType &	inputRegion,
		const RegionType &	kernRegion,
		const InputImageType *	inputImage,
		const IndexType	currentIdx
	)

protected

Member Data Documentation

◆ ImageDimension

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram>

constexpr unsigned int itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::ImageDimension = TInputImage::ImageDimension

staticconstexpr

Image related type alias.

Definition at line 118 of file itkMovingHistogramImageFilter.h.

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

itkMovingHistogramImageFilter.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Additional Inherited Members

Detailed Description

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram> class itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >

Member Typedef Documentation

◆ ConstPointer

◆ HistogramType

◆ IndexType

◆ InputImageType

◆ KernelIteratorType

◆ KernelType

◆ OffsetListType

◆ OffsetMapType

◆ OffsetType

◆ OutputImageRegionType

◆ OutputImageType

◆ OutputPixelType

◆ PixelType

◆ Pointer

◆ RadiusType

◆ RegionType

◆ Self

◆ SizeType

◆ Superclass

Constructor & Destructor Documentation

◆ MovingHistogramImageFilter()

◆ ~MovingHistogramImageFilter()

Member Function Documentation

◆ ConfigureHistogram()

◆ CreateAnother()

◆ DynamicThreadedGenerateData()

◆ GetNameOfClass()

◆ New()

◆ PushHistogram()

Member Data Documentation

◆ ImageDimension

template<typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram>
class itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >