OTB  9.0.0
Orfeo Toolbox
List of all members
otb::VarianceImageFilter< TInputImage, TOutputImage > Class Template Reference
Data Processing Objects » Filters » Image Filters » Intensity Image FiltersGroup Core » | Module OTBStatistics

#include <otbVarianceImageFilter.h>

+ Inheritance diagram for otb::VarianceImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for otb::VarianceImageFilter< TInputImage, TOutputImage >:
typedef TInputImage InputImageType
 
typedef TOutputImage OutputImageType
 
typedef VarianceImageFilter Self
 
typedef itk::ImageToImageFilter< InputImageType, OutputImageType > Superclass
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::SmartPointer< const Self > ConstPointer
 
typedef InputImageType::PixelType InputPixelType
 
typedef OutputImageType::PixelType OutputPixelType
 
typedef itk::NumericTraits< InputPixelType >::RealType InputRealType
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef InputImageType::SizeType InputSizeType
 
static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
InputSizeType m_Radius
 
static Pointer New ()
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
virtual void SetRadius (InputSizeType _arg)
 
virtual const InputSizeType & GetRadius () const
 
void GenerateInputRequestedRegion () override
 
 typedef (itk::Concept::HasNumericTraits< InputPixelType >) InputHasNumericTraitsCheck
 
 VarianceImageFilter ()
 
 ~VarianceImageFilter () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId) override
 
 VarianceImageFilter (const Self &)=delete
 
void operator= (const Self &)=delete
 

Detailed Description

template<class TInputImage, class TOutputImage>
class otb::VarianceImageFilter< TInputImage, TOutputImage >

Applies an averaging filter to an image.

Computes an image where a given pixel is the value over the standard 8, 26, etc. connected neighborhood. This calculation uses a ZeroFluxNeumannBoundaryCondition.

See also
Image
Neighborhood
NeighborhoodOperator
NeighborhoodIterator

Definition at line 47 of file otbVarianceImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputImage , class TOutputImage >
typedef itk::SmartPointer<const Self> otb::VarianceImageFilter< TInputImage, TOutputImage >::ConstPointer

Convenient typedefs for simplifying declarations.

Definition at line 63 of file otbVarianceImageFilter.h.

◆ InputImageRegionType

template<class TInputImage , class TOutputImage >
typedef InputImageType::RegionType otb::VarianceImageFilter< TInputImage, TOutputImage >::InputImageRegionType

Convenient typedefs for simplifying declarations.

Definition at line 76 of file otbVarianceImageFilter.h.

◆ InputImageType

template<class TInputImage , class TOutputImage >
typedef TInputImage otb::VarianceImageFilter< TInputImage, TOutputImage >::InputImageType

Convenient typedefs for simplifying declarations.

Definition at line 56 of file otbVarianceImageFilter.h.

◆ InputPixelType

template<class TInputImage , class TOutputImage >
typedef InputImageType::PixelType otb::VarianceImageFilter< TInputImage, TOutputImage >::InputPixelType

Image typedef support.

Definition at line 69 of file otbVarianceImageFilter.h.

◆ InputRealType

template<class TInputImage , class TOutputImage >
typedef itk::NumericTraits<InputPixelType>::RealType otb::VarianceImageFilter< TInputImage, TOutputImage >::InputRealType

Convenient typedefs for simplifying declarations.

Definition at line 74 of file otbVarianceImageFilter.h.

◆ InputSizeType

template<class TInputImage , class TOutputImage >
typedef InputImageType::SizeType otb::VarianceImageFilter< TInputImage, TOutputImage >::InputSizeType

Convenient typedefs for simplifying declarations.

Definition at line 79 of file otbVarianceImageFilter.h.

◆ OutputImageRegionType

template<class TInputImage , class TOutputImage >
typedef OutputImageType::RegionType otb::VarianceImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Convenient typedefs for simplifying declarations.

Definition at line 77 of file otbVarianceImageFilter.h.

◆ OutputImageType

template<class TInputImage , class TOutputImage >
typedef TOutputImage otb::VarianceImageFilter< TInputImage, TOutputImage >::OutputImageType

Convenient typedefs for simplifying declarations.

Definition at line 57 of file otbVarianceImageFilter.h.

◆ OutputPixelType

template<class TInputImage , class TOutputImage >
typedef OutputImageType::PixelType otb::VarianceImageFilter< TInputImage, TOutputImage >::OutputPixelType

Convenient typedefs for simplifying declarations.

Definition at line 73 of file otbVarianceImageFilter.h.

◆ Pointer

template<class TInputImage , class TOutputImage >
typedef itk::SmartPointer<Self> otb::VarianceImageFilter< TInputImage, TOutputImage >::Pointer

Convenient typedefs for simplifying declarations.

Definition at line 62 of file otbVarianceImageFilter.h.

◆ Self

template<class TInputImage , class TOutputImage >
typedef VarianceImageFilter otb::VarianceImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

Definition at line 60 of file otbVarianceImageFilter.h.

◆ Superclass

template<class TInputImage , class TOutputImage >
typedef itk::ImageToImageFilter<InputImageType, OutputImageType> otb::VarianceImageFilter< TInputImage, TOutputImage >::Superclass

Convenient typedefs for simplifying declarations.

Definition at line 61 of file otbVarianceImageFilter.h.

Constructor & Destructor Documentation

◆ VarianceImageFilter() [1/2]

template<class TInputImage , class TOutputImage >
otb::VarianceImageFilter< TInputImage, TOutputImage >::VarianceImageFilter
protected

End concept checking

Definition at line 37 of file otbVarianceImageFilter.hxx.

◆ ~VarianceImageFilter()

template<class TInputImage , class TOutputImage >
otb::VarianceImageFilter< TInputImage, TOutputImage >::~VarianceImageFilter ( )
inlineoverrideprotected

Convenient typedefs for simplifying declarations.

Definition at line 104 of file otbVarianceImageFilter.h.

◆ VarianceImageFilter() [2/2]

template<class TInputImage , class TOutputImage >
otb::VarianceImageFilter< TInputImage, TOutputImage >::VarianceImageFilter ( const Self &  )
privatedelete

Convenient typedefs for simplifying declarations.

Member Function Documentation

◆ CreateAnother()

template<class TInputImage , class TOutputImage >
virtual::itk::LightObject::Pointer otb::VarianceImageFilter< TInputImage, TOutputImage >::CreateAnother ( void  ) const

Convenient typedefs for simplifying declarations.

◆ GenerateInputRequestedRegion()

template<class TInputImage , class TOutputImage >
void otb::VarianceImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion
override

VarianceImageFilter needs a larger input requested region than the output requested region. As such, VarianceImageFilter needs to provide an implementation for GenerateInputRequestedRegion() in order to inform the pipeline execution model.

See also
ImageToImageFilter::GenerateInputRequestedRegion()

Definition at line 43 of file otbVarianceImageFilter.hxx.

◆ GetNameOfClass()

template<class TInputImage , class TOutputImage >
virtual const char* otb::VarianceImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

◆ GetRadius()

template<class TInputImage , class TOutputImage >
virtual const InputSizeType& otb::VarianceImageFilter< TInputImage, TOutputImage >::GetRadius ( ) const
virtual

Get the radius of the neighborhood used to compute the mean

◆ New()

template<class TInputImage , class TOutputImage >
static Pointer otb::VarianceImageFilter< TInputImage, TOutputImage >::New ( )
static

Method for creation through the object factory.

◆ operator=()

template<class TInputImage , class TOutputImage >
void otb::VarianceImageFilter< TInputImage, TOutputImage >::operator= ( const Self &  )
privatedelete

Convenient typedefs for simplifying declarations.

◆ PrintSelf()

template<class TInputImage , class TOutput >
void otb::VarianceImageFilter< TInputImage, TOutput >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

Standard "PrintSelf" method

Definition at line 150 of file otbVarianceImageFilter.hxx.

◆ SetRadius()

template<class TInputImage , class TOutputImage >
virtual void otb::VarianceImageFilter< TInputImage, TOutputImage >::SetRadius ( InputSizeType  _arg)
virtual

Set the radius of the neighborhood used to compute the mean.

◆ ThreadedGenerateData()

template<class TInputImage , class TOutputImage >
void otb::VarianceImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread,
itk::ThreadIdType  threadId 
)
overrideprotected

VarianceImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a ThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling ThreadedGenerateData(). ThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread"

See also
ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

Definition at line 89 of file otbVarianceImageFilter.hxx.

◆ typedef()

template<class TInputImage , class TOutputImage >
otb::VarianceImageFilter< TInputImage, TOutputImage >::typedef ( itk::Concept::HasNumericTraits< InputPixelType >  )

Begin concept checking This class requires InputHasNumericTraitsCheck in the form of (itk::Concept::HasNumericTraits<InputPixelType>)

Member Data Documentation

◆ InputImageDimension

template<class TInputImage , class TOutputImage >
const unsigned int otb::VarianceImageFilter< TInputImage, TOutputImage >::InputImageDimension = TInputImage::ImageDimension
static

Extract dimension from input and output image.

Definition at line 51 of file otbVarianceImageFilter.h.

◆ m_Radius

template<class TInputImage , class TOutputImage >
InputSizeType otb::VarianceImageFilter< TInputImage, TOutputImage >::m_Radius
private

Convenient typedefs for simplifying declarations.

Definition at line 125 of file otbVarianceImageFilter.h.

◆ OutputImageDimension

template<class TInputImage , class TOutputImage >
const unsigned int otb::VarianceImageFilter< TInputImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension
static

Convenient typedefs for simplifying declarations.

Definition at line 52 of file otbVarianceImageFilter.h.

The documentation for this class was generated from the following files:
Generated at Wed Feb 28 2024 15:25:37 for OTB with   doxygen 1.8.17