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::FunctionToImageFilter< TInputImage, TOutputImage, TFunction > Class Template Reference

Evaluates a ImageFunction onto a source image. More...

#include <otbFunctionToImageFilter.h>

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

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef FunctionType::Pointer FunctionPointer
 
typedef FunctionType::InputType FunctionPositionType
 
typedef TFunction FunctionType
 
typedef FunctionType::OutputType FunctionValueType
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef
InputImageType::ConstPointer 
InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef FunctionToImageFilter Self
 
typedef
itk::InPlaceImageFilter
< TInputImage, TOutputImage > 
Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
FunctionTypeGetFunction ()
 
virtual const char * GetNameOfClass () const
 
void SetFunction (FunctionType *PixelFunction)
 

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

 FunctionToImageFilter ()
 
virtual ~FunctionToImageFilter ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId)
 

Private Member Functions

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

Private Attributes

FunctionPointer m_PixelFunction
 

Detailed Description

template<class TInputImage, class TOutputImage, class TFunction>
class otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >

Evaluates a ImageFunction onto a source image.

The class walks an input image and evaluates the function at every pixel location. The output of the spatial function and the pixel type of the output image must be compatible.

Like its parent ImageToImageFilter, this class functions in the filtering pipeline and produces a unique output image.

The function has to inherit from itkImageFunction

See Also
SpatialFunctionImageEvaluatorFilter
SpatialFunctionImageFilter
ImageFunction

Definition at line 53 of file otbFunctionToImageFilter.h.

Member Typedef Documentation

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

Definition at line 61 of file otbFunctionToImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
typedef FunctionType::Pointer otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::FunctionPointer

Definition at line 81 of file otbFunctionToImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
typedef FunctionType::InputType otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::FunctionPositionType

Definition at line 83 of file otbFunctionToImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
typedef TFunction otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::FunctionType

Type of function.

Definition at line 80 of file otbFunctionToImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
typedef FunctionType::OutputType otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::FunctionValueType

Definition at line 82 of file otbFunctionToImageFilter.h.

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

Definition at line 74 of file otbFunctionToImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
typedef InputImageType::ConstPointer otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::InputImagePointer

Definition at line 72 of file otbFunctionToImageFilter.h.

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

Definition at line 73 of file otbFunctionToImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
typedef TInputImage otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::InputImageType

Some typedefs. Image size typedef.

Definition at line 67 of file otbFunctionToImageFilter.h.

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

Definition at line 78 of file otbFunctionToImageFilter.h.

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

Definition at line 76 of file otbFunctionToImageFilter.h.

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

Definition at line 77 of file otbFunctionToImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
typedef TOutputImage otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::OutputImageType

Definition at line 75 of file otbFunctionToImageFilter.h.

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

Definition at line 60 of file otbFunctionToImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
typedef FunctionToImageFilter otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::Self

Standard class typedefs.

Definition at line 58 of file otbFunctionToImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
typedef itk::InPlaceImageFilter<TInputImage, TOutputImage> otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::Superclass

Definition at line 59 of file otbFunctionToImageFilter.h.

Constructor & Destructor Documentation

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

Constructor

Definition at line 37 of file otbFunctionToImageFilter.txx.

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

Definition at line 108 of file otbFunctionToImageFilter.h.

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

Member Function Documentation

template<class TInputImage , class TOutputImage , class TFunction >
void otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::BeforeThreadedGenerateData ( void  )
protectedvirtual

Validate the presence of all three inputs. If one or more inputs are missing, throw an exception.

Connect one of the operands for pixel-wise addition BeforeThreadedGenerateData function. Validate inputs

Reimplemented in otb::SarBrightnessToImageFilter< TInputImage, TOutputImage >, and otb::SarRadiometricCalibrationToImageFilter< TInputImage, TOutputImage >.

Definition at line 61 of file otbFunctionToImageFilter.txx.

References otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::ThreadedGenerateData().

template<class TInputImage, class TOutputImage, class TFunction>
virtual::itk::LightObject::Pointer otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::CreateAnother ( void  ) const
template<class TInputImage, class TOutputImage, class TFunction>
FunctionType* otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::GetFunction ( )
inline

Definition at line 94 of file otbFunctionToImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
virtual const char* otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::GetNameOfClass ( ) const
virtual
template<class TInputImage, class TOutputImage, class TFunction>
static Pointer otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::New ( )
static

Method for creation through the object factory.

template<class TInputImage, class TOutputImage, class TFunction>
void otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::operator= ( const Self )
private
template<class TInputImage, class TOutputImage, class TFunction>
void otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::SetFunction ( FunctionType PixelFunction)
inline

Connect one of the operands for pixel-wise addition. Set the internal spatial function.

Definition at line 89 of file otbFunctionToImageFilter.h.

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

SpatialFunctionImageFilter 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()

ThreadedGenerateData function. Performs the pixel-wise addition

Definition at line 80 of file otbFunctionToImageFilter.txx.

References itk::ImageConstIterator< TImage >::GetIndex(), itk::ImageRegionConstIterator< TImage >::GoToBegin(), itk::ImageConstIterator< TImage >::IsAtEnd(), and itk::ImageRegionIterator< TImage >::Set().

Referenced by otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::BeforeThreadedGenerateData().

Member Data Documentation

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

Image dimensions

Definition at line 102 of file otbFunctionToImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
FunctionPointer otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::m_PixelFunction
private

The function that will be evaluated over the image

Definition at line 132 of file otbFunctionToImageFilter.h.

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

Definition at line 104 of file otbFunctionToImageFilter.h.


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