ITK  4.3.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage > Class Template Reference

#include <itkMaskedImageToHistogramFilter.h>

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

Detailed Description

template<class TImage, class 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 SelfConstPointer
 
typedef HistogramType::ConstPointer HistogramConstPointer
 
typedef
HistogramType::MeasurementType 
HistogramMeasurementType
 
typedef
HistogramType::MeasurementVectorType 
HistogramMeasurementVectorType
 
typedef HistogramType::Pointer HistogramPointer
 
typedef HistogramType::SizeType HistogramSizeType
 
typedef Histogram< ValueRealTypeHistogramType
 
typedef TImage ImageType
 
typedef TMaskImage MaskImageType
 
typedef MaskImageType::PixelType MaskPixelType
 
typedef ImageType::PixelType PixelType
 
typedef SmartPointer< SelfPointer
 
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 SelfConstPointer
 
typedef HistogramType::ConstPointer HistogramConstPointer
 
typedef
HistogramType::MeasurementType 
HistogramMeasurementType
 
typedef
HistogramType::MeasurementVectorType 
HistogramMeasurementVectorType
 
typedef HistogramType::Pointer HistogramPointer
 
typedef HistogramType::SizeType HistogramSizeType
 
typedef Histogram< ValueRealTypeHistogramType
 
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< SelfPointer
 
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 SelfConstPointer
 
typedef DataObject::Pointer DataObjectPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TImage InputImageType
 
typedef SmartPointer< SelfPointer
 
typedef ImageTransformer Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
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< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
 itkSetGetDecoratedInputMacro (MaskValue, MaskPixelType)
 
virtual void SetMaskImage (const MaskImageType *input)
 
virtual const MaskImageTypeGetMaskImage () const
 
- Public Member Functions inherited from itk::Statistics::ImageToHistogramFilter< TImage >
virtual void GraftOutput (DataObject *output)
 
 itkSetGetDecoratedInputMacro (HistogramSize, HistogramSizeType)
 
 itkSetGetDecoratedInputMacro (MarginalScale, HistogramMeasurementType)
 
 itkSetGetDecoratedInputMacro (AutoMinimumMaximum, bool)
 
const HistogramTypeGetOutput () const
 
HistogramTypeGetOutput ()
 
 itkSetGetDecoratedInputMacro (HistogramBinMinimum, HistogramMeasurementVectorType)
 
 itkSetGetDecoratedInputMacro (HistogramBinMaximum, HistogramMeasurementVectorType)
 
- Public Member Functions inherited from itk::ImageTransformer< TImage >
virtual void SetInput (const InputImageType *image)
 
virtual void SetInput (unsigned int, const TImage *image)
 
const InputImageTypeGetInput (void) const
 
InputImageTypeGetInput (void)
 
const InputImageTypeGetInput (unsigned int idx) const
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PopBackInput ()
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void PopFrontInput ()
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData ()
 
NameArray GetInputNames () const
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
virtual const float & GetProgress ()
 
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 SetProgress (float _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float amount)
 
DataObjectPointerArray GetInputs ()
 
DataObjectPointerArray GetOutputs ()
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag ()
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads ()
 
- 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () 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 ()
 

Protected Member Functions

 MaskedImageToHistogramFilter ()
 
virtual void ThreadedComputeHistogram (const RegionType &inputRegionForThread, ThreadIdType threadId, ProgressReporter &progress)
 
virtual void ThreadedComputeMinimumAndMaximum (const RegionType &inputRegionForThread, ThreadIdType threadId, ProgressReporter &progress)
 
virtual ~MaskedImageToHistogramFilter ()
 
- Protected Member Functions inherited from itk::Statistics::ImageToHistogramFilter< TImage >
void AfterThreadedGenerateData (void)
 
void BeforeThreadedGenerateData (void)
 
 ImageToHistogramFilter ()
 
DataObject::Pointer MakeOutput (DataObjectPointerArraySizeType)
 
void PrintSelf (std::ostream &os, Indent indent) const
 
void ThreadedGenerateData (const RegionType &inputRegionForThread, ThreadIdType threadId)
 
virtual ~ImageToHistogramFilter ()
 
- Protected Member Functions inherited from itk::ImageTransformer< TImage >
virtual void AllocateOutputs ()
 
virtual void GenerateData ()
 
virtual void GenerateInputRequestedRegion ()
 
 ImageTransformer ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int num, InputImageRegionType &splitRegion)
 
virtual void ThreadedGenerateData (const InputImageRegionType &inputRegionForThread, ThreadIdType threadId)
 
virtual ~ImageTransformer ()
 
void PushBackInput (const DataObject *input)
 
void PushFrontInput (const DataObject *input)
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs ()
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (void SetNumberOfOutputs(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 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 ()
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs ()
 
- 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 &)
 
void operator= (const Self &)
 

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< HistogramPointerm_Histograms
 
std::vector
< HistogramMeasurementVectorType
m_Maximums
 
std::vector
< HistogramMeasurementVectorType
m_Minimums
 

Member Typedef Documentation

template<class TImage , class TMaskImage >
typedef SmartPointer< const Self > itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >::ConstPointer

Definition at line 49 of file itkMaskedImageToHistogramFilter.h.

template<class TImage , class TMaskImage >
typedef HistogramType::ConstPointer itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >::HistogramConstPointer

Definition at line 65 of file itkMaskedImageToHistogramFilter.h.

template<class TImage , class TMaskImage >
typedef HistogramType::MeasurementType itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >::HistogramMeasurementType

Definition at line 67 of file itkMaskedImageToHistogramFilter.h.

template<class TImage , class TMaskImage >
typedef HistogramType::MeasurementVectorType itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >::HistogramMeasurementVectorType

Definition at line 68 of file itkMaskedImageToHistogramFilter.h.

template<class TImage , class TMaskImage >
typedef HistogramType::Pointer itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >::HistogramPointer

Definition at line 64 of file itkMaskedImageToHistogramFilter.h.

template<class TImage , class TMaskImage >
typedef HistogramType::SizeType itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >::HistogramSizeType

Definition at line 66 of file itkMaskedImageToHistogramFilter.h.

template<class TImage , class TMaskImage >
typedef Histogram< ValueRealType > itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >::HistogramType

Definition at line 63 of file itkMaskedImageToHistogramFilter.h.

template<class TImage , class TMaskImage >
typedef TImage itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >::ImageType

Definition at line 55 of file itkMaskedImageToHistogramFilter.h.

template<class TImage , class TMaskImage >
typedef TMaskImage itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >::MaskImageType

Definition at line 70 of file itkMaskedImageToHistogramFilter.h.

template<class TImage , class TMaskImage >
typedef MaskImageType::PixelType itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >::MaskPixelType

Definition at line 71 of file itkMaskedImageToHistogramFilter.h.

template<class TImage , class TMaskImage >
typedef ImageType::PixelType itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >::PixelType

Definition at line 58 of file itkMaskedImageToHistogramFilter.h.

template<class TImage , class TMaskImage >
typedef SmartPointer< Self > itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >::Pointer

Definition at line 48 of file itkMaskedImageToHistogramFilter.h.

template<class TImage , class TMaskImage >
typedef ImageType::RegionType itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >::RegionType

Definition at line 59 of file itkMaskedImageToHistogramFilter.h.

template<class TImage , class TMaskImage >
typedef MaskedImageToHistogramFilter itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >::Self

Standard typedefs

Definition at line 46 of file itkMaskedImageToHistogramFilter.h.

template<class TImage , class TMaskImage >
typedef ImageToHistogramFilter<TImage> itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >::Superclass

Definition at line 47 of file itkMaskedImageToHistogramFilter.h.

template<class TImage , class TMaskImage >
typedef NumericTraits< ValueType >::RealType itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >::ValueRealType

Definition at line 61 of file itkMaskedImageToHistogramFilter.h.

template<class TImage , class TMaskImage >
typedef NumericTraits< PixelType >::ValueType itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >::ValueType

Definition at line 60 of file itkMaskedImageToHistogramFilter.h.

Constructor & Destructor Documentation

template<class TImage , class TMaskImage >
itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >::MaskedImageToHistogramFilter ( )
protected
template<class TImage , class TMaskImage >
virtual itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >::~MaskedImageToHistogramFilter ( )
inlineprotectedvirtual

Definition at line 85 of file itkMaskedImageToHistogramFilter.h.

template<class TImage , class TMaskImage >
itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >::MaskedImageToHistogramFilter ( const Self )
private

Member Function Documentation

template<class TImage , class TMaskImage >
virtual::itk::LightObject::Pointer itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >::CreateAnother ( void  ) 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::Statistics::ImageToHistogramFilter< TImage >.

template<class TImage , class TMaskImage >
virtual const MaskImageType* itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >::GetMaskImage ( ) const
virtual

Method to set/get the mask

template<class TImage , class TMaskImage >
virtual const char* itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::Statistics::ImageToHistogramFilter< TImage >.

template<class TImage , class TMaskImage >
itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >::itkSetGetDecoratedInputMacro ( MaskValue  ,
MaskPixelType   
)

Set the pixel value treated as on in the mask. Only pixels with this value will be added to the histogram.

template<class TImage , class TMaskImage >
static Pointer itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >::New ( )
static

standard New() method support

template<class TImage , class TMaskImage >
void itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >::operator= ( const Self )
private
template<class TImage , class TMaskImage >
virtual void itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >::SetMaskImage ( const MaskImageType input)
virtual

Method to set/get the mask

template<class TImage , class TMaskImage >
virtual void itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >::ThreadedComputeHistogram ( const RegionType inputRegionForThread,
ThreadIdType  threadId,
ProgressReporter progress 
)
protectedvirtual
template<class TImage , class TMaskImage >
virtual void itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >::ThreadedComputeMinimumAndMaximum ( const RegionType inputRegionForThread,
ThreadIdType  threadId,
ProgressReporter progress 
)
protectedvirtual

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