#include <itkMaskedImageToHistogramFilter.h>

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

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

Detailed Description

template<typename TImage, typename TMaskImage>
class itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >

This class generates an histogram from an image.

The concept of Histogram in ITK is quite generic. It has been designed to manage multiple components data. This class facilitates the computation of an histogram from an image. Internally it creates a List that is feed into the SampleToHistogramFilter.

Definition at line 42 of file itkMaskedImageToHistogramFilter.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef HistogramType::ConstPointer	HistogramConstPointer

typedef HistogramType::MeasurementType	HistogramMeasurementType

typedef HistogramType::MeasurementVectorType	HistogramMeasurementVectorType

typedef HistogramType::Pointer	HistogramPointer

typedef HistogramType::SizeType	HistogramSizeType

typedef Histogram< ValueRealType >	HistogramType

typedef TImage	ImageType

typedef TMaskImage	MaskImageType

typedef MaskImageType::PixelType	MaskPixelType

typedef ImageType::PixelType	PixelType

typedef SmartPointer< Self >	Pointer

typedef ImageType::RegionType	RegionType

typedef MaskedImageToHistogramFilter	Self

typedef ImageToHistogramFilter < TImage >	Superclass

typedef NumericTraits < ValueType >::RealType	ValueRealType

typedef NumericTraits < PixelType >::ValueType	ValueType

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

typedef HistogramType::ConstPointer	HistogramConstPointer

typedef HistogramType::MeasurementType	HistogramMeasurementType

typedef HistogramType::MeasurementVectorType	HistogramMeasurementVectorType

typedef HistogramType::Pointer	HistogramPointer

typedef HistogramType::SizeType	HistogramSizeType

typedef Histogram< ValueRealType >	HistogramType

typedef TImage	ImageType

typedef SimpleDataObjectDecorator < bool >	InputBooleanObjectType

typedef SimpleDataObjectDecorator < HistogramMeasurementType >	InputHistogramMeasurementObjectType

typedef SimpleDataObjectDecorator < HistogramMeasurementVectorType >	InputHistogramMeasurementVectorObjectType

typedef SimpleDataObjectDecorator < HistogramSizeType >	InputHistogramSizeObjectType

typedef ImageType::PixelType	PixelType

typedef SmartPointer< Self >	Pointer

typedef ImageType::RegionType	RegionType

typedef ImageToHistogramFilter	Self

typedef ImageTransformer< TImage >	Superclass

typedef NumericTraits < ValueType >::RealType	ValueRealType

typedef NumericTraits < PixelType >::ValueType	ValueType

Public Types inherited from itk::ImageTransformer< TImage >
typedef SmartPointer< const Self >	ConstPointer

typedef DataObject::Pointer	DataObjectPointer

typedef InputImageType::PixelType	InputImagePixelType

typedef InputImageType::Pointer	InputImagePointer

typedef InputImageType::RegionType	InputImageRegionType

typedef TImage	InputImageType

typedef SmartPointer< Self >	Pointer

typedef ImageTransformer	Self

typedef ProcessObject	Superclass

Public Types inherited from itk::ProcessObject
typedef SmartPointer< const Self >	ConstPointer

typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef std::vector < DataObjectPointer >	DataObjectPointerArray

typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType

typedef std::vector < DataObjectIdentifierType >	NameArray

typedef SmartPointer< Self >	Pointer

typedef ProcessObject	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual const MaskPixelType &	GetMaskValue () const

virtual const SimpleDataObjectDecorator < MaskPixelType > *	GetMaskValueInput () const

virtual const char *	GetNameOfClass () const

virtual void	SetMaskValue (const MaskPixelType &_arg)

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

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


virtual void	SetMaskImage (const MaskImageType *input)

virtual const MaskImageType *	GetMaskImage () const

Public Member Functions inherited from itk::Statistics::ImageToHistogramFilter< TImage >
virtual const bool &	GetAutoMinimumMaximum () const

virtual const SimpleDataObjectDecorator < bool > *	GetAutoMinimumMaximumInput () const

virtual const HistogramSizeType &	GetHistogramSize () const

virtual const SimpleDataObjectDecorator < HistogramSizeType > *	GetHistogramSizeInput () const

virtual const HistogramMeasurementType &	GetMarginalScale () const

virtual const SimpleDataObjectDecorator < HistogramMeasurementType > *	GetMarginalScaleInput () const

virtual void	GraftOutput (DataObject *output)

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

virtual void	SetAutoMinimumMaximum (const bool &_arg)

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

virtual void	SetHistogramSize (const HistogramSizeType &_arg)

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

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

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

virtual void	SetMarginalScale (const HistogramMeasurementType &_arg)

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

const HistogramType *	GetOutput () const

HistogramType *	GetOutput ()

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

Public Member Functions inherited from itk::ImageTransformer< TImage >
virtual void	SetInput (const InputImageType *image)

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

const InputImageType *	GetInput () const

InputImageType *	GetInput ()

const InputImageType *	GetInput (unsigned int idx) const

virtual void	PushBackInput (const InputImageType *image)

virtual void	PopBackInput () override

virtual void	PushFrontInput (const InputImageType *image)

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

MultiThreader *	GetMultiThreader () const

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual const float &	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual void	PrepareOutputs ()

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)

void	SetProgress (float progress)

virtual void	SetReleaseDataFlag (bool flag)

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	SetNumberOfThreads (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfThreads () const

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

unsigned long	AddObserver (const EventObject &event, Command *) 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

virtual void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

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::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

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

static Pointer	New ()

Protected Member Functions
	MaskedImageToHistogramFilter ()

virtual void	ThreadedComputeHistogram (const RegionType &inputRegionForThread, ThreadIdType threadId, ProgressReporter &progress) override

virtual void	ThreadedComputeMinimumAndMaximum (const RegionType &inputRegionForThread, ThreadIdType threadId, ProgressReporter &progress) override

virtual	~MaskedImageToHistogramFilter ()

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

void	BeforeThreadedGenerateData (void) override

	ImageToHistogramFilter ()

DataObject::Pointer	MakeOutput (DataObjectPointerArraySizeType) override

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

void	ThreadedGenerateData (const RegionType &inputRegionForThread, ThreadIdType threadId) override

virtual	~ImageToHistogramFilter ()

Protected Member Functions inherited from itk::ImageTransformer< TImage >
virtual void	AllocateOutputs ()

virtual void	GenerateData () override

virtual void	GenerateInputRequestedRegion () override

	ImageTransformer ()

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int num, InputImageRegionType &splitRegion)

virtual void	ThreadedGenerateData (const InputImageRegionType &inputRegionForThread, ThreadIdType threadId)

virtual	~ImageTransformer ()

virtual void	PushBackInput (const DataObject *input) override

virtual void	PushFrontInput (const DataObject *input) override

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

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))

	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))

	itkLegacyMacro (virtual void RemoveInput(DataObject *input))

	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

	ProcessObject ()

virtual void	PropagateResetPipeline ()

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 num, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

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

virtual void	SetPrimaryInput (DataObject *input)

virtual void	SetPrimaryOutput (DataObject *output)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyInputInformation ()

virtual void	VerifyPreconditions ()

	~ProcessObject ()

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

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName (void) const

DataObject *	GetOutput (DataObjectPointerArraySizeType idx)

const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

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

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

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

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

Private Member Functions
	MaskedImageToHistogramFilter (const Self &) ITK_DELETE_FUNCTION

void	operator= (const Self &) ITK_DELETE_FUNCTION

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

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

Static Protected Member Functions inherited from itk::ImageTransformer< TImage >
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)

Protected Attributes inherited from itk::Statistics::ImageToHistogramFilter< TImage >
std::vector< HistogramPointer >	m_Histograms

std::vector < HistogramMeasurementVectorType >	m_Maximums

std::vector < HistogramMeasurementVectorType >	m_Minimums

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime

bool	m_Updating

Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount