Orfeo ToolBox  4.2
Orfeo ToolBox is not a black box
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::VarianceImageFilter< TInputImage, TOutputImage > Class Template Reference

Applies an averaging filter to an image. More...

#include <otbVarianceImageFilter.h>

+ Inheritance diagram for otb::VarianceImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for otb::VarianceImageFilter< TInputImage, TOutputImage >:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef InputImageType::PixelType InputPixelType
 
typedef itk::NumericTraits
< InputPixelType >::RealType 
InputRealType
 
typedef InputImageType::SizeType InputSizeType
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef OutputImageType::PixelType OutputPixelType
 
typedef itk::SmartPointer< SelfPointer
 
typedef VarianceImageFilter Self
 
typedef
itk::ImageToImageFilter
< InputImageType,
OutputImageType
Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual void GenerateInputRequestedRegion () throw (itk::InvalidRequestedRegionError)
 
virtual const char * GetNameOfClass () const
 
virtual const InputSizeTypeGetRadius ()
 
virtual void SetRadius (InputSizeType _arg)
 
 typedef (itk::Concept::HasNumericTraits< InputPixelType >) InputHasNumericTraitsCheck
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageSource< TOutputImage >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter (void)
 

Static Public Attributes

static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
 

Protected Member Functions

 VarianceImageFilter ()
 
virtual ~VarianceImageFilter ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId)
 

Private Member Functions

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

Private Attributes

InputSizeType m_Radius
 

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 42 of file otbVarianceImageFilter.h.

Member Typedef Documentation

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

Definition at line 60 of file otbVarianceImageFilter.h.

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

Definition at line 73 of file otbVarianceImageFilter.h.

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

Convenient typedefs for simplifying declarations.

Definition at line 53 of file otbVarianceImageFilter.h.

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

Image typedef support.

Definition at line 66 of file otbVarianceImageFilter.h.

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

Definition at line 71 of file otbVarianceImageFilter.h.

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

Definition at line 76 of file otbVarianceImageFilter.h.

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

Definition at line 74 of file otbVarianceImageFilter.h.

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

Definition at line 54 of file otbVarianceImageFilter.h.

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

Definition at line 70 of file otbVarianceImageFilter.h.

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

Definition at line 59 of file otbVarianceImageFilter.h.

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

Standard class typedefs.

Definition at line 57 of file otbVarianceImageFilter.h.

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

Definition at line 58 of file otbVarianceImageFilter.h.

Constructor & Destructor Documentation

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

End concept checking

Definition at line 36 of file otbVarianceImageFilter.txx.

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

Definition at line 102 of file otbVarianceImageFilter.h.

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

Member Function Documentation

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

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 44 of file otbVarianceImageFilter.txx.

References itk::DataObjectError::SetDataObject(), itk::DataObjectError::SetDescription(), and itk::DataObjectError::SetLocation().

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

Run-time type information (and related methods).

Reimplemented from itk::ImageSource< TOutputImage >.

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

Get the radius of the neighborhood used to compute the mean

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

Method for creation through the object factory.

template<class TInputImage , class TOutputImage >
void otb::VarianceImageFilter< TInputImage, TOutputImage >::operator= ( const Self )
private
template<class TInputImage , class TOutput >
void otb::VarianceImageFilter< TInputImage, TOutput >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protected

Standard "PrintSelf" method

Definition at line 158 of file otbVarianceImageFilter.txx.

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.

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

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 93 of file otbVarianceImageFilter.txx.

References itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetPixel(), itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GoToBegin(), itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::IsAtEnd(), itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::OverrideBoundaryCondition(), itk::ImageRegionIterator< TImage >::Set(), and itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::Size().

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

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 48 of file otbVarianceImageFilter.h.

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

Definition at line 122 of file otbVarianceImageFilter.h.

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

Definition at line 50 of file otbVarianceImageFilter.h.


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