ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::Statistics::ScalarImageToHistogramGenerator< TImageType > Class Template Reference

#include <itkScalarImageToHistogramGenerator.h>

+ Inheritance diagram for itk::Statistics::ScalarImageToHistogramGenerator< TImageType >:
+ Collaboration diagram for itk::Statistics::ScalarImageToHistogramGenerator< TImageType >:

Public Types

using AdaptorPointer = typename AdaptorType::Pointer
 
using AdaptorType = itk::Statistics::ImageToListSampleAdaptor< ImageType >
 
using ConstPointer = SmartPointer< const Self >
 
using GeneratorPointer = typename GeneratorType::Pointer
 
using GeneratorType = itk::Statistics::SampleToHistogramFilter< AdaptorType, HistogramType >
 
using HistogramConstPointer = typename HistogramType::ConstPointer
 
using HistogramPointer = typename HistogramType::Pointer
 
using HistogramType = itk::Statistics::Histogram< double >
 
using ImageType = TImageType
 
using PixelType = typename ImageType::PixelType
 
using Pointer = SmartPointer< Self >
 
using RealPixelType = typename NumericTraits< PixelType >::RealType
 
using Self = ScalarImageToHistogramGenerator
 
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

void Compute ()
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
const HistogramTypeGetOutput () const
 
void SetAutoHistogramMinimumMaximum (bool autoOnOff)
 
void SetHistogramMax (RealPixelType maximumValue)
 
void SetHistogramMin (RealPixelType minimumValue)
 
void SetInput (const ImageType *)
 
void SetMarginalScale (double marginalScale)
 
void SetNumberOfBins (unsigned int numberOfBins)
 
- 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 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
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 Member Functions

void PrintSelf (std::ostream &os, Indent indent) const override
 
 ScalarImageToHistogramGenerator ()
 
 ~ScalarImageToHistogramGenerator () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 Attributes

GeneratorPointer m_HistogramGenerator
 
AdaptorPointer m_ImageToListSampleAdaptor
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<typename TImageType>
class itk::Statistics::ScalarImageToHistogramGenerator< TImageType >

TODO.

Examples
Examples/Filtering/OtsuMultipleThresholdImageFilter.cxx, Examples/Statistics/ImageEntropy1.cxx, and Examples/Statistics/ImageHistogram2.cxx.

Definition at line 37 of file itkScalarImageToHistogramGenerator.h.

Member Typedef Documentation

◆ AdaptorPointer

template<typename TImageType >
using itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::AdaptorPointer = typename AdaptorType::Pointer

Definition at line 56 of file itkScalarImageToHistogramGenerator.h.

◆ AdaptorType

Definition at line 55 of file itkScalarImageToHistogramGenerator.h.

◆ ConstPointer

template<typename TImageType >
using itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::ConstPointer = SmartPointer<const Self>

Definition at line 46 of file itkScalarImageToHistogramGenerator.h.

◆ GeneratorPointer

template<typename TImageType >
using itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::GeneratorPointer = typename GeneratorType::Pointer

Definition at line 63 of file itkScalarImageToHistogramGenerator.h.

◆ GeneratorType

Definition at line 61 of file itkScalarImageToHistogramGenerator.h.

◆ HistogramConstPointer

template<typename TImageType >
using itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::HistogramConstPointer = typename HistogramType::ConstPointer

Definition at line 66 of file itkScalarImageToHistogramGenerator.h.

◆ HistogramPointer

template<typename TImageType >
using itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::HistogramPointer = typename HistogramType::Pointer

Definition at line 65 of file itkScalarImageToHistogramGenerator.h.

◆ HistogramType

template<typename TImageType >
using itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::HistogramType = itk::Statistics::Histogram<double>

Definition at line 60 of file itkScalarImageToHistogramGenerator.h.

◆ ImageType

template<typename TImageType >
using itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::ImageType = TImageType

Definition at line 54 of file itkScalarImageToHistogramGenerator.h.

◆ PixelType

template<typename TImageType >
using itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::PixelType = typename ImageType::PixelType

Definition at line 57 of file itkScalarImageToHistogramGenerator.h.

◆ Pointer

template<typename TImageType >
using itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::Pointer = SmartPointer<Self>

Definition at line 45 of file itkScalarImageToHistogramGenerator.h.

◆ RealPixelType

template<typename TImageType >
using itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::RealPixelType = typename NumericTraits<PixelType>::RealType

Definition at line 58 of file itkScalarImageToHistogramGenerator.h.

◆ Self

template<typename TImageType >
using itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::Self = ScalarImageToHistogramGenerator

Standard type alias

Definition at line 43 of file itkScalarImageToHistogramGenerator.h.

◆ Superclass

template<typename TImageType >
using itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::Superclass = Object

Definition at line 44 of file itkScalarImageToHistogramGenerator.h.

Constructor & Destructor Documentation

◆ ScalarImageToHistogramGenerator()

template<typename TImageType >
itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::ScalarImageToHistogramGenerator ( )
protected

◆ ~ScalarImageToHistogramGenerator()

template<typename TImageType >
itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::~ScalarImageToHistogramGenerator ( )
overrideprotecteddefault

Member Function Documentation

◆ Compute()

template<typename TImageType >
void itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::Compute ( )

Triggers the Computation of the histogram

◆ CreateAnother()

template<typename TImageType >
virtual::itk::LightObject::Pointer itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::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.

◆ GetNameOfClass()

template<typename TImageType >
virtual const char* itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

◆ GetOutput()

template<typename TImageType >
const HistogramType* itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::GetOutput ( ) const

Return the histogram. o

Warning
This output is only valid after the Compute() method has been invoked
See also
Compute

◆ New()

template<typename TImageType >
static Pointer itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::New ( )
static

standard New() method support

◆ PrintSelf()

template<typename TImageType >
void itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::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::Object.

◆ SetAutoHistogramMinimumMaximum()

template<typename TImageType >
void itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::SetAutoHistogramMinimumMaximum ( bool  autoOnOff)

Computes the histogram minimum and maximum bin values automatically.

Warning
If set to Off, the values must be manually specified with SetHistogramMin() and SetHistogramMax().
See also
SetHistogramMin SetHistogramMax

◆ SetHistogramMax()

template<typename TImageType >
void itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::SetHistogramMax ( RealPixelType  maximumValue)

Set the maximum value from which the bins will be computed.

Warning
This requires to set the automatic computation of the histogram minimum/maximum to Off.
See also
SetAutoHistogramMinimumMaximum

◆ SetHistogramMin()

template<typename TImageType >
void itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::SetHistogramMin ( RealPixelType  minimumValue)

Set the minimum value from which the bins will be computed.

Warning
This requires to set the automatic computation of the histogram minimum/maximum to Off.
See also
SetAutoHistogramMinimumMaximum

◆ SetInput()

template<typename TImageType >
void itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::SetInput ( const ImageType )

Connects the input image for which the histogram is going to be computed

◆ SetMarginalScale()

template<typename TImageType >
void itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::SetMarginalScale ( double  marginalScale)

Set marginal scale value to be passed to the histogram generator

◆ SetNumberOfBins()

template<typename TImageType >
void itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::SetNumberOfBins ( unsigned int  numberOfBins)

Set number of histogram bins

Member Data Documentation

◆ m_HistogramGenerator

template<typename TImageType >
GeneratorPointer itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::m_HistogramGenerator
private

Definition at line 119 of file itkScalarImageToHistogramGenerator.h.

◆ m_ImageToListSampleAdaptor

template<typename TImageType >
AdaptorPointer itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::m_ImageToListSampleAdaptor
private

Definition at line 117 of file itkScalarImageToHistogramGenerator.h.


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