ITK  5.1.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::MinimumMaximumImageCalculator< TInputImage > Class Template Reference

#include <itkMinimumMaximumImageCalculator.h>

+ Inheritance diagram for itk::MinimumMaximumImageCalculator< TInputImage >:
+ Collaboration diagram for itk::MinimumMaximumImageCalculator< TInputImage >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using ImageConstPointer = typename TInputImage::ConstPointer
 
using ImagePointer = typename TInputImage::Pointer
 
using ImageType = TInputImage
 
using IndexType = typename TInputImage::IndexType
 
using PixelType = typename TInputImage::PixelType
 
using Pointer = SmartPointer< Self >
 
using RegionType = typename TInputImage::RegionType
 
using Self = MinimumMaximumImageCalculator
 
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 ()
 
void ComputeMaximum ()
 
void ComputeMinimum ()
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const IndexTypeGetIndexOfMaximum () const
 
virtual const IndexTypeGetIndexOfMinimum () const
 
virtual PixelType GetMaximum () const
 
virtual PixelType GetMinimum () const
 
virtual const char * GetNameOfClass () const
 
virtual void SetImage (const ImageType *_arg)
 
void SetRegion (const RegionType &region)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
LightObject::Pointer CreateAnother () const override
 
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

 MinimumMaximumImageCalculator ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~MinimumMaximumImageCalculator () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
void PrintSelf (std::ostream &os, Indent indent) const 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

ImageConstPointer m_Image
 
IndexType m_IndexOfMaximum
 
IndexType m_IndexOfMinimum
 
PixelType m_Maximum
 
PixelType m_Minimum
 
RegionType m_Region
 
bool m_RegionSetByUser
 

Additional Inherited Members

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

Detailed Description

template<typename TInputImage>
class itk::MinimumMaximumImageCalculator< TInputImage >

Computes the minimum and the maximum intensity values of an image.

This calculator computes the minimum and the maximum intensity values of an image. It is templated over input image type. If only Maximum or Minimum value is needed, just call ComputeMaximum() (ComputeMinimum()) otherwise Compute() will compute both.

ITK Sphinx Examples:
\li All ITK Sphinx Examples
Examples
SphinxExamples/src/Core/Common/FindMaxAndMinInImage/Code.cxx, SphinxExamples/src/Filtering/Convolution/ColorNormalizedCorrelation/Code.cxx, SphinxExamples/src/Filtering/Convolution/NormalizedCorrelation/Code.cxx, SphinxExamples/src/Filtering/Convolution/NormalizedCorrelationOfMaskedImage/Code.cxx, SphinxExamples/src/Filtering/Convolution/NormalizedCorrelationUsingFFT/Code.cxx, SphinxExamples/src/Filtering/Convolution/NormalizedCorrelationUsingFFTWithMaskImages/Code.cxx, and SphinxExamples/src/Filtering/ImageIntensity/ExtractComponentOfVectorImage/Code.cxx.

Definition at line 44 of file itkMinimumMaximumImageCalculator.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage >
using itk::MinimumMaximumImageCalculator< TInputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 53 of file itkMinimumMaximumImageCalculator.h.

◆ ImageConstPointer

template<typename TInputImage >
using itk::MinimumMaximumImageCalculator< TInputImage >::ImageConstPointer = typename TInputImage::ConstPointer

Const Pointer type for the image.

Definition at line 68 of file itkMinimumMaximumImageCalculator.h.

◆ ImagePointer

template<typename TInputImage >
using itk::MinimumMaximumImageCalculator< TInputImage >::ImagePointer = typename TInputImage::Pointer

Pointer type for the image.

Definition at line 65 of file itkMinimumMaximumImageCalculator.h.

◆ ImageType

template<typename TInputImage >
using itk::MinimumMaximumImageCalculator< TInputImage >::ImageType = TInputImage

Type definition for the input image.

Definition at line 62 of file itkMinimumMaximumImageCalculator.h.

◆ IndexType

template<typename TInputImage >
using itk::MinimumMaximumImageCalculator< TInputImage >::IndexType = typename TInputImage::IndexType

Type definition for the input image index type.

Definition at line 74 of file itkMinimumMaximumImageCalculator.h.

◆ PixelType

template<typename TInputImage >
using itk::MinimumMaximumImageCalculator< TInputImage >::PixelType = typename TInputImage::PixelType

Type definition for the input image pixel type.

Definition at line 71 of file itkMinimumMaximumImageCalculator.h.

◆ Pointer

template<typename TInputImage >
using itk::MinimumMaximumImageCalculator< TInputImage >::Pointer = SmartPointer<Self>

Definition at line 52 of file itkMinimumMaximumImageCalculator.h.

◆ RegionType

template<typename TInputImage >
using itk::MinimumMaximumImageCalculator< TInputImage >::RegionType = typename TInputImage::RegionType

Type definition for the input image region type.

Definition at line 77 of file itkMinimumMaximumImageCalculator.h.

◆ Self

template<typename TInputImage >
using itk::MinimumMaximumImageCalculator< TInputImage >::Self = MinimumMaximumImageCalculator

Standard class type aliases.

Definition at line 50 of file itkMinimumMaximumImageCalculator.h.

◆ Superclass

template<typename TInputImage >
using itk::MinimumMaximumImageCalculator< TInputImage >::Superclass = Object

Definition at line 51 of file itkMinimumMaximumImageCalculator.h.

Constructor & Destructor Documentation

◆ MinimumMaximumImageCalculator()

template<typename TInputImage >
itk::MinimumMaximumImageCalculator< TInputImage >::MinimumMaximumImageCalculator ( )
protected

◆ ~MinimumMaximumImageCalculator()

template<typename TInputImage >
itk::MinimumMaximumImageCalculator< TInputImage >::~MinimumMaximumImageCalculator ( )
overrideprotecteddefault

Member Function Documentation

◆ Compute()

template<typename TInputImage >
void itk::MinimumMaximumImageCalculator< TInputImage >::Compute ( )

Compute the minimum and maximum values of intensity of the input image.

◆ ComputeMaximum()

template<typename TInputImage >
void itk::MinimumMaximumImageCalculator< TInputImage >::ComputeMaximum ( )

Compute the maximum value of intensity of the input image.

◆ ComputeMinimum()

template<typename TInputImage >
void itk::MinimumMaximumImageCalculator< TInputImage >::ComputeMinimum ( )

Compute the minimum value of intensity of the input image.

◆ CreateAnother()

template<typename TInputImage >
virtual::itk::LightObject::Pointer itk::MinimumMaximumImageCalculator< TInputImage >::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::LightObject.

◆ GetIndexOfMaximum()

template<typename TInputImage >
virtual const IndexType& itk::MinimumMaximumImageCalculator< TInputImage >::GetIndexOfMaximum ( ) const
virtual

Return the index of the maximum intensity value.

◆ GetIndexOfMinimum()

template<typename TInputImage >
virtual const IndexType& itk::MinimumMaximumImageCalculator< TInputImage >::GetIndexOfMinimum ( ) const
virtual

Return the index of the minimum intensity value.

◆ GetMaximum()

template<typename TInputImage >
virtual PixelType itk::MinimumMaximumImageCalculator< TInputImage >::GetMaximum ( ) const
virtual

Return the maximum intensity value.

◆ GetMinimum()

template<typename TInputImage >
virtual PixelType itk::MinimumMaximumImageCalculator< TInputImage >::GetMinimum ( ) const
virtual

Return the minimum intensity value.

◆ GetNameOfClass()

template<typename TInputImage >
virtual const char* itk::MinimumMaximumImageCalculator< TInputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

◆ New()

template<typename TInputImage >
static Pointer itk::MinimumMaximumImageCalculator< TInputImage >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage >
void itk::MinimumMaximumImageCalculator< TInputImage >::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::LightObject.

◆ SetImage()

template<typename TInputImage >
virtual void itk::MinimumMaximumImageCalculator< TInputImage >::SetImage ( const ImageType _arg)
virtual

Set the input image.

◆ SetRegion()

template<typename TInputImage >
void itk::MinimumMaximumImageCalculator< TInputImage >::SetRegion ( const RegionType region)

Set the region over which the values will be computed

Member Data Documentation

◆ m_Image

template<typename TInputImage >
ImageConstPointer itk::MinimumMaximumImageCalculator< TInputImage >::m_Image
private

Definition at line 119 of file itkMinimumMaximumImageCalculator.h.

◆ m_IndexOfMaximum

template<typename TInputImage >
IndexType itk::MinimumMaximumImageCalculator< TInputImage >::m_IndexOfMaximum
private

Definition at line 122 of file itkMinimumMaximumImageCalculator.h.

◆ m_IndexOfMinimum

template<typename TInputImage >
IndexType itk::MinimumMaximumImageCalculator< TInputImage >::m_IndexOfMinimum
private

Definition at line 121 of file itkMinimumMaximumImageCalculator.h.

◆ m_Maximum

template<typename TInputImage >
PixelType itk::MinimumMaximumImageCalculator< TInputImage >::m_Maximum
private

Definition at line 118 of file itkMinimumMaximumImageCalculator.h.

◆ m_Minimum

template<typename TInputImage >
PixelType itk::MinimumMaximumImageCalculator< TInputImage >::m_Minimum
private

Definition at line 117 of file itkMinimumMaximumImageCalculator.h.

◆ m_Region

template<typename TInputImage >
RegionType itk::MinimumMaximumImageCalculator< TInputImage >::m_Region
private

Definition at line 124 of file itkMinimumMaximumImageCalculator.h.

◆ m_RegionSetByUser

template<typename TInputImage >
bool itk::MinimumMaximumImageCalculator< TInputImage >::m_RegionSetByUser
private

Definition at line 125 of file itkMinimumMaximumImageCalculator.h.


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