otb::ResetMarginFilter< TImage > Class Template Reference

#include <otbResetMarginFilter.h>

Inheritance diagram for otb::ResetMarginFilter< TImage >:

Collaboration diagram for otb::ResetMarginFilter< TImage >:

Public Types
Convenient typedefs for simplifying declarations
using	InputImageType = TImage
using	OutputImageType = TImage

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 = ResetMarginFilter
using	Superclass = itk::ImageToImageFilter< InputImageType, OutputImageType >
using	Pointer = itk::SmartPointer< Self >
using	ConstPointer = itk::SmartPointer< const Self >
static Pointer	New ()
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const

Image typedef support
using	InputPixelType = typename InputImageType::PixelType
using	OutputPixelType = typename OutputImageType::PixelType
using	InternalPixelType = typename OutputImageType::InternalPixelType
using	InputRealType = typename itk::NumericTraits< InputPixelType >::RealType
using	InputImageRegionType = typename InputImageType::RegionType
using	OutputImageRegionType = typename OutputImageType::RegionType
using	InputIndexType = typename InputImageType::IndexType
using	InputSizeType = typename InputImageType::SizeType
using	OutputIndexType = typename OutputImageType::IndexType
using	OutputSizeType = typename OutputImageType::SizeType
InputImageRegionType	m_ROI
InternalPixelType	m_Pad = 0.0
void	SetROI (const InputImageRegionType &roi)
const InputImageRegionType &	GetROI () const
void	SetPaddingValue (InternalPixelType val)
InternalPixelType	GetPaddingValue () const
	ResetMarginFilter ()=default
InputImageType *	GetInputImage ()
InputImageType const *	GetInputImage () const
void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, OutputImageRegionType const &srcRegion) override
InputImageRegionType	OutputRegionToInputRegion (OutputImageRegionType const &srcRegion)
void	GenerateOutputInformation () override
void	ThreadedGenerateData (OutputImageRegionType const &outputRegionForThread, itk::ThreadIdType threadId) override

Detailed Description

template<typename TImage>
class otb::ResetMarginFilter< TImage >

Region clamping filter. This filter is a kind of ROI pass filter. Data within the ROI is kept with its original value. Data outside ROI is forced to a padding value (0 by default).

Also, this filter propagate the exact ROI upstream in the pipeline. This way, if it's piped after another filter, the upstream filter isn't executed on the data outside the ROI.

Template Parameters

TImage

Image type.

See also

otb::ExtractROI<>

Author

Luc Hermitte (CS Group)

Copyright

CNES

Definition at line 44 of file otbResetMarginFilter.h.

Member Typedef Documentation

ConstPointer

template<typename TImage >

using otb::ResetMarginFilter< TImage >::ConstPointer = itk::SmartPointer<const Self>

Method for creation through the object factory.

Definition at line 65 of file otbResetMarginFilter.h.

InputImageRegionType

template<typename TImage >

using otb::ResetMarginFilter< TImage >::InputImageRegionType = typename InputImageType::RegionType

Hidden constructor.

Definition at line 80 of file otbResetMarginFilter.h.

InputImageType

template<typename TImage >

using otb::ResetMarginFilter< TImage >::InputImageType = TImage

Definition at line 50 of file otbResetMarginFilter.h.

InputIndexType

template<typename TImage >

using otb::ResetMarginFilter< TImage >::InputIndexType = typename InputImageType::IndexType

Hidden constructor.

Definition at line 82 of file otbResetMarginFilter.h.

InputPixelType

template<typename TImage >

using otb::ResetMarginFilter< TImage >::InputPixelType = typename InputImageType::PixelType

Hidden constructor.

Definition at line 76 of file otbResetMarginFilter.h.

InputRealType

template<typename TImage >

using otb::ResetMarginFilter< TImage >::InputRealType = typename itk::NumericTraits<InputPixelType>::RealType

Hidden constructor.

Definition at line 79 of file otbResetMarginFilter.h.

InputSizeType

template<typename TImage >

using otb::ResetMarginFilter< TImage >::InputSizeType = typename InputImageType::SizeType

Hidden constructor.

Definition at line 83 of file otbResetMarginFilter.h.

InternalPixelType

template<typename TImage >

using otb::ResetMarginFilter< TImage >::InternalPixelType = typename OutputImageType::InternalPixelType

Hidden constructor.

Definition at line 78 of file otbResetMarginFilter.h.

OutputImageRegionType

template<typename TImage >

using otb::ResetMarginFilter< TImage >::OutputImageRegionType = typename OutputImageType::RegionType

Hidden constructor.

Definition at line 81 of file otbResetMarginFilter.h.

OutputImageType

template<typename TImage >

using otb::ResetMarginFilter< TImage >::OutputImageType = TImage

Definition at line 51 of file otbResetMarginFilter.h.

OutputIndexType

template<typename TImage >

using otb::ResetMarginFilter< TImage >::OutputIndexType = typename OutputImageType::IndexType

Hidden constructor.

Definition at line 84 of file otbResetMarginFilter.h.

OutputPixelType

template<typename TImage >

using otb::ResetMarginFilter< TImage >::OutputPixelType = typename OutputImageType::PixelType

Hidden constructor.

Definition at line 77 of file otbResetMarginFilter.h.

OutputSizeType

template<typename TImage >

using otb::ResetMarginFilter< TImage >::OutputSizeType = typename OutputImageType::SizeType

Hidden constructor.

Definition at line 85 of file otbResetMarginFilter.h.

Pointer

template<typename TImage >

using otb::ResetMarginFilter< TImage >::Pointer = itk::SmartPointer<Self>

Method for creation through the object factory.

Definition at line 64 of file otbResetMarginFilter.h.

Self

template<typename TImage >

using otb::ResetMarginFilter< TImage >::Self = ResetMarginFilter

Method for creation through the object factory.

Definition at line 62 of file otbResetMarginFilter.h.

Superclass

template<typename TImage >

using otb::ResetMarginFilter< TImage >::Superclass = itk::ImageToImageFilter<InputImageType, OutputImageType>

Method for creation through the object factory.

Definition at line 63 of file otbResetMarginFilter.h.

Constructor & Destructor Documentation

ResetMarginFilter()

template<typename TImage >

otb::ResetMarginFilter< TImage >::ResetMarginFilter ( )

protecteddefault

Hidden constructor.

Member Function Documentation

CallCopyOutputRegionToInputRegion()

template<typename TImage >

void otb::ResetMarginFilter< TImage >::CallCopyOutputRegionToInputRegion ( InputImageRegionType &  destRegion, OutputImageRegionType const &  srcRegion  )

inlineoverrideprotected

otbResetMarginFilter doesn't need an input requested region as large as the output requested region.

See also

ImageToImageFilter::GenerateInputRequestedRegion()

Definition at line 121 of file otbResetMarginFilter.h.

References otb::ResetMarginFilter< TImage >::OutputRegionToInputRegion().

CreateAnother()

template<typename TImage >

virtual::itk::LightObject::Pointer otb::ResetMarginFilter< TImage >::CreateAnother

(

void

)

const

Method for creation through the object factory.

GenerateOutputInformation()

template<typename TImage >

void otb::ResetMarginFilter< TImage >::GenerateOutputInformation

overrideprotected

Override GenerateOutputInformation() to handle vector images

Definition at line 38 of file otbResetMarginFilter.hxx.

GetInputImage() [1/2]

template<typename TImage >

InputImageType* otb::ResetMarginFilter< TImage >::GetInputImage ( )

inlineprotected

Hidden constructor.

Definition at line 114 of file otbResetMarginFilter.h.

GetInputImage() [2/2]

template<typename TImage >

InputImageType const* otb::ResetMarginFilter< TImage >::GetInputImage ( ) const

inlineprotected

Hidden constructor.

Definition at line 115 of file otbResetMarginFilter.h.

GetNameOfClass()

template<typename TImage >

virtual const char* otb::ResetMarginFilter< TImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

GetPaddingValue()

template<typename TImage >

InternalPixelType otb::ResetMarginFilter< TImage >::GetPaddingValue ( ) const

inline

Hidden constructor.

Definition at line 105 of file otbResetMarginFilter.h.

References otb::ResetMarginFilter< TImage >::m_Pad.

GetROI()

template<typename TImage >

const InputImageRegionType& otb::ResetMarginFilter< TImage >::GetROI ( ) const

inline

Hidden constructor.

Definition at line 95 of file otbResetMarginFilter.h.

References otb::ResetMarginFilter< TImage >::m_ROI.

New()

template<typename TImage >

static Pointer otb::ResetMarginFilter< TImage >::New ( )

static

Method for creation through the object factory.

OutputRegionToInputRegion()

template<typename TImage >

ResetMarginFilter< TImage >::InputImageRegionType otb::ResetMarginFilter< TImage >::OutputRegionToInputRegion ( OutputImageRegionType const &  srcRegion )

protected

Functional implementation of CallCopyOutputRegionToInputRegion().

Definition at line 175 of file otbResetMarginFilter.hxx.

Referenced by otb::ResetMarginFilter< TImage >::CallCopyOutputRegionToInputRegion().

SetPaddingValue()

template<typename TImage >

void otb::ResetMarginFilter< TImage >::SetPaddingValue ( InternalPixelType  val )

inline

Hidden constructor.

Definition at line 100 of file otbResetMarginFilter.h.

References otb::ResetMarginFilter< TImage >::m_Pad.

SetROI()

template<typename TImage >

void otb::ResetMarginFilter< TImage >::SetROI ( const InputImageRegionType &  roi )

inline

Hidden constructor.

Definition at line 90 of file otbResetMarginFilter.h.

References otb::ResetMarginFilter< TImage >::m_ROI.

ThreadedGenerateData()

template<typename TImage >

void otb::ResetMarginFilter< TImage >::ThreadedGenerateData ( OutputImageRegionType const &  outputRegionForThread, itk::ThreadIdType  threadId  )

overrideprotected

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 49 of file otbResetMarginFilter.hxx.

References otbMsgDevMacro.

Member Data Documentation

InputImageDimension

template<typename TImage >

const unsigned int otb::ResetMarginFilter< TImage >::InputImageDimension = InputImageType::ImageDimension

static

Definition at line 56 of file otbResetMarginFilter.h.

m_Pad

template<typename TImage >

InternalPixelType otb::ResetMarginFilter< TImage >::m_Pad = 0.0

private

Hidden constructor.

Definition at line 152 of file otbResetMarginFilter.h.

Referenced by otb::ResetMarginFilter< TImage >::GetPaddingValue(), and otb::ResetMarginFilter< TImage >::SetPaddingValue().

m_ROI

template<typename TImage >

InputImageRegionType otb::ResetMarginFilter< TImage >::m_ROI

private

Hidden constructor.

Definition at line 150 of file otbResetMarginFilter.h.

Referenced by otb::ResetMarginFilter< TImage >::GetROI(), and otb::ResetMarginFilter< TImage >::SetROI().

OutputImageDimension

template<typename TImage >

const unsigned int otb::ResetMarginFilter< TImage >::OutputImageDimension = OutputImageType::ImageDimension

static

Definition at line 57 of file otbResetMarginFilter.h.

---

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

• otbResetMarginFilter.h
• otbResetMarginFilter.hxx