OTB  7.3.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage > Class Template Reference

#include <otbDisparityTranslateFilter.h>

+ Inheritance diagram for otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >:
+ Collaboration diagram for otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >:

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef TDisparityImage DispMapType
 
typedef GridType::RegionType GridRegionType
 
typedef TGridImage GridType
 
typedef DispMapType::IndexType IndexType
 
typedef DispMapType::IndexValueType IndexValueType
 
typedef TMaskImage MaskType
 
typedef DispMapType::PixelType PixelType
 
typedef itk::SmartPointer< SelfPointer
 
typedef DispMapType::PointType PointType
 
typedef DispMapType::RegionType RegionType
 
typedef DisparityTranslateFilter Self
 
typedef TSensorImage SensorType
 
typedef DispMapType::SizeType SizeType
 
typedef DispMapType::SpacingType SpacingType
 
typedef itk::ImageToImageFilter< TDisparityImage, TDisparityImage > Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
void SetDirectEpipolarRightGrid (const TGridImage *rgrid)
 
void SetDisparityMaskInput (const TMaskImage *mask)
 
void SetHorizontalDisparityMapInput (const TDisparityImage *hmap)
 
void SetInverseEpipolarLeftGrid (const TGridImage *lgrid)
 
void SetLeftSensorImageInput (const TSensorImage *left)
 
void SetVerticalDisparityMapInput (const TDisparityImage *vmap)
 
virtual void SetNoDataValue (PixelType _arg)
 
virtual const PixelTypeGetNoDataValue () const
 
const TDisparityImage * GetHorizontalDisparityMapInput () const
 
const TDisparityImage * GetVerticalDisparityMapInput () const
 
const TGridImage * GetInverseEpipolarLeftGrid () const
 
const TGridImage * GetDirectEpipolarRightGrid () const
 
const TMaskImage * GetDisparityMaskInput () const
 
const TSensorImage * GetLeftSensorImageInput () const
 
TDisparityImage * GetHorizontalDisparityMapOutput ()
 
TDisparityImage * GetVerticalDisparityMapOutput ()
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 DisparityTranslateFilter ()
 
void GenerateInputRequestedRegion () override
 
void GenerateOutputInformation () override
 
void ThreadedGenerateData (const RegionType &outputRegionForThread, itk::ThreadIdType threadId) override
 
void VerifyInputInformation () override
 
 ~DisparityTranslateFilter () override
 

Private Member Functions

 DisparityTranslateFilter (const Self &)=delete
 
void operator= (const Self &)=delete
 

Private Attributes

PixelType m_NoDataValue
 

Detailed Description

template<class TDisparityImage, class TGridImage = otb::VectorImage<float, 2>, class TSensorImage = otb::Image<unsigned short, 2>, class TMaskImage = otb::Image<unsigned char, 2>>
class otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >

Translate epipolar disparities into sensor disparities.

This filter resamples a disparity map computed in epipolar geometry into a disparity map relative to sensor geometry. The output disparity map is aligned on the left sensor image. The disparity values are computed relative to the physical coordinates of the left and right sensor images. The vertical disparity mask input and the mask are optional.

Definition at line 48 of file otbDisparityTranslateFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<class TDisparityImage , class TGridImage = otb::VectorImage<float, 2>, class TSensorImage = otb::Image<unsigned short, 2>, class TMaskImage = otb::Image<unsigned char, 2>>
typedef itk::SmartPointer<const Self> otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::ConstPointer

Definition at line 55 of file otbDisparityTranslateFilter.h.

◆ DispMapType

template<class TDisparityImage , class TGridImage = otb::VectorImage<float, 2>, class TSensorImage = otb::Image<unsigned short, 2>, class TMaskImage = otb::Image<unsigned char, 2>>
typedef TDisparityImage otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::DispMapType

Useful typedefs

Definition at line 61 of file otbDisparityTranslateFilter.h.

◆ GridRegionType

template<class TDisparityImage , class TGridImage = otb::VectorImage<float, 2>, class TSensorImage = otb::Image<unsigned short, 2>, class TMaskImage = otb::Image<unsigned char, 2>>
typedef GridType::RegionType otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::GridRegionType

Definition at line 77 of file otbDisparityTranslateFilter.h.

◆ GridType

template<class TDisparityImage , class TGridImage = otb::VectorImage<float, 2>, class TSensorImage = otb::Image<unsigned short, 2>, class TMaskImage = otb::Image<unsigned char, 2>>
typedef TGridImage otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::GridType

Definition at line 65 of file otbDisparityTranslateFilter.h.

◆ IndexType

template<class TDisparityImage , class TGridImage = otb::VectorImage<float, 2>, class TSensorImage = otb::Image<unsigned short, 2>, class TMaskImage = otb::Image<unsigned char, 2>>
typedef DispMapType::IndexType otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::IndexType

Definition at line 72 of file otbDisparityTranslateFilter.h.

◆ IndexValueType

template<class TDisparityImage , class TGridImage = otb::VectorImage<float, 2>, class TSensorImage = otb::Image<unsigned short, 2>, class TMaskImage = otb::Image<unsigned char, 2>>
typedef DispMapType::IndexValueType otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::IndexValueType

Definition at line 75 of file otbDisparityTranslateFilter.h.

◆ MaskType

template<class TDisparityImage , class TGridImage = otb::VectorImage<float, 2>, class TSensorImage = otb::Image<unsigned short, 2>, class TMaskImage = otb::Image<unsigned char, 2>>
typedef TMaskImage otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::MaskType

Definition at line 66 of file otbDisparityTranslateFilter.h.

◆ PixelType

template<class TDisparityImage , class TGridImage = otb::VectorImage<float, 2>, class TSensorImage = otb::Image<unsigned short, 2>, class TMaskImage = otb::Image<unsigned char, 2>>
typedef DispMapType::PixelType otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::PixelType

Definition at line 69 of file otbDisparityTranslateFilter.h.

◆ Pointer

template<class TDisparityImage , class TGridImage = otb::VectorImage<float, 2>, class TSensorImage = otb::Image<unsigned short, 2>, class TMaskImage = otb::Image<unsigned char, 2>>
typedef itk::SmartPointer<Self> otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::Pointer

Definition at line 54 of file otbDisparityTranslateFilter.h.

◆ PointType

template<class TDisparityImage , class TGridImage = otb::VectorImage<float, 2>, class TSensorImage = otb::Image<unsigned short, 2>, class TMaskImage = otb::Image<unsigned char, 2>>
typedef DispMapType::PointType otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::PointType

Definition at line 74 of file otbDisparityTranslateFilter.h.

◆ RegionType

template<class TDisparityImage , class TGridImage = otb::VectorImage<float, 2>, class TSensorImage = otb::Image<unsigned short, 2>, class TMaskImage = otb::Image<unsigned char, 2>>
typedef DispMapType::RegionType otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::RegionType

Definition at line 70 of file otbDisparityTranslateFilter.h.

◆ Self

template<class TDisparityImage , class TGridImage = otb::VectorImage<float, 2>, class TSensorImage = otb::Image<unsigned short, 2>, class TMaskImage = otb::Image<unsigned char, 2>>
typedef DisparityTranslateFilter otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::Self

Standard class typedef

Definition at line 52 of file otbDisparityTranslateFilter.h.

◆ SensorType

template<class TDisparityImage , class TGridImage = otb::VectorImage<float, 2>, class TSensorImage = otb::Image<unsigned short, 2>, class TMaskImage = otb::Image<unsigned char, 2>>
typedef TSensorImage otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::SensorType

Definition at line 67 of file otbDisparityTranslateFilter.h.

◆ SizeType

template<class TDisparityImage , class TGridImage = otb::VectorImage<float, 2>, class TSensorImage = otb::Image<unsigned short, 2>, class TMaskImage = otb::Image<unsigned char, 2>>
typedef DispMapType::SizeType otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::SizeType

Definition at line 71 of file otbDisparityTranslateFilter.h.

◆ SpacingType

template<class TDisparityImage , class TGridImage = otb::VectorImage<float, 2>, class TSensorImage = otb::Image<unsigned short, 2>, class TMaskImage = otb::Image<unsigned char, 2>>
typedef DispMapType::SpacingType otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::SpacingType

Definition at line 73 of file otbDisparityTranslateFilter.h.

◆ Superclass

template<class TDisparityImage , class TGridImage = otb::VectorImage<float, 2>, class TSensorImage = otb::Image<unsigned short, 2>, class TMaskImage = otb::Image<unsigned char, 2>>
typedef itk::ImageToImageFilter<TDisparityImage, TDisparityImage> otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::Superclass

Definition at line 53 of file otbDisparityTranslateFilter.h.

Constructor & Destructor Documentation

◆ DisparityTranslateFilter() [1/2]

template<class TDisparityImage , class TGridImage , class TSensorImage , class TMaskImage >
otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::DisparityTranslateFilter ( )
protected

Constructor

Definition at line 33 of file otbDisparityTranslateFilter.hxx.

◆ ~DisparityTranslateFilter()

template<class TDisparityImage , class TGridImage = otb::VectorImage<float, 2>, class TSensorImage = otb::Image<unsigned short, 2>, class TMaskImage = otb::Image<unsigned char, 2>>
otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::~DisparityTranslateFilter ( )
inlineoverrideprotected

Destructor

Definition at line 123 of file otbDisparityTranslateFilter.h.

◆ DisparityTranslateFilter() [2/2]

template<class TDisparityImage , class TGridImage = otb::VectorImage<float, 2>, class TSensorImage = otb::Image<unsigned short, 2>, class TMaskImage = otb::Image<unsigned char, 2>>
otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::DisparityTranslateFilter ( const Self )
privatedelete

Member Function Documentation

◆ CreateAnother()

template<class TDisparityImage , class TGridImage = otb::VectorImage<float, 2>, class TSensorImage = otb::Image<unsigned short, 2>, class TMaskImage = otb::Image<unsigned char, 2>>
virtual::itk::LightObject::Pointer otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::CreateAnother ( void  ) const

◆ GenerateInputRequestedRegion()

template<class TDisparityImage , class TGridImage , class TSensorImage , class TMaskImage >
void otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::GenerateInputRequestedRegion ( void  )
overrideprotected

Generate input requested region

Definition at line 195 of file otbDisparityTranslateFilter.hxx.

◆ GenerateOutputInformation()

template<class TDisparityImage , class TGridImage , class TSensorImage , class TMaskImage >
void otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::GenerateOutputInformation ( void  )
overrideprotected

Generate output information

Definition at line 169 of file otbDisparityTranslateFilter.hxx.

References otb::MetaDataKey::NoDataValue, and otb::MetaDataKey::NoDataValueAvailable.

◆ GetDirectEpipolarRightGrid()

template<class TDisparityImage , class TGridImage , class TSensorImage , class TMaskImage >
const TGridImage * otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::GetDirectEpipolarRightGrid ( ) const

Get the inputs

Definition at line 119 of file otbDisparityTranslateFilter.hxx.

◆ GetDisparityMaskInput()

template<class TDisparityImage , class TGridImage , class TSensorImage , class TMaskImage >
const TMaskImage * otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::GetDisparityMaskInput ( ) const

Get the inputs

Definition at line 129 of file otbDisparityTranslateFilter.hxx.

◆ GetHorizontalDisparityMapInput()

template<class TDisparityImage , class TGridImage , class TSensorImage , class TMaskImage >
const TDisparityImage * otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::GetHorizontalDisparityMapInput ( ) const

Get the inputs

Definition at line 89 of file otbDisparityTranslateFilter.hxx.

◆ GetHorizontalDisparityMapOutput()

template<class TDisparityImage , class TGridImage , class TSensorImage , class TMaskImage >
TDisparityImage * otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::GetHorizontalDisparityMapOutput ( )

Get output disparity maps

Definition at line 149 of file otbDisparityTranslateFilter.hxx.

◆ GetInverseEpipolarLeftGrid()

template<class TDisparityImage , class TGridImage , class TSensorImage , class TMaskImage >
const TGridImage * otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::GetInverseEpipolarLeftGrid ( ) const

Get the inputs

Definition at line 109 of file otbDisparityTranslateFilter.hxx.

◆ GetLeftSensorImageInput()

template<class TDisparityImage , class TGridImage , class TSensorImage , class TMaskImage >
const TSensorImage * otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::GetLeftSensorImageInput ( ) const

Get the inputs

Definition at line 139 of file otbDisparityTranslateFilter.hxx.

◆ GetNameOfClass()

template<class TDisparityImage , class TGridImage = otb::VectorImage<float, 2>, class TSensorImage = otb::Image<unsigned short, 2>, class TMaskImage = otb::Image<unsigned char, 2>>
virtual const char* otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

◆ GetNoDataValue()

template<class TDisparityImage , class TGridImage = otb::VectorImage<float, 2>, class TSensorImage = otb::Image<unsigned short, 2>, class TMaskImage = otb::Image<unsigned char, 2>>
virtual const PixelType& otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::GetNoDataValue ( ) const
virtual

Set/Get macro for NoDataValue

◆ GetVerticalDisparityMapInput()

template<class TDisparityImage , class TGridImage , class TSensorImage , class TMaskImage >
const TDisparityImage * otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::GetVerticalDisparityMapInput ( ) const

Get the inputs

Definition at line 99 of file otbDisparityTranslateFilter.hxx.

◆ GetVerticalDisparityMapOutput()

template<class TDisparityImage , class TGridImage , class TSensorImage , class TMaskImage >
TDisparityImage * otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::GetVerticalDisparityMapOutput ( )

Get output disparity maps

Definition at line 159 of file otbDisparityTranslateFilter.hxx.

◆ New()

template<class TDisparityImage , class TGridImage = otb::VectorImage<float, 2>, class TSensorImage = otb::Image<unsigned short, 2>, class TMaskImage = otb::Image<unsigned char, 2>>
static Pointer otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::New ( )
static

Method for creation through the object factory.

◆ operator=()

template<class TDisparityImage , class TGridImage = otb::VectorImage<float, 2>, class TSensorImage = otb::Image<unsigned short, 2>, class TMaskImage = otb::Image<unsigned char, 2>>
void otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::operator= ( const Self )
privatedelete

◆ SetDirectEpipolarRightGrid()

template<class TDisparityImage , class TGridImage , class TSensorImage , class TMaskImage >
void otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::SetDirectEpipolarRightGrid ( const TGridImage *  rgrid)

Set the direct epipolar right grid

Definition at line 68 of file otbDisparityTranslateFilter.hxx.

◆ SetDisparityMaskInput()

template<class TDisparityImage , class TGridImage , class TSensorImage , class TMaskImage >
void otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::SetDisparityMaskInput ( const TMaskImage *  mask)

Set the mask relative to the input disparity map

Definition at line 75 of file otbDisparityTranslateFilter.hxx.

◆ SetHorizontalDisparityMapInput()

template<class TDisparityImage , class TGridImage , class TSensorImage , class TMaskImage >
void otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::SetHorizontalDisparityMapInput ( const TDisparityImage *  hmap)

Set the horizontal disparity map

Definition at line 47 of file otbDisparityTranslateFilter.hxx.

◆ SetInverseEpipolarLeftGrid()

template<class TDisparityImage , class TGridImage , class TSensorImage , class TMaskImage >
void otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::SetInverseEpipolarLeftGrid ( const TGridImage *  lgrid)

Set the inverse left epipolar grid

Definition at line 61 of file otbDisparityTranslateFilter.hxx.

◆ SetLeftSensorImageInput()

template<class TDisparityImage , class TGridImage , class TSensorImage , class TMaskImage >
void otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::SetLeftSensorImageInput ( const TSensorImage *  left)

Set the left input sensor image (used as a support for the output disparity map)

Definition at line 82 of file otbDisparityTranslateFilter.hxx.

◆ SetNoDataValue()

template<class TDisparityImage , class TGridImage = otb::VectorImage<float, 2>, class TSensorImage = otb::Image<unsigned short, 2>, class TMaskImage = otb::Image<unsigned char, 2>>
virtual void otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::SetNoDataValue ( PixelType  _arg)
virtual

Set/Get macro for NoDataValue

◆ SetVerticalDisparityMapInput()

template<class TDisparityImage , class TGridImage , class TSensorImage , class TMaskImage >
void otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::SetVerticalDisparityMapInput ( const TDisparityImage *  vmap)

Set the vertical disparity map

Definition at line 54 of file otbDisparityTranslateFilter.hxx.

◆ ThreadedGenerateData()

template<class TDisparityImage , class TGridImage , class TSensorImage , class TMaskImage >
void otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::ThreadedGenerateData ( const RegionType outputRegionForThread,
itk::ThreadIdType  threadId 
)
overrideprotected

Threaded generate data

Definition at line 319 of file otbDisparityTranslateFilter.hxx.

◆ VerifyInputInformation()

template<class TDisparityImage , class TGridImage = otb::VectorImage<float, 2>, class TSensorImage = otb::Image<unsigned short, 2>, class TMaskImage = otb::Image<unsigned char, 2>>
void otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::VerifyInputInformation ( )
inlineoverrideprotected

Override VerifyInputInformation() since this filter's inputs do not need to occupy the same physical space.

See also
ProcessObject::VerifyInputInformation

Definition at line 139 of file otbDisparityTranslateFilter.h.

Member Data Documentation

◆ m_NoDataValue

template<class TDisparityImage , class TGridImage = otb::VectorImage<float, 2>, class TSensorImage = otb::Image<unsigned short, 2>, class TMaskImage = otb::Image<unsigned char, 2>>
PixelType otb::DisparityTranslateFilter< TDisparityImage, TGridImage, TSensorImage, TMaskImage >::m_NoDataValue
private

Definition at line 148 of file otbDisparityTranslateFilter.h.


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