ITK  5.0.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 | List of all members
itk::Statistics::ImageToHistogramFilter< TImage > Class Template Reference

#include <itkImageToHistogramFilter.h>

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

Detailed Description

template<typename 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.

Examples:
Examples/Statistics/ImageHistogram3.cxx, Examples/Statistics/ImageHistogram4.cxx, Examples/Statistics/ImageMutualInformation1.cxx, SphinxExamples/src/Numerics/Statistics/ComputeHistogramFromGrayscaleImage/Code.cxx, WikiExamples/Statistics/ImageToHistogramFilterGrayscale.cxx, WikiExamples/Statistics/ImageToHistogramFilterRGB.cxx, and WikiExamples/Statistics/ImageToHistogramFilterVectorImage.cxx.

Definition at line 44 of file itkImageToHistogramFilter.h.

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 InputBooleanObjectType = SimpleDataObjectDecorator< bool >
 
using InputHistogramMeasurementObjectType = SimpleDataObjectDecorator< HistogramMeasurementType >
 
using InputHistogramMeasurementVectorObjectType = SimpleDataObjectDecorator< HistogramMeasurementVectorType >
 
using InputHistogramSizeObjectType = SimpleDataObjectDecorator< HistogramSizeType >
 
using PixelType = typename ImageType::PixelType
 
using Pointer = SmartPointer< Self >
 
using RegionType = typename ImageType::RegionType
 
using Self = ImageToHistogramFilter
 
using Superclass = ImageTransformer< TImage >
 
using ValueRealType = typename NumericTraits< ValueType >::RealType
 
using ValueType = typename NumericTraits< PixelType >::ValueType
 
- Public Types inherited from itk::ImageTransformer< TImage >
using ConstPointer = SmartPointer< const Self >
 
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 Self = ImageTransformer
 
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 bool & GetAutoMinimumMaximum () const
 
virtual const
SimpleDataObjectDecorator
< bool > * 
GetAutoMinimumMaximumInput () const
 
virtual const HistogramSizeTypeGetHistogramSize () const
 
virtual const
SimpleDataObjectDecorator
< HistogramSizeType > * 
GetHistogramSizeInput () const
 
virtual const
HistogramMeasurementType
GetMarginalScale () const
 
virtual const
SimpleDataObjectDecorator
< HistogramMeasurementType > * 
GetMarginalScaleInput () const
 
virtual const char * GetNameOfClass () 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 HistogramTypeGetOutput () const
 
HistogramTypeGetOutput ()
 
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 InputImageTypeGetInput () const
 
InputImageTypeGetInput ()
 
const InputImageTypeGetInput (unsigned int idx) const
 
virtual void PushBackInput (const InputImageType *image)
 
void PopBackInput () override
 
virtual void PushFrontInput (const InputImageType *image)
 
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 ()
 
MultiThreaderTypeGetMultiThreader () 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)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (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 SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () 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
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexceptoverride
 
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
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::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 Types

using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType
 

Protected Member Functions

void AfterThreadedGenerateData () override
 
void BeforeThreadedGenerateData () override
 
void GenerateData () override
 
 ImageToHistogramFilter ()
 
DataObject::Pointer MakeOutput (DataObjectPointerArraySizeType) override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void ThreadedComputeHistogram (const RegionType &)
 
virtual void ThreadedComputeMinimumAndMaximum (const RegionType &inputRegionForThread)
 
virtual void ThreadedMergeHistogram (HistogramPointer &&histogram)
 
 ~ImageToHistogramFilter () override=default
 
- Protected Member Functions inherited from itk::ImageTransformer< TImage >
virtual void AllocateOutputs ()
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
void GenerateData () override
 
void GenerateInputRequestedRegion () override
 
 ImageTransformer ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int num, InputImageRegionType &splitRegion)
 
virtual void ThreadedGenerateData (const InputImageRegionType &inputRegionForThread, ThreadIdType threadId)
 
 ~ImageTransformer () override=default
 
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
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)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (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
 
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 () ITKv5_CONST
 
virtual void VerifyPreconditions () ITKv5_CONST
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
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
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
 ~Object () override
 
- 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 ()
 

Protected Attributes

HistogramMeasurementVectorType m_Maximum
 
HistogramPointer m_MergeHistogram
 
HistogramMeasurementVectorType m_Minimum
 
std::mutex m_Mutex
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Private Member Functions

void ApplyMarginalScale (HistogramMeasurementVectorType &min, HistogramMeasurementVectorType &max, HistogramSizeType &size)
 

Additional Inherited Members

- Static Public Attributes inherited from itk::ImageTransformer< TImage >
static constexpr unsigned int InputImageDimension
 
- Static Protected Member Functions inherited from itk::ImageTransformer< TImage >
static
ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION 
ThreaderCallback (void *arg)
 

Member Typedef Documentation

template<typename TImage >
using itk::Statistics::ImageToHistogramFilter< TImage >::ConstPointer = SmartPointer< const Self >

Definition at line 53 of file itkImageToHistogramFilter.h.

Method that construct the outputs

Definition at line 132 of file itkImageToHistogramFilter.h.

template<typename TImage >
using itk::Statistics::ImageToHistogramFilter< TImage >::HistogramConstPointer = typename HistogramType::ConstPointer

Definition at line 69 of file itkImageToHistogramFilter.h.

Definition at line 71 of file itkImageToHistogramFilter.h.

Definition at line 72 of file itkImageToHistogramFilter.h.

template<typename TImage >
using itk::Statistics::ImageToHistogramFilter< TImage >::HistogramPointer = typename HistogramType::Pointer

Definition at line 68 of file itkImageToHistogramFilter.h.

template<typename TImage >
using itk::Statistics::ImageToHistogramFilter< TImage >::HistogramSizeType = typename HistogramType::SizeType

Definition at line 70 of file itkImageToHistogramFilter.h.

template<typename TImage >
using itk::Statistics::ImageToHistogramFilter< TImage >::HistogramType = Histogram< ValueRealType >

Definition at line 67 of file itkImageToHistogramFilter.h.

template<typename TImage >
using itk::Statistics::ImageToHistogramFilter< TImage >::ImageType = TImage

Definition at line 61 of file itkImageToHistogramFilter.h.

template<typename TImage >
using itk::Statistics::ImageToHistogramFilter< TImage >::InputBooleanObjectType = SimpleDataObjectDecorator< bool >

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

template<typename TImage >
using itk::Statistics::ImageToHistogramFilter< TImage >::PixelType = typename ImageType::PixelType

Definition at line 62 of file itkImageToHistogramFilter.h.

template<typename TImage >
using itk::Statistics::ImageToHistogramFilter< TImage >::Pointer = SmartPointer< Self >

Definition at line 52 of file itkImageToHistogramFilter.h.

template<typename TImage >
using itk::Statistics::ImageToHistogramFilter< TImage >::RegionType = typename ImageType::RegionType

Definition at line 63 of file itkImageToHistogramFilter.h.

template<typename TImage >
using itk::Statistics::ImageToHistogramFilter< TImage >::Self = ImageToHistogramFilter

Standard type alias

Definition at line 50 of file itkImageToHistogramFilter.h.

template<typename TImage >
using itk::Statistics::ImageToHistogramFilter< TImage >::Superclass = ImageTransformer<TImage>

Definition at line 51 of file itkImageToHistogramFilter.h.

template<typename TImage >
using itk::Statistics::ImageToHistogramFilter< TImage >::ValueRealType = typename NumericTraits< ValueType >::RealType

Definition at line 65 of file itkImageToHistogramFilter.h.

template<typename TImage >
using itk::Statistics::ImageToHistogramFilter< TImage >::ValueType = typename NumericTraits< PixelType >::ValueType

Definition at line 64 of file itkImageToHistogramFilter.h.

Constructor & Destructor Documentation

template<typename TImage >
itk::Statistics::ImageToHistogramFilter< TImage >::ImageToHistogramFilter ( )
protected
template<typename TImage >
itk::Statistics::ImageToHistogramFilter< TImage >::~ImageToHistogramFilter ( )
overrideprotecteddefault

Member Function Documentation

template<typename TImage >
void itk::Statistics::ImageToHistogramFilter< TImage >::AfterThreadedGenerateData ( )
overrideprotectedvirtual

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<typename TImage >
void itk::Statistics::ImageToHistogramFilter< TImage >::ApplyMarginalScale ( HistogramMeasurementVectorType min,
HistogramMeasurementVectorType max,
HistogramSizeType size 
)
private
template<typename TImage >
void itk::Statistics::ImageToHistogramFilter< TImage >::BeforeThreadedGenerateData ( )
overrideprotectedvirtual

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

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

template<typename TImage >
void itk::Statistics::ImageToHistogramFilter< TImage >::GenerateData ( void  )
overrideprotectedvirtual

This method causes the filter to generate its output.

Reimplemented from itk::ProcessObject.

template<typename TImage >
virtual const bool& itk::Statistics::ImageToHistogramFilter< TImage >::GetAutoMinimumMaximum ( ) const
virtual
template<typename TImage >
virtual const SimpleDataObjectDecorator< bool >* itk::Statistics::ImageToHistogramFilter< TImage >::GetAutoMinimumMaximumInput ( ) const
virtual
template<typename TImage >
virtual const HistogramMeasurementVectorType& itk::Statistics::ImageToHistogramFilter< TImage >::GetHistogramBinMaximum ( ) const
virtual

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

template<typename TImage >
virtual const SimpleDataObjectDecorator< HistogramMeasurementVectorType >* itk::Statistics::ImageToHistogramFilter< TImage >::GetHistogramBinMaximumInput ( ) const
virtual

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

template<typename TImage >
virtual const HistogramMeasurementVectorType& itk::Statistics::ImageToHistogramFilter< TImage >::GetHistogramBinMinimum ( ) const
virtual

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

template<typename TImage >
virtual const SimpleDataObjectDecorator< HistogramMeasurementVectorType >* itk::Statistics::ImageToHistogramFilter< TImage >::GetHistogramBinMinimumInput ( ) const
virtual

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

template<typename TImage >
virtual const HistogramSizeType& itk::Statistics::ImageToHistogramFilter< TImage >::GetHistogramSize ( ) const
virtual
template<typename TImage >
virtual const SimpleDataObjectDecorator< HistogramSizeType >* itk::Statistics::ImageToHistogramFilter< TImage >::GetHistogramSizeInput ( ) const
virtual
template<typename TImage >
virtual const HistogramMeasurementType& itk::Statistics::ImageToHistogramFilter< TImage >::GetMarginalScale ( ) const
virtual
template<typename TImage >
virtual const SimpleDataObjectDecorator< HistogramMeasurementType >* itk::Statistics::ImageToHistogramFilter< TImage >::GetMarginalScaleInput ( ) const
virtual
template<typename 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<typename TImage >
const HistogramType* itk::Statistics::ImageToHistogramFilter< TImage >::GetOutput ( ) const

Return the output histogram.

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

Return the output histogram.

template<typename 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<typename TImage >
DataObject::Pointer itk::Statistics::ImageToHistogramFilter< TImage >::MakeOutput ( DataObjectPointerArraySizeType  idx)
overrideprotectedvirtual

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

standard New() method support

template<typename TImage >
void itk::Statistics::ImageToHistogramFilter< TImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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<typename TImage >
virtual void itk::Statistics::ImageToHistogramFilter< TImage >::SetAutoMinimumMaximum ( const bool &  _arg)
virtual
template<typename TImage >
virtual void itk::Statistics::ImageToHistogramFilter< TImage >::SetAutoMinimumMaximum ( const SimpleDataObjectDecorator< bool > *  _arg)
virtual
template<typename TImage >
virtual void itk::Statistics::ImageToHistogramFilter< TImage >::SetAutoMinimumMaximumInput ( const SimpleDataObjectDecorator< bool > *  _arg)
virtual

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<typename TImage >
virtual void itk::Statistics::ImageToHistogramFilter< TImage >::SetHistogramBinMaximum ( const HistogramMeasurementVectorType _arg)
virtual

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

template<typename TImage >
virtual void itk::Statistics::ImageToHistogramFilter< TImage >::SetHistogramBinMaximum ( const SimpleDataObjectDecorator< HistogramMeasurementVectorType > *  _arg)
virtual

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

template<typename TImage >
virtual void itk::Statistics::ImageToHistogramFilter< TImage >::SetHistogramBinMaximumInput ( const SimpleDataObjectDecorator< HistogramMeasurementVectorType > *  _arg)
virtual

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

template<typename TImage >
virtual void itk::Statistics::ImageToHistogramFilter< TImage >::SetHistogramBinMinimum ( const SimpleDataObjectDecorator< HistogramMeasurementVectorType > *  _arg)
virtual

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

template<typename TImage >
virtual void itk::Statistics::ImageToHistogramFilter< TImage >::SetHistogramBinMinimum ( const HistogramMeasurementVectorType _arg)
virtual

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

template<typename TImage >
virtual void itk::Statistics::ImageToHistogramFilter< TImage >::SetHistogramBinMinimumInput ( const SimpleDataObjectDecorator< HistogramMeasurementVectorType > *  _arg)
virtual

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

template<typename TImage >
virtual void itk::Statistics::ImageToHistogramFilter< TImage >::SetHistogramSize ( const SimpleDataObjectDecorator< HistogramSizeType > *  _arg)
virtual
template<typename TImage >
virtual void itk::Statistics::ImageToHistogramFilter< TImage >::SetHistogramSize ( const HistogramSizeType _arg)
virtual
template<typename TImage >
virtual void itk::Statistics::ImageToHistogramFilter< TImage >::SetHistogramSizeInput ( const SimpleDataObjectDecorator< HistogramSizeType > *  _arg)
virtual

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<typename TImage >
virtual void itk::Statistics::ImageToHistogramFilter< TImage >::SetMarginalScale ( const SimpleDataObjectDecorator< HistogramMeasurementType > *  _arg)
virtual
template<typename TImage >
virtual void itk::Statistics::ImageToHistogramFilter< TImage >::SetMarginalScale ( const HistogramMeasurementType _arg)
virtual
template<typename TImage >
virtual void itk::Statistics::ImageToHistogramFilter< TImage >::SetMarginalScaleInput ( const SimpleDataObjectDecorator< HistogramMeasurementType > *  _arg)
virtual

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<typename TImage >
virtual void itk::Statistics::ImageToHistogramFilter< TImage >::ThreadedComputeHistogram ( const RegionType )
protectedvirtual
template<typename TImage >
virtual void itk::Statistics::ImageToHistogramFilter< TImage >::ThreadedComputeMinimumAndMaximum ( const RegionType inputRegionForThread)
protectedvirtual
template<typename TImage >
virtual void itk::Statistics::ImageToHistogramFilter< TImage >::ThreadedMergeHistogram ( HistogramPointer &&  histogram)
protectedvirtual

Member Data Documentation

template<typename TImage >
HistogramMeasurementVectorType itk::Statistics::ImageToHistogramFilter< TImage >::m_Maximum
protected

Definition at line 147 of file itkImageToHistogramFilter.h.

template<typename TImage >
HistogramPointer itk::Statistics::ImageToHistogramFilter< TImage >::m_MergeHistogram
protected

Definition at line 144 of file itkImageToHistogramFilter.h.

template<typename TImage >
HistogramMeasurementVectorType itk::Statistics::ImageToHistogramFilter< TImage >::m_Minimum
protected

Definition at line 146 of file itkImageToHistogramFilter.h.

template<typename TImage >
std::mutex itk::Statistics::ImageToHistogramFilter< TImage >::m_Mutex
protected

Definition at line 142 of file itkImageToHistogramFilter.h.


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