#include <itkMaskedImageToHistogramFilter.h>

Inheritance diagram for itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >:

Collaboration diagram for itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	HistogramConstPointer = typename HistogramType::ConstPointer

using	HistogramMeasurementType = typename HistogramType::MeasurementType

using	HistogramMeasurementVectorType = typename HistogramType::MeasurementVectorType

using	HistogramPointer = typename HistogramType::Pointer

using	HistogramSizeType = typename HistogramType::SizeType

using	HistogramType = Histogram< ValueRealType >

using	ImageType = TImage

using	MaskImageType = TMaskImage

using	MaskPixelType = typename MaskImageType::PixelType

using	PixelType = typename ImageType::PixelType

using	Pointer = SmartPointer< Self >

using	RegionType = typename ImageType::RegionType

using	Self = MaskedImageToHistogramFilter

using	Superclass = ImageToHistogramFilter< TImage >

using	ValueRealType = typename NumericTraits< ValueType >::RealType

using	ValueType = typename NumericTraits< PixelType >::ValueType

Public Types inherited from itk::Statistics::ImageToHistogramFilter< TImage >
using	ConstPointer = SmartPointer< const Self >

using	HistogramConstPointer = typename HistogramType::ConstPointer

using	HistogramMeasurementType = typename HistogramType::MeasurementType

using	HistogramMeasurementVectorType = typename HistogramType::MeasurementVectorType

using	HistogramPointer = typename HistogramType::Pointer

using	HistogramSizeType = typename HistogramType::SizeType

using	HistogramType = Histogram< ValueRealType >

using	ImageType = TImage

using	PixelType = typename ImageType::PixelType

using	Pointer = SmartPointer< Self >

using	RegionType = typename ImageType::RegionType

using	Self = ImageToHistogramFilter

using	Superclass = ImageSink< TImage >

using	ValueRealType = typename NumericTraits< ValueType >::RealType

using	ValueType = typename NumericTraits< PixelType >::ValueType

using	InputHistogramSizeObjectType = SimpleDataObjectDecorator< HistogramSizeType >

using	InputHistogramMeasurementObjectType = SimpleDataObjectDecorator< HistogramMeasurementType >

using	InputHistogramMeasurementVectorObjectType = SimpleDataObjectDecorator< HistogramMeasurementVectorType >

using	InputBooleanObjectType = SimpleDataObjectDecorator< bool >

Public Types inherited from itk::ImageSink< TImage >
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = typename Superclass::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TImage

using	Pointer = SmartPointer< Self >

using	RegionSplitterPointer = typename SplitterType::Pointer

using	Self = ImageSink

using	SplitterType = ImageRegionSplitterBase

using	Superclass = StreamingProcessObject

Public Types inherited from itk::StreamingProcessObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = StreamingProcessObject

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 ::itk::LightObject::Pointer	CreateAnother () const

virtual const char *	GetNameOfClass () const

Public Member Functions inherited from itk::Statistics::ImageToHistogramFilter< TImage >
const HistogramType *	GetOutput () const

HistogramType *	GetOutput ()

virtual void	SetHistogramSizeInput (const SimpleDataObjectDecorator< HistogramSizeType > *_arg)

virtual void	SetHistogramSize (const HistogramSizeType &_arg)

virtual void	SetHistogramSize (const SimpleDataObjectDecorator< HistogramSizeType > *_arg)

virtual const SimpleDataObjectDecorator< HistogramSizeType > *	GetHistogramSizeInput () const

virtual const HistogramSizeType &	GetHistogramSize () const

virtual void	SetMarginalScaleInput (const SimpleDataObjectDecorator< HistogramMeasurementType > *_arg)

virtual void	SetMarginalScale (const HistogramMeasurementType &_arg)

virtual void	SetMarginalScale (const SimpleDataObjectDecorator< HistogramMeasurementType > *_arg)

virtual const SimpleDataObjectDecorator< HistogramMeasurementType > *	GetMarginalScaleInput () const

virtual const HistogramMeasurementType &	GetMarginalScale () const

virtual void	SetHistogramBinMinimumInput (const SimpleDataObjectDecorator< HistogramMeasurementVectorType > *_arg)

virtual void	SetHistogramBinMinimum (const HistogramMeasurementVectorType &_arg)

virtual void	SetHistogramBinMinimum (const SimpleDataObjectDecorator< HistogramMeasurementVectorType > *_arg)

virtual const SimpleDataObjectDecorator< HistogramMeasurementVectorType > *	GetHistogramBinMinimumInput () const

virtual const HistogramMeasurementVectorType &	GetHistogramBinMinimum () const

virtual void	SetHistogramBinMaximumInput (const SimpleDataObjectDecorator< HistogramMeasurementVectorType > *_arg)

virtual void	SetHistogramBinMaximum (const HistogramMeasurementVectorType &_arg)

virtual void	SetHistogramBinMaximum (const SimpleDataObjectDecorator< HistogramMeasurementVectorType > *_arg)

virtual const SimpleDataObjectDecorator< HistogramMeasurementVectorType > *	GetHistogramBinMaximumInput () const

virtual const HistogramMeasurementVectorType &	GetHistogramBinMaximum () const

virtual void	SetAutoMinimumMaximumInput (const SimpleDataObjectDecorator< bool > *_arg)

virtual void	SetAutoMinimumMaximum (const bool &_arg)

virtual void	SetAutoMinimumMaximum (const SimpleDataObjectDecorator< bool > *_arg)

virtual const SimpleDataObjectDecorator< bool > *	GetAutoMinimumMaximumInput () const

virtual const bool &	GetAutoMinimumMaximum () const

virtual void	AutoMinimumMaximumOn ()

virtual void	AutoMinimumMaximumOff ()

virtual void	GraftOutput (DataObject *graft)

void	SetNumberOfStreamDivisions (const unsigned int n) override

unsigned int	GetNumberOfStreamDivisions () const override

Public Member Functions inherited from itk::ImageSink< TImage >
virtual const InputImageType *	GetInput () const

virtual const InputImageType *	GetInput (const DataObjectIdentifierType &key) const

virtual const InputImageType *	GetInput (unsigned int idx) const

virtual void	SetInput (const InputImageType *input)

void	Update () override

void	UpdateLargestPossibleRegion () override

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::StreamingProcessObject
void	GenerateData () override

virtual int	GetCurrentRequestNumber () const

void	PropagateRequestedRegion (DataObject *output) override

void	ResetPipeline () override

void	UpdateOutputData (DataObject *output) 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 DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual void	SetAbortGenerateData (bool _arg)

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::Statistics::ImageToHistogramFilter< TImage >
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageSink< TImage >
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 ()

virtual void	SetMaskImage (const MaskImageType *input)

virtual const MaskImageType *	GetMaskImage () const

virtual void	SetMaskValueInput (const SimpleDataObjectDecorator< MaskPixelType > *_arg)

virtual void	SetMaskValue (const MaskPixelType &_arg)

virtual void	SetMaskValue (const SimpleDataObjectDecorator< MaskPixelType > *_arg)

virtual const SimpleDataObjectDecorator< MaskPixelType > *	GetMaskValueInput () const

virtual const MaskPixelType &	GetMaskValue () const

	MaskedImageToHistogramFilter ()

	~MaskedImageToHistogramFilter () override=default

void	ThreadedStreamedGenerateData (const RegionType &inputRegionForThread) override

void	ThreadedComputeMinimumAndMaximum (const RegionType &inputRegionForThread) override

Additional Inherited Members
Static Public Attributes inherited from itk::ImageSink< TImage >
static constexpr unsigned int	InputImageDimension

Protected Types inherited from itk::Statistics::ImageToHistogramFilter< TImage >
using	DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType

Protected Member Functions inherited from itk::Statistics::ImageToHistogramFilter< TImage >
	ImageToHistogramFilter ()

	~ImageToHistogramFilter () override=default

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

void	StreamedGenerateData (unsigned int inputRequestedRegionNumber) override

void	InitializeOutputHistogram ()

void	AfterStreamedGenerateData () override

DataObject::Pointer	MakeOutput (DataObjectPointerArraySizeType) override

unsigned int	GetNumberOfInputRequestedRegions () override

void	ThreadedStreamedGenerateData (const RegionType &) override

virtual void	ThreadedMergeHistogram (HistogramPointer &&histogram)

Protected Member Functions inherited from itk::ImageSink< TImage >
	ImageSink ()

	~ImageSink () override=default

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

unsigned int	GetNumberOfInputRequestedRegions () override

void	GenerateNthInputRequestedRegion (unsigned int inputRequestedRegionNumber) override

virtual void	AllocateOutputs ()

void	VerifyInputInformation () ITKv5_CONST override

void	BeforeStreamedGenerateData () override

void	StreamedGenerateData (unsigned int inputRequestedRegionNumber) override

virtual void	ThreadedStreamedGenerateData (const InputImageRegionType &inputRegionForChunk)=0

virtual void	SetRegionSplitter (SplitterType *_arg)

virtual SplitterType *	GetModifiableRegionSplitter ()

virtual const SplitterType *	GetRegionSplitter () const

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

	~StreamingProcessObject () override

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	PushBackInput (const DataObject *input)

virtual void	PopBackInput ()

virtual void	PushFrontInput (const DataObject *input)

virtual void	PopFrontInput ()

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

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

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::Statistics::ImageToHistogramFilter< TImage >
std::mutex	m_Mutex

HistogramPointer	m_MergeHistogram

HistogramMeasurementVectorType	m_Minimum

HistogramMeasurementVectorType	m_Maximum

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 TImage, typename TMaskImage>
class itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >

Generate a histogram from the masked pixels of an image.

This class expands the features of the ImageToHistogramFilter by adding a required MaskImage input image. Only the pixel in the input image where the MaskImage's value is the MaskValue will be added to the computed histogram.

ITK Sphinx Examples:

All ITK Sphinx Examples

Compute Histogram Of Masked Region In Image

Examples: SphinxExamples/src/Numerics/Statistics/ComputeHistogramOfMaskedRegion/Code.cxx.

Definition at line 46 of file itkMaskedImageToHistogramFilter.h.