ITK  5.4.0
Insight 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
Group Numerics » Module ITKStatistics

#include <itkImageToHistogramFilter.h>

Detailed Description

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

This class generates a 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.

This filter is automatically multi-threaded. When AutoMinimumMaximum is off and the NumberOfStreamDivisions is set to more than one, then this filter streams its input in a series of requested regions. A histogram is computed for each streamed and threaded region then merged.

Examples
Examples/Statistics/ImageHistogram3.cxx, Examples/Statistics/ImageHistogram4.cxx, Examples/Statistics/ImageMutualInformation1.cxx, and SphinxExamples/src/Numerics/Statistics/ComputeHistogramFromGrayscaleImage/Code.cxx.

Definition at line 50 of file itkImageToHistogramFilter.h.

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

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 = ImageSink< TImage >
 
using ValueRealType = typename NumericTraits< ValueType >::RealType
 
using ValueType = typename NumericTraits< PixelType >::ValueType
 
- Public Types inherited from itk::ImageSink< 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 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

const char * GetNameOfClass () const override
 
unsigned int GetNumberOfStreamDivisions () const override
 
virtual void GraftOutput (DataObject *graft)
 
virtual void SetHistogramSizeInput (const SimpleDataObjectDecorator< HistogramSizeType > *_arg)
 
virtual void SetMarginalScaleInput (const SimpleDataObjectDecorator< HistogramMeasurementType > *_arg)
 
void SetNumberOfStreamDivisions (const unsigned int n) override
 
const HistogramType * GetOutput () const
 
HistogramType * GetOutput ()
 
virtual void SetHistogramBinMinimumInput (const SimpleDataObjectDecorator< HistogramMeasurementVectorType > *_arg)
 
virtual void SetHistogramBinMaximumInput (const SimpleDataObjectDecorator< HistogramMeasurementVectorType > *_arg)
 
virtual void SetAutoMinimumMaximumInput (const SimpleDataObjectDecorator< bool > *_arg)
 
virtual void AutoMinimumMaximumOn ()
 
- 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
 
const char * GetNameOfClass () const override
 
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 AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderType * GetMultiThreader () const
 
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 PrepareOutputs ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
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 SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdType & GetNumberOfWorkUnits () const
 
- 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
 
LightObject::Pointer CreateAnother () const override
 
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::ImageSink< TImage >
static double GetGlobalDefaultCoordinateTolerance ()
 
static double GetGlobalDefaultDirectionTolerance ()
 
static void SetGlobalDefaultCoordinateTolerance (double)
 
static void SetGlobalDefaultDirectionTolerance (double)
 
- 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 ()
 

Protected Types

using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType
 

Protected Member Functions

void AfterStreamedGenerateData () override
 
unsigned int GetNumberOfInputRequestedRegions () override
 
 ImageToHistogramFilter ()
 
void InitializeOutputHistogram ()
 
DataObject::Pointer MakeOutput (DataObjectPointerArraySizeType) override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void StreamedGenerateData (unsigned int inputRequestedRegionNumber) override
 
virtual void ThreadedComputeMinimumAndMaximum (const RegionType &inputRegionForThread)
 
virtual void ThreadedMergeHistogram (HistogramPointer &&histogram)
 
void ThreadedStreamedGenerateData (const RegionType &) override
 
 ~ImageToHistogramFilter () override=default
 
- Protected Member Functions inherited from itk::ImageSink< TImage >
virtual void AllocateOutputs ()
 
void BeforeStreamedGenerateData () override
 
void GenerateNthInputRequestedRegion (unsigned int inputRequestedRegionNumber) override
 
unsigned int GetNumberOfInputRequestedRegions () override
 
 ImageSink ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void StreamedGenerateData (unsigned int inputRequestedRegionNumber) override
 
virtual void ThreadedStreamedGenerateData (const InputImageRegionType &inputRegionForChunk)=0
 
void VerifyInputInformation () ITKv5_CONST override
 
 ~ImageSink () override=default
 
virtual void SetRegionSplitter (SplitterType *_arg)
 
virtual SplitterType * GetModifiableRegionSplitter ()
 
- Protected Member Functions inherited from itk::StreamingProcessObject
 StreamingProcessObject ()
 
 ~StreamingProcessObject () 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 GenerateInputRequestedRegion ()
 
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
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
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 idx, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *object)
 
virtual void SetPrimaryOutput (DataObject *object)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyPreconditions () ITKv5_CONST
 
 ~ProcessObject () override
 
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 () const
 
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
 
DataObject * GetPrimaryOutput ()
 
const DataObject * GetPrimaryOutput () const
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~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::ImageSink< TImage >
static constexpr unsigned int InputImageDimension
 
- Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 59 of file itkImageToHistogramFilter.h.

◆ DataObjectPointerArraySizeType

template<typename TImage >
using itk::Statistics::ImageToHistogramFilter< TImage >::DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType
protected

Method that construct the outputs

Definition at line 161 of file itkImageToHistogramFilter.h.

◆ HistogramConstPointer

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

Definition at line 75 of file itkImageToHistogramFilter.h.

◆ HistogramMeasurementType

template<typename TImage >
using itk::Statistics::ImageToHistogramFilter< TImage >::HistogramMeasurementType = typename HistogramType::MeasurementType

Definition at line 77 of file itkImageToHistogramFilter.h.

◆ HistogramMeasurementVectorType

template<typename TImage >
using itk::Statistics::ImageToHistogramFilter< TImage >::HistogramMeasurementVectorType = typename HistogramType::MeasurementVectorType

Definition at line 78 of file itkImageToHistogramFilter.h.

◆ HistogramPointer

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

Definition at line 74 of file itkImageToHistogramFilter.h.

◆ HistogramSizeType

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

Definition at line 76 of file itkImageToHistogramFilter.h.

◆ HistogramType

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

Definition at line 73 of file itkImageToHistogramFilter.h.

◆ ImageType

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

Definition at line 67 of file itkImageToHistogramFilter.h.

◆ InputBooleanObjectType

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

Type of DataObjects to use for AutoMinimumMaximum input

Definition at line 99 of file itkImageToHistogramFilter.h.

◆ InputHistogramMeasurementObjectType

template<typename TImage >
using itk::Statistics::ImageToHistogramFilter< TImage >::InputHistogramMeasurementObjectType = SimpleDataObjectDecorator<HistogramMeasurementType>

Type of DataObjects to use for Marginal Scale inputs

Definition at line 92 of file itkImageToHistogramFilter.h.

◆ InputHistogramMeasurementVectorObjectType

template<typename TImage >
using itk::Statistics::ImageToHistogramFilter< TImage >::InputHistogramMeasurementVectorObjectType = SimpleDataObjectDecorator<HistogramMeasurementVectorType>

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

Definition at line 96 of file itkImageToHistogramFilter.h.

◆ InputHistogramSizeObjectType

template<typename TImage >
using itk::Statistics::ImageToHistogramFilter< TImage >::InputHistogramSizeObjectType = SimpleDataObjectDecorator<HistogramSizeType>

Type of DataObjects to use for Size inputs

Definition at line 89 of file itkImageToHistogramFilter.h.

◆ PixelType

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

Definition at line 68 of file itkImageToHistogramFilter.h.

◆ Pointer

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

Definition at line 58 of file itkImageToHistogramFilter.h.

◆ RegionType

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

Definition at line 69 of file itkImageToHistogramFilter.h.

◆ Self

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

Standard type alias

Definition at line 56 of file itkImageToHistogramFilter.h.

◆ Superclass

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

Definition at line 57 of file itkImageToHistogramFilter.h.

◆ ValueRealType

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

Definition at line 71 of file itkImageToHistogramFilter.h.

◆ ValueType

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

Definition at line 70 of file itkImageToHistogramFilter.h.

Constructor & Destructor Documentation

◆ ImageToHistogramFilter()

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

◆ ~ImageToHistogramFilter()

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

Member Function Documentation

◆ AfterStreamedGenerateData()

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

Called after all requested regions have been process.

Reimplemented from itk::StreamingProcessObject.

◆ ApplyMarginalScale()

template<typename TImage >
void itk::Statistics::ImageToHistogramFilter< TImage >::ApplyMarginalScale ( HistogramMeasurementVectorType &  min,
HistogramMeasurementVectorType &  max,
HistogramSizeType &  size 
)
private

◆ AutoMinimumMaximumOn()

template<typename TImage >
virtual void itk::Statistics::ImageToHistogramFilter< TImage >::AutoMinimumMaximumOn ( )
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

◆ GetNameOfClass()

template<typename TImage >
const char* itk::Statistics::ImageToHistogramFilter< TImage >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::StreamingProcessObject.

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

◆ GetNumberOfInputRequestedRegions()

template<typename TImage >
unsigned int itk::Statistics::ImageToHistogramFilter< TImage >::GetNumberOfInputRequestedRegions ( )
overrideprotectedvirtual

Return the actual number of regions to request upstream.

This method can be overloaded to return one, when a derived filter is unable stream.

Implements itk::StreamingProcessObject.

◆ GetNumberOfStreamDivisions()

template<typename TImage >
unsigned int itk::Statistics::ImageToHistogramFilter< TImage >::GetNumberOfStreamDivisions ( ) const
inlineoverridevirtual

Get the number of pieces to divide the input. The upstream pipeline will be executed this many times.

Reimplemented from itk::ImageSink< TImage >.

Definition at line 141 of file itkImageToHistogramFilter.h.

◆ GetOutput() [1/2]

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

Return the output histogram.

◆ GetOutput() [2/2]

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

Return the output histogram.

◆ GraftOutput()

template<typename TImage >
virtual void itk::Statistics::ImageToHistogramFilter< TImage >::GraftOutput ( DataObject *  graft)
virtual

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

◆ InitializeOutputHistogram()

template<typename TImage >
void itk::Statistics::ImageToHistogramFilter< TImage >::InitializeOutputHistogram ( )
protected

◆ MakeOutput()

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.

◆ New()

template<typename TImage >
static Pointer itk::Statistics::ImageToHistogramFilter< TImage >::New ( )
static

standard New() method support

◆ PrintSelf()

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::StreamingProcessObject.

◆ SetAutoMinimumMaximumInput()

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

◆ SetHistogramBinMaximumInput()

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.

◆ SetHistogramBinMinimumInput()

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.

◆ SetHistogramSizeInput()

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

◆ SetMarginalScaleInput()

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 components are of integer type.

◆ SetNumberOfStreamDivisions()

template<typename TImage >
void itk::Statistics::ImageToHistogramFilter< TImage >::SetNumberOfStreamDivisions ( const unsigned int  _arg)
inlineoverridevirtual

Set the number of pieces to divide the input. The upstream pipeline will be executed this many times.

Reimplemented from itk::ImageSink< TImage >.

Definition at line 136 of file itkImageToHistogramFilter.h.

◆ StreamedGenerateData()

template<typename TImage >
void itk::Statistics::ImageToHistogramFilter< TImage >::StreamedGenerateData ( unsigned int  inputRequestedRegionNumber)
overrideprotectedvirtual

This method will be called multiple times for each requested region generated by the input.

Implements itk::StreamingProcessObject.

◆ ThreadedComputeMinimumAndMaximum()

template<typename TImage >
virtual void itk::Statistics::ImageToHistogramFilter< TImage >::ThreadedComputeMinimumAndMaximum ( const RegionType &  inputRegionForThread)
protectedvirtual

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

◆ ThreadedMergeHistogram()

template<typename TImage >
virtual void itk::Statistics::ImageToHistogramFilter< TImage >::ThreadedMergeHistogram ( HistogramPointer &&  histogram)
protectedvirtual

◆ ThreadedStreamedGenerateData()

template<typename TImage >
void itk::Statistics::ImageToHistogramFilter< TImage >::ThreadedStreamedGenerateData ( const RegionType &  )
overrideprotected

Member Data Documentation

◆ m_Maximum

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

Definition at line 184 of file itkImageToHistogramFilter.h.

◆ m_MergeHistogram

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

Definition at line 181 of file itkImageToHistogramFilter.h.

◆ m_Minimum

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

Definition at line 183 of file itkImageToHistogramFilter.h.

◆ m_Mutex

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

Definition at line 179 of file itkImageToHistogramFilter.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16