ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes
itk::Statistics::ImageToHistogramFilter< TImage > Class Template Reference

#include <itkImageToHistogramFilter.h>

+ Inheritance diagram for itk::Statistics::ImageToHistogramFilter< TImage >:
+ Collaboration diagram for itk::Statistics::ImageToHistogramFilter< TImage >:

List of all members.

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
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 Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const char * GetNameOfClass () const
virtual void GraftOutput (DataObject *output)
 itkSetGetDecoratedInputMacro (HistogramSize, HistogramSizeType)
 itkSetGetDecoratedInputMacro (MarginalScale, HistogramMeasurementType)
 itkSetGetDecoratedInputMacro (AutoMinimumMaximum, bool)
const HistogramTypeGetOutput () const
HistogramTypeGetOutput ()
 itkSetGetDecoratedInputMacro (HistogramBinMinimum, HistogramMeasurementVectorType)
 itkSetGetDecoratedInputMacro (HistogramBinMaximum, HistogramMeasurementVectorType)

Static Public Member Functions

static Pointer New ()

Protected Types

typedef
ProcessObject::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType

Protected Member Functions

void AfterThreadedGenerateData (void)
void BeforeThreadedGenerateData (void)
 ImageToHistogramFilter ()
DataObject::Pointer MakeOutput (DataObjectPointerArraySizeType)
void PrintSelf (std::ostream &os, Indent indent) const
virtual void ThreadedComputeHistogram (const RegionType &inputRegionForThread, ThreadIdType threadId, ProgressReporter &progress)
virtual void ThreadedComputeMinimumAndMaximum (const RegionType &inputRegionForThread, ThreadIdType threadId, ProgressReporter &progress)
void ThreadedGenerateData (const RegionType &inputRegionForThread, ThreadIdType threadId)
virtual ~ImageToHistogramFilter ()

Protected Attributes

std::vector< HistogramPointerm_Histograms
std::vector
< HistogramMeasurementVectorType
m_Maximums
std::vector
< HistogramMeasurementVectorType
m_Minimums

Private Member Functions

void ApplyMarginalScale (HistogramMeasurementVectorType &min, HistogramMeasurementVectorType &max, HistogramSizeType &size)
 ImageToHistogramFilter (const Self &)
void operator= (const Self &)

Private Attributes

Barrier::Pointer m_Barrier

Detailed Description

template<class TImage>
class itk::Statistics::ImageToHistogramFilter< TImage >

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 43 of file itkImageToHistogramFilter.h.


Member Typedef Documentation

template<class TImage >
typedef SmartPointer< const Self > itk::Statistics::ImageToHistogramFilter< TImage >::ConstPointer

Method that construct the outputs

Reimplemented from itk::ProcessObject.

Definition at line 132 of file itkImageToHistogramFilter.h.

template<class TImage >
typedef Histogram< ValueRealType > itk::Statistics::ImageToHistogramFilter< TImage >::HistogramType
template<class TImage >
typedef TImage itk::Statistics::ImageToHistogramFilter< TImage >::ImageType

Type of DataObjects to use for AutoMinimumMaximum input

Definition at line 92 of file itkImageToHistogramFilter.h.

Type of DataObjects to use for Marginal Scale inputs

Definition at line 84 of file itkImageToHistogramFilter.h.

Type of DataObjects to use for Minimum and Maximums values of the histogram bins.

Definition at line 89 of file itkImageToHistogramFilter.h.

Type of DataObjects to use for Size inputs

Definition at line 80 of file itkImageToHistogramFilter.h.

template<class TImage >
typedef ImageType::PixelType itk::Statistics::ImageToHistogramFilter< TImage >::PixelType
template<class TImage >
typedef SmartPointer< Self > itk::Statistics::ImageToHistogramFilter< TImage >::Pointer
template<class TImage >
typedef ImageType::RegionType itk::Statistics::ImageToHistogramFilter< TImage >::RegionType
template<class TImage >
typedef ImageToHistogramFilter itk::Statistics::ImageToHistogramFilter< TImage >::Self

Standard typedefs

Reimplemented from itk::ImageTransformer< TImage >.

Reimplemented in itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >.

Definition at line 47 of file itkImageToHistogramFilter.h.

template<class TImage >
typedef ImageTransformer<TImage> itk::Statistics::ImageToHistogramFilter< TImage >::Superclass
template<class TImage >
typedef NumericTraits< ValueType >::RealType itk::Statistics::ImageToHistogramFilter< TImage >::ValueRealType
template<class TImage >
typedef NumericTraits< PixelType >::ValueType itk::Statistics::ImageToHistogramFilter< TImage >::ValueType

Constructor & Destructor Documentation

template<class TImage >
itk::Statistics::ImageToHistogramFilter< TImage >::ImageToHistogramFilter ( ) [protected]
template<class TImage >
virtual itk::Statistics::ImageToHistogramFilter< TImage >::~ImageToHistogramFilter ( ) [inline, protected, virtual]

Definition at line 124 of file itkImageToHistogramFilter.h.

template<class TImage >
itk::Statistics::ImageToHistogramFilter< TImage >::ImageToHistogramFilter ( const Self ) [private]

Member Function Documentation

template<class TImage >
void itk::Statistics::ImageToHistogramFilter< TImage >::AfterThreadedGenerateData ( void  ) [protected, virtual]

If an imaging filter needs to perform processing after all processing threads have completed, the filter can can provide an implementation for AfterThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Reimplemented from itk::ImageTransformer< TImage >.

template<class TImage >
void itk::Statistics::ImageToHistogramFilter< TImage >::BeforeThreadedGenerateData ( void  ) [protected, virtual]

If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Reimplemented from itk::ImageTransformer< TImage >.

template<class TImage >
virtual::itk::LightObject::Pointer itk::Statistics::ImageToHistogramFilter< TImage >::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::Object.

Reimplemented in itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >.

template<class TImage >
virtual const char* itk::Statistics::ImageToHistogramFilter< TImage >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::ImageTransformer< TImage >.

Reimplemented in itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >.

template<class TImage >
const HistogramType* itk::Statistics::ImageToHistogramFilter< TImage >::GetOutput ( ) const

Return the output histogram.

template<class TImage >
HistogramType* itk::Statistics::ImageToHistogramFilter< TImage >::GetOutput ( )

Return the output histogram.

template<class TImage >
virtual void itk::Statistics::ImageToHistogramFilter< TImage >::GraftOutput ( DataObject output) [virtual]

Method that facilitates the use of this filter in the internal pipeline of another filter.

template<class TImage >
itk::Statistics::ImageToHistogramFilter< TImage >::itkSetGetDecoratedInputMacro ( HistogramSize  ,
HistogramSizeType   
)

Methods for setting and getting the histogram size. The histogram size is encapsulated inside a decorator class. For this reason, it is possible to set and get the decorator class, but it is only possible to set the histogram size by value. This macro declares the methods SetHistogramSize(), SetHistogramSizeInput(), GetHistogramSizeInput().

template<class TImage >
itk::Statistics::ImageToHistogramFilter< TImage >::itkSetGetDecoratedInputMacro ( MarginalScale  ,
HistogramMeasurementType   
)

Methods for setting and getting the Marginal scale value. The marginal scale is used when the type of the measurement vector componets are of integer type.

template<class TImage >
itk::Statistics::ImageToHistogramFilter< TImage >::itkSetGetDecoratedInputMacro ( HistogramBinMinimum  ,
HistogramMeasurementVectorType   
)

Methods for setting and getting the Minimum and Maximum values of the histogram bins.

template<class TImage >
itk::Statistics::ImageToHistogramFilter< TImage >::itkSetGetDecoratedInputMacro ( HistogramBinMaximum  ,
HistogramMeasurementVectorType   
)

Methods for setting and getting the Minimum and Maximum values of the histogram bins.

template<class TImage >
itk::Statistics::ImageToHistogramFilter< TImage >::itkSetGetDecoratedInputMacro ( AutoMinimumMaximum  ,
bool   
)

Methods for setting and getting the boolean flag that defines whether the minimum and maximum of the histogram are going to be computed automatically from the values of the sample

template<class TImage >
DataObject::Pointer itk::Statistics::ImageToHistogramFilter< TImage >::MakeOutput ( DataObjectPointerArraySizeType  idx) [protected, virtual]

Make a DataObject of the correct type to used as the specified output. Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a itkSmartPointer to a DataObject. ImageSource and MeshSource override this method to create the correct type of image and mesh respectively. If a filter has multiple outputs of different types, then that filter must provide an implementation of MakeOutput().

Reimplemented from itk::ProcessObject.

template<class TImage >
static Pointer itk::Statistics::ImageToHistogramFilter< TImage >::New ( ) [static]

standard New() method support

Reimplemented from itk::Object.

Reimplemented in itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >.

template<class TImage >
void itk::Statistics::ImageToHistogramFilter< TImage >::operator= ( const Self ) [private]

Time when GenerateOutputInformation was last called.

Reimplemented from itk::ImageTransformer< TImage >.

Reimplemented in itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >.

template<class TImage >
void itk::Statistics::ImageToHistogramFilter< TImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

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

Reimplemented from itk::ProcessObject.

template<class TImage >
virtual void itk::Statistics::ImageToHistogramFilter< TImage >::ThreadedComputeHistogram ( const RegionType inputRegionForThread,
ThreadIdType  threadId,
ProgressReporter progress 
) [protected, virtual]
template<class TImage >
virtual void itk::Statistics::ImageToHistogramFilter< TImage >::ThreadedComputeMinimumAndMaximum ( const RegionType inputRegionForThread,
ThreadIdType  threadId,
ProgressReporter progress 
) [protected, virtual]
template<class TImage >
void itk::Statistics::ImageToHistogramFilter< TImage >::ThreadedGenerateData ( const RegionType inputRegionForThread,
ThreadIdType  threadId 
) [protected]

Member Data Documentation

template<class TImage >
Barrier::Pointer itk::Statistics::ImageToHistogramFilter< TImage >::m_Barrier [private]

Definition at line 148 of file itkImageToHistogramFilter.h.

template<class TImage >
std::vector< HistogramPointer > itk::Statistics::ImageToHistogramFilter< TImage >::m_Histograms [protected]

Definition at line 139 of file itkImageToHistogramFilter.h.

template<class TImage >
std::vector< HistogramMeasurementVectorType > itk::Statistics::ImageToHistogramFilter< TImage >::m_Maximums [protected]

Definition at line 141 of file itkImageToHistogramFilter.h.

template<class TImage >
std::vector< HistogramMeasurementVectorType > itk::Statistics::ImageToHistogramFilter< TImage >::m_Minimums [protected]

Definition at line 140 of file itkImageToHistogramFilter.h.


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