otb::ClampImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <otbClampImageFilter.h>

Inheritance diagram for otb::ClampImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for otb::ClampImageFilter< TInputImage, TOutputImage >:

Public Types
using	ConstPointer = itk::SmartPointer< const Self >
using	FunctorType = Functor::ConvertTypeFunctor< typename TInputImage::PixelType, typename TOutputImage::PixelType >
using	InputImagePixelType = typename InputImageType::PixelType
using	InputImageRegionType = typename InputImageType::RegionType
using	InputImageType = TInputImage
using	OutputImagePixelType = typename OutputImageType::PixelType
using	OutputImageRegionType = typename OutputImageType::RegionType
using	OutputImageType = TOutputImage
using	OutputInternalPixelType = typename OutputImageType::InternalPixelType
using	OutputPixelValueType = typename itk::NumericTraits< OutputInternalPixelType >::ValueType
using	Pointer = itk::SmartPointer< Self >
using	Self = ClampImageFilter
using	Superclass = itk::ImageToImageFilter< TInputImage, TOutputImage >

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
void	ClampAbove (const OutputPixelValueType &thresh)
void	ClampBelow (const OutputPixelValueType &thresh)
void	ClampOutside (const OutputPixelValueType &lower, const OutputPixelValueType &upper)

Static Public Member Functions
static Pointer	New ()
OutputPixelValueType	m_Lower
OutputPixelValueType	m_Upper
FunctorType	m_Functor
void	SetThresholds (OutputPixelValueType lowerVal, OutputPixelValueType upperVal)
virtual OutputPixelValueType	GetLower () const
virtual OutputPixelValueType	GetUpper () const
	ClampImageFilter ()
	~ClampImageFilter () override=default
void	PrintSelf (std::ostream &os, itk::Indent indent) const override
void	GenerateOutputInformation (void) override
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId) override
FunctorType &	GetFunctor () noexcept
FunctorType const &	GetFunctor () const noexcept
	ClampImageFilter (const Self &)=delete
void	operator= (const Self &)=delete

Detailed Description

template<class TInputImage, class TOutputImage = TInputImage>
class otb::ClampImageFilter< TInputImage, TOutputImage >

Clamp image values to be below, over, or between threshold values.

ClampImageFilter clamp image values to be between an upper and lower value. Values lower than m_Lower values are set to lower, and values greater than upper threshold are set to upper threshold value. This filter can also be used to cast any type of image into any other type as long as those types are arithmetics or complex.

By default lower and upper thresholds are set to the maximum and minimum bounds of the image internal pixel value.

Definition at line 48 of file otbClampImageFilter.h.

Member Typedef Documentation

ConstPointer

template<class TInputImage , class TOutputImage = TInputImage>

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

Definition at line 57 of file otbClampImageFilter.h.

FunctorType

template<class TInputImage , class TOutputImage = TInputImage>

using otb::ClampImageFilter< TInputImage, TOutputImage >::FunctorType = Functor::ConvertTypeFunctor<typename TInputImage::PixelType, typename TOutputImage::PixelType>

Definition at line 55 of file otbClampImageFilter.h.

InputImagePixelType

template<class TInputImage , class TOutputImage = TInputImage>

using otb::ClampImageFilter< TInputImage, TOutputImage >::InputImagePixelType = typename InputImageType::PixelType

Definition at line 69 of file otbClampImageFilter.h.

InputImageRegionType

template<class TInputImage , class TOutputImage = TInputImage>

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

Definition at line 68 of file otbClampImageFilter.h.

InputImageType

template<class TInputImage , class TOutputImage = TInputImage>

using otb::ClampImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage

Some additional typedefs.

Definition at line 67 of file otbClampImageFilter.h.

OutputImagePixelType

template<class TInputImage , class TOutputImage = TInputImage>

using otb::ClampImageFilter< TInputImage, TOutputImage >::OutputImagePixelType = typename OutputImageType::PixelType

Definition at line 74 of file otbClampImageFilter.h.

OutputImageRegionType

template<class TInputImage , class TOutputImage = TInputImage>

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

Definition at line 73 of file otbClampImageFilter.h.

OutputImageType

template<class TInputImage , class TOutputImage = TInputImage>

using otb::ClampImageFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage

Some additional typedefs.

Definition at line 72 of file otbClampImageFilter.h.

OutputInternalPixelType

template<class TInputImage , class TOutputImage = TInputImage>

using otb::ClampImageFilter< TInputImage, TOutputImage >::OutputInternalPixelType = typename OutputImageType::InternalPixelType

Definition at line 75 of file otbClampImageFilter.h.

OutputPixelValueType

template<class TInputImage , class TOutputImage = TInputImage>

using otb::ClampImageFilter< TInputImage, TOutputImage >::OutputPixelValueType = typename itk::NumericTraits<OutputInternalPixelType>::ValueType

Definition at line 76 of file otbClampImageFilter.h.

Pointer

template<class TInputImage , class TOutputImage = TInputImage>

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

Definition at line 56 of file otbClampImageFilter.h.

Self

template<class TInputImage , class TOutputImage = TInputImage>

using otb::ClampImageFilter< TInputImage, TOutputImage >::Self = ClampImageFilter

Standard class typedefs.

Definition at line 53 of file otbClampImageFilter.h.

Superclass

template<class TInputImage , class TOutputImage = TInputImage>

using otb::ClampImageFilter< TInputImage, TOutputImage >::Superclass = itk::ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 54 of file otbClampImageFilter.h.

Constructor & Destructor Documentation

ClampImageFilter() [1/2]

template<class TInputImage , class TOutputImage >

otb::ClampImageFilter< TInputImage, TOutputImage >::ClampImageFilter

protected

Set/Get methods to set the lower and upper threshold

Definition at line 41 of file otbClampImageFilter.hxx.

~ClampImageFilter()

template<class TInputImage , class TOutputImage = TInputImage>

otb::ClampImageFilter< TInputImage, TOutputImage >::~ClampImageFilter ( )

overrideprotecteddefault

Set/Get methods to set the lower and upper threshold

ClampImageFilter() [2/2]

template<class TInputImage , class TOutputImage = TInputImage>

otb::ClampImageFilter< TInputImage, TOutputImage >::ClampImageFilter ( const Self &  )

privatedelete

Set/Get methods to set the lower and upper threshold

Member Function Documentation

ClampAbove()

template<class TInputImage , class TOutputImage >

void otb::ClampImageFilter< TInputImage, TOutputImage >::ClampAbove

(

const OutputPixelValueType &

thresh

)

The values greater than or equal to the value are set to thresh.

The values greater than or equal to the value are set to UpperValue

Definition at line 76 of file otbClampImageFilter.hxx.

ClampBelow()

template<class TInputImage , class TOutputImage >

void otb::ClampImageFilter< TInputImage, TOutputImage >::ClampBelow

(

const OutputPixelValueType &

thresh

)

The values less than or equal to the value are set to thresh.

The values less than or equal to the value are set to OutsideValue

Definition at line 92 of file otbClampImageFilter.hxx.

ClampOutside()

template<class TInputImage , class TOutputImage >

void otb::ClampImageFilter< TInputImage, TOutputImage >::ClampOutside	(	const OutputPixelValueType &	lower,
		const OutputPixelValueType &	upper
	)

The values outside the range are set to lower or upper.

The values outside the range are set to OutsideValue

Definition at line 109 of file otbClampImageFilter.hxx.

CreateAnother()

template<class TInputImage , class TOutputImage = TInputImage>

virtual::itk::LightObject::Pointer otb::ClampImageFilter< TInputImage, TOutputImage >::CreateAnother

(

void

)

const

GenerateOutputInformation()

template<class TInputImage , class TOutputImage = TInputImage>

void otb::ClampImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation ( void  )

inlineoverrideprotected

Set/Get methods to set the lower and upper threshold

Definition at line 99 of file otbClampImageFilter.h.

GetFunctor() [1/2]

template<class TInputImage , class TOutputImage = TInputImage>

FunctorType const& otb::ClampImageFilter< TInputImage, TOutputImage >::GetFunctor ( ) const

inlineprotectednoexcept

Set/Get methods to set the lower and upper threshold

Definition at line 110 of file otbClampImageFilter.h.

GetFunctor() [2/2]

template<class TInputImage , class TOutputImage = TInputImage>

FunctorType& otb::ClampImageFilter< TInputImage, TOutputImage >::GetFunctor ( )

inlineprotectednoexcept

Set/Get methods to set the lower and upper threshold

Definition at line 109 of file otbClampImageFilter.h.

GetLower()

template<class TInputImage , class TOutputImage = TInputImage>

virtual OutputPixelValueType otb::ClampImageFilter< TInputImage, TOutputImage >::GetLower ( ) const

virtual

Set/Get methods to set the lower and upper threshold

GetNameOfClass()

template<class TInputImage , class TOutputImage = TInputImage>

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

virtual

Run-time type information (and related methods).

GetUpper()

template<class TInputImage , class TOutputImage = TInputImage>

virtual OutputPixelValueType otb::ClampImageFilter< TInputImage, TOutputImage >::GetUpper ( ) const

virtual

Set/Get methods to set the lower and upper threshold

New()

template<class TInputImage , class TOutputImage = TInputImage>

static Pointer otb::ClampImageFilter< TInputImage, TOutputImage >::New ( )

static

Method for creation through the object factory.

operator=()

template<class TInputImage , class TOutputImage = TInputImage>

void otb::ClampImageFilter< TInputImage, TOutputImage >::operator= ( const Self &  )

privatedelete

Set/Get methods to set the lower and upper threshold

PrintSelf()

template<class TInputImage , class TOutputImage >

void otb::ClampImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os, itk::Indent  indent  ) const

overrideprotected

Set/Get methods to set the lower and upper threshold

Definition at line 64 of file otbClampImageFilter.hxx.

SetThresholds()

template<class TInputImage , class TOutputImage >

void otb::ClampImageFilter< TInputImage, TOutputImage >::SetThresholds	(	OutputPixelValueType	lowerVal,
		OutputPixelValueType	upperVal
	)

Set/Get methods to set the lower and upper threshold

Definition at line 48 of file otbClampImageFilter.hxx.

ThreadedGenerateData()

template<class TInputImage , class TOutputImage >

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

overrideprotected

Set/Get methods to set the lower and upper threshold

Definition at line 130 of file otbClampImageFilter.hxx.

Member Data Documentation

m_Functor

template<class TInputImage , class TOutputImage = TInputImage>

FunctorType otb::ClampImageFilter< TInputImage, TOutputImage >::m_Functor

private

Set/Get methods to set the lower and upper threshold

Definition at line 118 of file otbClampImageFilter.h.

m_Lower

template<class TInputImage , class TOutputImage = TInputImage>

OutputPixelValueType otb::ClampImageFilter< TInputImage, TOutputImage >::m_Lower

private

Set/Get methods to set the lower and upper threshold

Definition at line 116 of file otbClampImageFilter.h.

m_Upper

template<class TInputImage , class TOutputImage = TInputImage>

OutputPixelValueType otb::ClampImageFilter< TInputImage, TOutputImage >::m_Upper

private

Set/Get methods to set the lower and upper threshold

Definition at line 117 of file otbClampImageFilter.h.

---

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

• otbClampImageFilter.h
• otbClampImageFilter.hxx