OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
otb::SummingFilter< TInputImage, TOutputImage > Class Template Reference

#include <otbSummingFilter.h>

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

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef InputImageType::IndexType InputImageIndexType
 
typedef InputImageType::InternalPixelType InputImageInternalPixelType
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::PointType InputImagePointType
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef InputImageType::SizeType InputImageSizeType
 
typedef InputImageType::SpacingType InputImageSpacingType
 
typedef TInputImage InputImageType
 
typedef itk::ImageRegionConstIterator< InputImageTypeInputIteratorType
 
typedef OutputImageType::IndexType OutputImageIndexType
 
typedef OutputImageType::InternalPixelType OutputImageInternalPixelType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::PointType OutputImagePointType
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef OutputImageType::SizeType OutputImageSizeType
 
typedef OutputImageType::SpacingType OutputImageSpacingType
 
typedef TOutputImage OutputImageType
 
typedef itk::ImageRegionIterator< OutputImageTypeOutputIteratorType
 
typedef itk::SmartPointer< SelfPointer
 
typedef SummingFilter Self
 
typedef itk::ImageToImageFilter< TInputImage, TOutputImage > Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 SummingFilter ()
 
virtual ~SummingFilter ()
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId)
 
virtual void GenerateOutputInformation (void)
 

Private Member Functions

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

Detailed Description

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

Computes the sum of the input images pixels.

Support streaming

The pixels must support the operator ==, +, /, etc. The "no data value" can be chose.

Definition at line 40 of file otbSummingFilter.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 47 of file otbSummingFilter.h.

◆ InputImageIndexType

template<class TInputImage , class TOutputImage >
typedef InputImageType::IndexType otb::SummingFilter< TInputImage, TOutputImage >::InputImageIndexType

Definition at line 60 of file otbSummingFilter.h.

◆ InputImageInternalPixelType

template<class TInputImage , class TOutputImage >
typedef InputImageType::InternalPixelType otb::SummingFilter< TInputImage, TOutputImage >::InputImageInternalPixelType

Definition at line 63 of file otbSummingFilter.h.

◆ InputImagePixelType

template<class TInputImage , class TOutputImage >
typedef InputImageType::PixelType otb::SummingFilter< TInputImage, TOutputImage >::InputImagePixelType

Definition at line 58 of file otbSummingFilter.h.

◆ InputImagePointType

template<class TInputImage , class TOutputImage >
typedef InputImageType::PointType otb::SummingFilter< TInputImage, TOutputImage >::InputImagePointType

Definition at line 59 of file otbSummingFilter.h.

◆ InputImageRegionType

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

Definition at line 57 of file otbSummingFilter.h.

◆ InputImageSizeType

template<class TInputImage , class TOutputImage >
typedef InputImageType::SizeType otb::SummingFilter< TInputImage, TOutputImage >::InputImageSizeType

Definition at line 61 of file otbSummingFilter.h.

◆ InputImageSpacingType

template<class TInputImage , class TOutputImage >
typedef InputImageType::SpacingType otb::SummingFilter< TInputImage, TOutputImage >::InputImageSpacingType

Definition at line 62 of file otbSummingFilter.h.

◆ InputImageType

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

Some additional typedefs.

Definition at line 53 of file otbSummingFilter.h.

◆ InputIteratorType

template<class TInputImage , class TOutputImage >
typedef itk::ImageRegionConstIterator<InputImageType> otb::SummingFilter< TInputImage, TOutputImage >::InputIteratorType

Definition at line 78 of file otbSummingFilter.h.

◆ OutputImageIndexType

template<class TInputImage , class TOutputImage >
typedef OutputImageType::IndexType otb::SummingFilter< TInputImage, TOutputImage >::OutputImageIndexType

Definition at line 69 of file otbSummingFilter.h.

◆ OutputImageInternalPixelType

template<class TInputImage , class TOutputImage >
typedef OutputImageType::InternalPixelType otb::SummingFilter< TInputImage, TOutputImage >::OutputImageInternalPixelType

Definition at line 74 of file otbSummingFilter.h.

◆ OutputImagePixelType

template<class TInputImage , class TOutputImage >
typedef OutputImageType::PixelType otb::SummingFilter< TInputImage, TOutputImage >::OutputImagePixelType

Definition at line 73 of file otbSummingFilter.h.

◆ OutputImagePointer

template<class TInputImage , class TOutputImage >
typedef OutputImageType::Pointer otb::SummingFilter< TInputImage, TOutputImage >::OutputImagePointer

Definition at line 67 of file otbSummingFilter.h.

◆ OutputImagePointType

template<class TInputImage , class TOutputImage >
typedef OutputImageType::PointType otb::SummingFilter< TInputImage, TOutputImage >::OutputImagePointType

Definition at line 70 of file otbSummingFilter.h.

◆ OutputImageRegionType

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

Definition at line 68 of file otbSummingFilter.h.

◆ OutputImageSizeType

template<class TInputImage , class TOutputImage >
typedef OutputImageType::SizeType otb::SummingFilter< TInputImage, TOutputImage >::OutputImageSizeType

Definition at line 71 of file otbSummingFilter.h.

◆ OutputImageSpacingType

template<class TInputImage , class TOutputImage >
typedef OutputImageType::SpacingType otb::SummingFilter< TInputImage, TOutputImage >::OutputImageSpacingType

Definition at line 72 of file otbSummingFilter.h.

◆ OutputImageType

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

Some additional typedefs.

Definition at line 66 of file otbSummingFilter.h.

◆ OutputIteratorType

template<class TInputImage , class TOutputImage >
typedef itk::ImageRegionIterator<OutputImageType> otb::SummingFilter< TInputImage, TOutputImage >::OutputIteratorType

Iterators

Definition at line 77 of file otbSummingFilter.h.

◆ Pointer

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

Definition at line 46 of file otbSummingFilter.h.

◆ Self

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

Standard Self typedef

Definition at line 44 of file otbSummingFilter.h.

◆ Superclass

template<class TInputImage , class TOutputImage >
typedef itk::ImageToImageFilter<TInputImage, TOutputImage> otb::SummingFilter< TInputImage, TOutputImage >::Superclass

Definition at line 45 of file otbSummingFilter.h.

Constructor & Destructor Documentation

◆ SummingFilter() [1/2]

template<class TInputImage , class TOutputImage >
otb::SummingFilter< TInputImage, TOutputImage >::SummingFilter ( )
inlineprotected

Definition at line 81 of file otbSummingFilter.h.

◆ ~SummingFilter()

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

Definition at line 85 of file otbSummingFilter.h.

◆ SummingFilter() [2/2]

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

Member Function Documentation

◆ CreateAnother()

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

◆ GenerateOutputInformation()

template<class TInputImage , class TOutputImage >
void otb::SummingFilter< TInputImage, TOutputImage >::GenerateOutputInformation ( void  )
protectedvirtual

Generates output information:

Definition at line 35 of file otbSummingFilter.hxx.

◆ GetNameOfClass()

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

Runtime information support.

◆ New()

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

Method for creation through the object factory.

◆ operator=()

template<class TInputImage , class TOutputImage >
void otb::SummingFilter< TInputImage, TOutputImage >::operator= ( const Self )
private

◆ ThreadedGenerateData()

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

SummingFilter 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()
Overridden methods

Processing.

Definition at line 46 of file otbSummingFilter.hxx.


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