otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor > Class Template Reference

#include <otbSynthetizeFilter.h>

Inheritance diagram for otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >:

Collaboration diagram for otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >:

Public Types
Convenient typedefs for simplifying declarations
using	InputImageType = TInputImage
using	OutputImageType = TOutputImage
using	FunctorType = TFunctor
Image typedef support
using	InputPixelType = typename InputImageType::PixelType
using	OutputPixelType = typename OutputImageType::PixelType
using	InputRealType = typename itk::NumericTraits< InputPixelType >::RealType
using	InputImageRegionType = typename InputImageType::RegionType
using	OutputImageRegionType = typename OutputImageType::RegionType
using	InputSizeType = typename InputImageType::SizeType
using	OutputIndexType = typename OutputImageType::IndexType
using	OutputSizeType = typename OutputImageType::SizeType
using	DataObjectPointerArraySizeType = itk::ProcessObject::DataObjectPointerArraySizeType

Static Public Attributes
Extract dimension from input and output images
static const unsigned int	InputImageDimension = InputImageType::ImageDimension
static const unsigned int	OutputImageDimension = OutputImageType::ImageDimension

Standard class typedefs
using	Self = SynthetizeFilter
using	Superclass = itk::ImageToImageFilter< InputImageType, OutputImageType >
using	Pointer = itk::SmartPointer< Self >
using	ConstPointer = itk::SmartPointer< const Self >
static Pointer	New (FunctorType functor)
virtual const char *	GetNameOfClass () const

Access to N-th Input
Set/Get the nth filter input with or without a specified associated variable name.
FunctorType	m_functor
InputImageType *	GetNthInput (DataObjectPointerArraySizeType idx)
std::vector< InputImageType const * >	GetInputs () const
	SynthetizeFilter (FunctorType functor)
	~SynthetizeFilter ()=default
void	GenerateOutputInformation () override
void	ThreadedGenerateData (OutputImageRegionType const &outputRegionForThread, itk::ThreadIdType threadId) override
void	CheckInputImageDimensions ()

Detailed Description

template<typename TInputImage, typename TOutputImage, typename TFunctor>
class otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >

Filter that reduces/synthetize multiple input into a single output.

This filter makes sure to avoid VectorImages. Instead it works on a collection of scalar images.

Template Parameters

TInputImage	Type of the input images
TOutputImage	Type of the output image
TFunctor	Type of the functor, meant to be auto-deduced by MakeSynthetizeFilter()

Author

Luc Hermitte (CS Group)

Copyright

CNES

See also

for instance otb::Wrapper::Synthetize

Definition at line 47 of file otbSynthetizeFilter.h.

Member Typedef Documentation

ConstPointer

template<typename TInputImage , typename TOutputImage , typename TFunctor >

using otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::ConstPointer = itk::SmartPointer<const Self>

Method for creation through the object factory.

Definition at line 69 of file otbSynthetizeFilter.h.

DataObjectPointerArraySizeType

template<typename TInputImage , typename TOutputImage , typename TFunctor >

using otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::DataObjectPointerArraySizeType = itk::ProcessObject::DataObjectPointerArraySizeType

Definition at line 97 of file otbSynthetizeFilter.h.

FunctorType

template<typename TInputImage , typename TOutputImage , typename TFunctor >

using otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::FunctorType = TFunctor

Definition at line 55 of file otbSynthetizeFilter.h.

InputImageRegionType

template<typename TInputImage , typename TOutputImage , typename TFunctor >

using otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::InputImageRegionType = typename InputImageType::RegionType

Definition at line 89 of file otbSynthetizeFilter.h.

InputImageType

template<typename TInputImage , typename TOutputImage , typename TFunctor >

using otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::InputImageType = TInputImage

Definition at line 53 of file otbSynthetizeFilter.h.

InputPixelType

template<typename TInputImage , typename TOutputImage , typename TFunctor >

using otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::InputPixelType = typename InputImageType::PixelType

Definition at line 86 of file otbSynthetizeFilter.h.

InputRealType

template<typename TInputImage , typename TOutputImage , typename TFunctor >

using otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::InputRealType = typename itk::NumericTraits<InputPixelType>::RealType

Definition at line 88 of file otbSynthetizeFilter.h.

InputSizeType

template<typename TInputImage , typename TOutputImage , typename TFunctor >

using otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::InputSizeType = typename InputImageType::SizeType

Definition at line 91 of file otbSynthetizeFilter.h.

OutputImageRegionType

template<typename TInputImage , typename TOutputImage , typename TFunctor >

using otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::OutputImageRegionType = typename OutputImageType::RegionType

Definition at line 90 of file otbSynthetizeFilter.h.

OutputImageType

template<typename TInputImage , typename TOutputImage , typename TFunctor >

using otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::OutputImageType = TOutputImage

Definition at line 54 of file otbSynthetizeFilter.h.

OutputIndexType

template<typename TInputImage , typename TOutputImage , typename TFunctor >

using otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::OutputIndexType = typename OutputImageType::IndexType

Definition at line 92 of file otbSynthetizeFilter.h.

OutputPixelType

template<typename TInputImage , typename TOutputImage , typename TFunctor >

using otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::OutputPixelType = typename OutputImageType::PixelType

Definition at line 87 of file otbSynthetizeFilter.h.

OutputSizeType

template<typename TInputImage , typename TOutputImage , typename TFunctor >

using otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::OutputSizeType = typename OutputImageType::SizeType

Definition at line 93 of file otbSynthetizeFilter.h.

Pointer

template<typename TInputImage , typename TOutputImage , typename TFunctor >

using otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::Pointer = itk::SmartPointer<Self>

Method for creation through the object factory.

Definition at line 68 of file otbSynthetizeFilter.h.

Self

template<typename TInputImage , typename TOutputImage , typename TFunctor >

using otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::Self = SynthetizeFilter

Method for creation through the object factory.

Definition at line 66 of file otbSynthetizeFilter.h.

Superclass

template<typename TInputImage , typename TOutputImage , typename TFunctor >

using otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::Superclass = itk::ImageToImageFilter<InputImageType, OutputImageType>

Method for creation through the object factory.

Definition at line 67 of file otbSynthetizeFilter.h.

Constructor & Destructor Documentation

SynthetizeFilter()

template<typename TInputImage , typename TOutputImage , typename TFunctor >

otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::SynthetizeFilter ( FunctorType  functor )

inlineexplicitprotected

Init constructor.

Definition at line 130 of file otbSynthetizeFilter.h.

~SynthetizeFilter()

template<typename TInputImage , typename TOutputImage , typename TFunctor >

otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::~SynthetizeFilter ( )

protecteddefault

Internal functor. Can only be set at filter creation through call to New.

Member Function Documentation

CheckInputImageDimensions()

template<typename TInputImage , typename TOutputImage , typename TFunctor >

void otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::CheckInputImageDimensions ( )

inlineprivate

Internal functor. Can only be set at filter creation through call to New.

Definition at line 188 of file otbSynthetizeFilter.h.

Referenced by otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::GenerateOutputInformation().

GenerateOutputInformation()

template<typename TInputImage , typename TOutputImage , typename TFunctor >

void otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::GenerateOutputInformation ( )

inlineoverrideprotected

Overrides GenerateOutputInformation to check images consistency.

Definition at line 135 of file otbSynthetizeFilter.h.

References otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::CheckInputImageDimensions().

GetInputs()

template<typename TInputImage , typename TOutputImage , typename TFunctor >

std::vector<InputImageType const*> otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::GetInputs ( ) const

inline

Returns a vector of input images.

Definition at line 116 of file otbSynthetizeFilter.h.

Referenced by otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::ThreadedGenerateData().

GetNameOfClass()

template<typename TInputImage , typename TOutputImage , typename TFunctor >

virtual const char* otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

GetNthInput()

template<typename TInputImage , typename TOutputImage , typename TFunctor >

InputImageType* otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::GetNthInput ( DataObjectPointerArraySizeType  idx )

inline

Return a pointer on the nth filter input

Definition at line 110 of file otbSynthetizeFilter.h.

New()

template<typename TInputImage , typename TOutputImage , typename TFunctor >

static Pointer otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::New ( FunctorType  functor )

inlinestatic

Method for creation through the object factory.

Definition at line 73 of file otbSynthetizeFilter.h.

Referenced by otb::MakeSynthetizeFilter().

ThreadedGenerateData()

template<typename TInputImage , typename TOutputImage , typename TFunctor >

void otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::ThreadedGenerateData ( OutputImageRegionType const &  outputRegionForThread, itk::ThreadIdType  threadId  )

inlineoverrideprotected

Main computation function called by each thread.

Parameters

[in]	outputRegionForThread	Specified output region to compute
[in]	threadId	Id of the computing threads

Definition at line 150 of file otbSynthetizeFilter.h.

References otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::GetInputs(), and otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::m_functor.

Member Data Documentation

InputImageDimension

template<typename TInputImage , typename TOutputImage , typename TFunctor >

const unsigned int otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::InputImageDimension = InputImageType::ImageDimension

static

Definition at line 60 of file otbSynthetizeFilter.h.

m_functor

template<typename TInputImage , typename TOutputImage , typename TFunctor >

FunctorType otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::m_functor

private

Internal functor. Can only be set at filter creation through call to New.

Definition at line 210 of file otbSynthetizeFilter.h.

Referenced by otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::ThreadedGenerateData().

OutputImageDimension

template<typename TInputImage , typename TOutputImage , typename TFunctor >

const unsigned int otb::SynthetizeFilter< TInputImage, TOutputImage, TFunctor >::OutputImageDimension = OutputImageType::ImageDimension

static

Definition at line 61 of file otbSynthetizeFilter.h.

---

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

• otbSynthetizeFilter.h