go home Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes
itk::ComputeImageExtremaFilter< TInputImage > Class Template Reference

#include <itkComputeImageExtremaFilter.h>

Detailed Description

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

Compute min. max, variance and mean of an Image.

StatisticsImageFilter computes the minimum, maximum, sum, mean, variance sigma of an image. The filter needs all of its input image. It behaves as a filter with an input and output. Thus it can be inserted in a pipline with other filters and the statistics will only be recomputed if a downstream filter changes.

The filter passes its input through unmodified. The filter is threaded. It computes statistics in each thread then combines them in its AfterThreadedGenerate method.

\wiki \wikiexample{Statistics/StatisticsImageFilter,Compute min\, max\, variance and mean of an Image.} \endwiki

Definition at line 48 of file itkComputeImageExtremaFilter.h.

Inheritance diagram for itk::ComputeImageExtremaFilter< TInputImage >:
Inheritance graph
[legend]

Public Types

using ConstPointer = SmartPointer< const Self >
 
using ImageMaskConstPointer = typename ImageMaskType::ConstPointer
 
using ImageMaskPointer = typename ImageMaskType::Pointer
 
using ImageMaskType = SpatialObject< Self::ImageDimension >
 
using ImageSpatialMaskConstPointer = typename ImageSpatialMaskType::ConstPointer
 
using ImageSpatialMaskPointer = typename ImageSpatialMaskType::Pointer
 
using ImageSpatialMaskType = ImageMaskSpatialObject< Self::ImageDimension >
 
using InputImagePointer = typename TInputImage::Pointer
 
using Pointer = SmartPointer< Self >
 
using PointType = typename TInputImage::PointType
 
using Self = ComputeImageExtremaFilter
 
using Superclass = StatisticsImageFilter< TInputImage >
 

Public Member Functions

virtual const char * GetClassName () const
 
virtual const ImageMaskTypeGetImageMask ()
 
virtual const ImageSpatialMaskTypeGetImageSpatialMask ()
 
 itkStaticConstMacro (ImageDimension, unsigned int, TInputImage::ImageDimension)
 
virtual void SetImageMask (const ImageMaskType *_arg)
 
virtual void SetImageRegion (RegionType _arg)
 
virtual void SetImageSpatialMask (const ImageSpatialMaskType *_arg)
 
virtual void SetUseMask (bool _arg)
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

void AfterStreamedGenerateData () override
 
void BeforeStreamedGenerateData () override
 
 ComputeImageExtremaFilter ()=default
 
virtual void SameGeometry ()
 
virtual void ThreadedGenerateDataImageMask (const RegionType &)
 
virtual void ThreadedGenerateDataImageSpatialMask (const RegionType &)
 
void ThreadedStreamedGenerateData (const RegionType &) override
 
 ~ComputeImageExtremaFilter () override=default
 

Protected Attributes

ImageMaskConstPointer m_ImageMask
 
RegionType m_ImageRegion
 
ImageSpatialMaskConstPointer m_ImageSpatialMask
 
bool m_SameGeometry { false }
 
bool m_UseMask { false }
 

Private Member Functions

 ComputeImageExtremaFilter (const Self &)
 
void operator= (const Self &)
 

Private Attributes

SizeValueType m_Count { 1 }
 
std::mutex m_Mutex
 
CompensatedSummation< RealType > m_SumOfSquares { 1 }
 
PixelType m_ThreadMax { 1 }
 
PixelType m_ThreadMin { 1 }
 
CompensatedSummation< RealType > m_ThreadSum { 1 }
 

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 55 of file itkComputeImageExtremaFilter.h.

◆ ImageMaskConstPointer

template<typename TInputImage >
using itk::ComputeImageExtremaFilter< TInputImage >::ImageMaskConstPointer = typename ImageMaskType::ConstPointer

Definition at line 83 of file itkComputeImageExtremaFilter.h.

◆ ImageMaskPointer

template<typename TInputImage >
using itk::ComputeImageExtremaFilter< TInputImage >::ImageMaskPointer = typename ImageMaskType::Pointer

Definition at line 82 of file itkComputeImageExtremaFilter.h.

◆ ImageMaskType

template<typename TInputImage >
using itk::ComputeImageExtremaFilter< TInputImage >::ImageMaskType = SpatialObject<Self::ImageDimension>

Definition at line 81 of file itkComputeImageExtremaFilter.h.

◆ ImageSpatialMaskConstPointer

template<typename TInputImage >
using itk::ComputeImageExtremaFilter< TInputImage >::ImageSpatialMaskConstPointer = typename ImageSpatialMaskType::ConstPointer

Definition at line 89 of file itkComputeImageExtremaFilter.h.

◆ ImageSpatialMaskPointer

template<typename TInputImage >
using itk::ComputeImageExtremaFilter< TInputImage >::ImageSpatialMaskPointer = typename ImageSpatialMaskType::Pointer

Definition at line 88 of file itkComputeImageExtremaFilter.h.

◆ ImageSpatialMaskType

template<typename TInputImage >
using itk::ComputeImageExtremaFilter< TInputImage >::ImageSpatialMaskType = ImageMaskSpatialObject<Self::ImageDimension>

Definition at line 87 of file itkComputeImageExtremaFilter.h.

◆ InputImagePointer

template<typename TInputImage >
using itk::ComputeImageExtremaFilter< TInputImage >::InputImagePointer = typename TInputImage::Pointer

Image related typedefs.

Definition at line 64 of file itkComputeImageExtremaFilter.h.

◆ Pointer

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

Definition at line 54 of file itkComputeImageExtremaFilter.h.

◆ PointType

template<typename TInputImage >
using itk::ComputeImageExtremaFilter< TInputImage >::PointType = typename TInputImage::PointType

Definition at line 70 of file itkComputeImageExtremaFilter.h.

◆ Self

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

Standard Self typedef

Definition at line 52 of file itkComputeImageExtremaFilter.h.

◆ Superclass

template<typename TInputImage >
using itk::ComputeImageExtremaFilter< TInputImage >::Superclass = StatisticsImageFilter<TInputImage>

Definition at line 53 of file itkComputeImageExtremaFilter.h.

Constructor & Destructor Documentation

◆ ComputeImageExtremaFilter() [1/2]

template<typename TInputImage >
itk::ComputeImageExtremaFilter< TInputImage >::ComputeImageExtremaFilter ( )
protecteddefault

◆ ~ComputeImageExtremaFilter()

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

◆ ComputeImageExtremaFilter() [2/2]

template<typename TInputImage >
itk::ComputeImageExtremaFilter< TInputImage >::ComputeImageExtremaFilter ( const Self )
private

Member Function Documentation

◆ AfterStreamedGenerateData()

template<typename TInputImage >
void itk::ComputeImageExtremaFilter< TInputImage >::AfterStreamedGenerateData ( )
overrideprotected

Do final mean and variance computation from data accumulated in threads.

◆ BeforeStreamedGenerateData()

template<typename TInputImage >
void itk::ComputeImageExtremaFilter< TInputImage >::BeforeStreamedGenerateData ( )
overrideprotected

Initialize some accumulators before the threads run.

◆ GetClassName()

template<typename TInputImage >
virtual const char * itk::ComputeImageExtremaFilter< TInputImage >::GetClassName ( ) const
virtual

Runtime information support.

◆ GetImageMask()

template<typename TInputImage >
virtual const ImageMaskType * itk::ComputeImageExtremaFilter< TInputImage >::GetImageMask ( )
virtual

◆ GetImageSpatialMask()

template<typename TInputImage >
virtual const ImageSpatialMaskType * itk::ComputeImageExtremaFilter< TInputImage >::GetImageSpatialMask ( )
virtual

◆ itkStaticConstMacro()

template<typename TInputImage >
itk::ComputeImageExtremaFilter< TInputImage >::itkStaticConstMacro ( ImageDimension  ,
unsigned int  ,
TInputImage::ImageDimension   
)

Image related typedefs.

◆ New()

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

Method for creation through the object factory.

◆ operator=()

template<typename TInputImage >
void itk::ComputeImageExtremaFilter< TInputImage >::operator= ( const Self )
private

◆ SameGeometry()

template<typename TInputImage >
virtual void itk::ComputeImageExtremaFilter< TInputImage >::SameGeometry ( )
protectedvirtual

◆ SetImageMask()

template<typename TInputImage >
virtual void itk::ComputeImageExtremaFilter< TInputImage >::SetImageMask ( const ImageMaskType _arg)
virtual

◆ SetImageRegion()

template<typename TInputImage >
virtual void itk::ComputeImageExtremaFilter< TInputImage >::SetImageRegion ( RegionType  _arg)
virtual

◆ SetImageSpatialMask()

template<typename TInputImage >
virtual void itk::ComputeImageExtremaFilter< TInputImage >::SetImageSpatialMask ( const ImageSpatialMaskType _arg)
virtual

◆ SetUseMask()

template<typename TInputImage >
virtual void itk::ComputeImageExtremaFilter< TInputImage >::SetUseMask ( bool  _arg)
virtual

◆ ThreadedGenerateDataImageMask()

template<typename TInputImage >
virtual void itk::ComputeImageExtremaFilter< TInputImage >::ThreadedGenerateDataImageMask ( const RegionType &  )
protectedvirtual

◆ ThreadedGenerateDataImageSpatialMask()

template<typename TInputImage >
virtual void itk::ComputeImageExtremaFilter< TInputImage >::ThreadedGenerateDataImageSpatialMask ( const RegionType &  )
protectedvirtual

◆ ThreadedStreamedGenerateData()

template<typename TInputImage >
void itk::ComputeImageExtremaFilter< TInputImage >::ThreadedStreamedGenerateData ( const RegionType &  )
overrideprotected

Multi-thread version GenerateData.

Field Documentation

◆ m_Count

template<typename TInputImage >
SizeValueType itk::ComputeImageExtremaFilter< TInputImage >::m_Count { 1 }
private

Definition at line 128 of file itkComputeImageExtremaFilter.h.

◆ m_ImageMask

template<typename TInputImage >
ImageMaskConstPointer itk::ComputeImageExtremaFilter< TInputImage >::m_ImageMask
protected

Definition at line 116 of file itkComputeImageExtremaFilter.h.

◆ m_ImageRegion

template<typename TInputImage >
RegionType itk::ComputeImageExtremaFilter< TInputImage >::m_ImageRegion
protected

Definition at line 115 of file itkComputeImageExtremaFilter.h.

◆ m_ImageSpatialMask

template<typename TInputImage >
ImageSpatialMaskConstPointer itk::ComputeImageExtremaFilter< TInputImage >::m_ImageSpatialMask
protected

Definition at line 117 of file itkComputeImageExtremaFilter.h.

◆ m_Mutex

template<typename TInputImage >
std::mutex itk::ComputeImageExtremaFilter< TInputImage >::m_Mutex
private

Definition at line 132 of file itkComputeImageExtremaFilter.h.

◆ m_SameGeometry

template<typename TInputImage >
bool itk::ComputeImageExtremaFilter< TInputImage >::m_SameGeometry { false }
protected

Definition at line 119 of file itkComputeImageExtremaFilter.h.

◆ m_SumOfSquares

template<typename TInputImage >
CompensatedSummation<RealType> itk::ComputeImageExtremaFilter< TInputImage >::m_SumOfSquares { 1 }
private

Definition at line 127 of file itkComputeImageExtremaFilter.h.

◆ m_ThreadMax

template<typename TInputImage >
PixelType itk::ComputeImageExtremaFilter< TInputImage >::m_ThreadMax { 1 }
private

Definition at line 130 of file itkComputeImageExtremaFilter.h.

◆ m_ThreadMin

template<typename TInputImage >
PixelType itk::ComputeImageExtremaFilter< TInputImage >::m_ThreadMin { 1 }
private

Definition at line 129 of file itkComputeImageExtremaFilter.h.

◆ m_ThreadSum

template<typename TInputImage >
CompensatedSummation<RealType> itk::ComputeImageExtremaFilter< TInputImage >::m_ThreadSum { 1 }
private

Definition at line 126 of file itkComputeImageExtremaFilter.h.

◆ m_UseMask

template<typename TInputImage >
bool itk::ComputeImageExtremaFilter< TInputImage >::m_UseMask { false }
protected

Definition at line 118 of file itkComputeImageExtremaFilter.h.



Generated on 2023-01-13 for elastix by doxygen 1.9.6 elastix logo