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

#include <otbClampVectorImageFilter.h>

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

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

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef InputImageType::InternalPixelType	InputImageInternalPixelType
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::ConstPointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TInputImage	InputImageType
typedef OutputImageType::InternalPixelType	OutputImageInternalPixelType
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef itk::SmartPointer< Self >	Pointer
typedef ClampVectorImageFilter	Self
typedef itk::ImageToImageFilter< TInputImage, TOutputImage >	Superclass

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

Static Public Member Functions
static Pointer	New ()
double	m_DLower
double	m_DUpper
OutputImageInternalPixelType	m_Lower
OutputImageInternalPixelType	m_Upper
void	SetLower (OutputImageInternalPixelType val)
virtual OutputImageInternalPixelType	GetLower () const
void	SetUpper (OutputImageInternalPixelType val)
virtual OutputImageInternalPixelType	GetUpper () const
	ClampVectorImageFilter ()
	~ClampVectorImageFilter () override
void	PrintSelf (std::ostream &os, itk::Indent indent) const override
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId) override
void	GenerateOutputInformation (void) override
	ClampVectorImageFilter (const Self &)=delete
void	operator= (const Self &)=delete

Detailed Description

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

Set image values to a user-specified value if they are below, above, or between simple threshold values.

ClampVectorImageFilter 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.

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

The pixels must support the operators >= and <=.

Definition at line 48 of file otbClampVectorImageFilter.h.

Member Typedef Documentation

ConstPointer

template<class TInputImage , class TOutputImage = TInputImage>

typedef itk::SmartPointer<const Self> otb::ClampVectorImageFilter< TInputImage, TOutputImage >::ConstPointer

Definition at line 55 of file otbClampVectorImageFilter.h.

InputImageInternalPixelType

template<class TInputImage , class TOutputImage = TInputImage>

typedef InputImageType::InternalPixelType otb::ClampVectorImageFilter< TInputImage, TOutputImage >::InputImageInternalPixelType

Definition at line 69 of file otbClampVectorImageFilter.h.

InputImagePixelType

template<class TInputImage , class TOutputImage = TInputImage>

typedef InputImageType::PixelType otb::ClampVectorImageFilter< TInputImage, TOutputImage >::InputImagePixelType

Definition at line 68 of file otbClampVectorImageFilter.h.

InputImagePointer

template<class TInputImage , class TOutputImage = TInputImage>

typedef InputImageType::ConstPointer otb::ClampVectorImageFilter< TInputImage, TOutputImage >::InputImagePointer

Definition at line 66 of file otbClampVectorImageFilter.h.

InputImageRegionType

template<class TInputImage , class TOutputImage = TInputImage>

typedef InputImageType::RegionType otb::ClampVectorImageFilter< TInputImage, TOutputImage >::InputImageRegionType

Definition at line 67 of file otbClampVectorImageFilter.h.

InputImageType

template<class TInputImage , class TOutputImage = TInputImage>

typedef TInputImage otb::ClampVectorImageFilter< TInputImage, TOutputImage >::InputImageType

Some additional typedefs.

Definition at line 61 of file otbClampVectorImageFilter.h.

OutputImageInternalPixelType

template<class TInputImage , class TOutputImage = TInputImage>

typedef OutputImageType::InternalPixelType otb::ClampVectorImageFilter< TInputImage, TOutputImage >::OutputImageInternalPixelType

Definition at line 76 of file otbClampVectorImageFilter.h.

OutputImagePixelType

template<class TInputImage , class TOutputImage = TInputImage>

typedef OutputImageType::PixelType otb::ClampVectorImageFilter< TInputImage, TOutputImage >::OutputImagePixelType

Definition at line 75 of file otbClampVectorImageFilter.h.

OutputImagePointer

template<class TInputImage , class TOutputImage = TInputImage>

typedef OutputImageType::Pointer otb::ClampVectorImageFilter< TInputImage, TOutputImage >::OutputImagePointer

Definition at line 73 of file otbClampVectorImageFilter.h.

OutputImageRegionType

template<class TInputImage , class TOutputImage = TInputImage>

typedef OutputImageType::RegionType otb::ClampVectorImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Definition at line 74 of file otbClampVectorImageFilter.h.

OutputImageType

template<class TInputImage , class TOutputImage = TInputImage>

typedef TOutputImage otb::ClampVectorImageFilter< TInputImage, TOutputImage >::OutputImageType

Some additional typedefs.

Definition at line 72 of file otbClampVectorImageFilter.h.

Pointer

template<class TInputImage , class TOutputImage = TInputImage>

typedef itk::SmartPointer<Self> otb::ClampVectorImageFilter< TInputImage, TOutputImage >::Pointer

Definition at line 54 of file otbClampVectorImageFilter.h.

Self

template<class TInputImage , class TOutputImage = TInputImage>

typedef ClampVectorImageFilter otb::ClampVectorImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

Definition at line 52 of file otbClampVectorImageFilter.h.

Superclass

template<class TInputImage , class TOutputImage = TInputImage>

typedef itk::ImageToImageFilter<TInputImage, TOutputImage> otb::ClampVectorImageFilter< TInputImage, TOutputImage >::Superclass

Definition at line 53 of file otbClampVectorImageFilter.h.

Constructor & Destructor Documentation

ClampVectorImageFilter() [1/2]

template<class TInputImage , class TOutputImage >

otb::ClampVectorImageFilter< TInputImage, TOutputImage >::ClampVectorImageFilter

protected

Set/Get methods to set the lower threshold

Definition at line 38 of file otbClampVectorImageFilter.hxx.

~ClampVectorImageFilter()

template<class TInputImage , class TOutputImage = TInputImage>

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

inlineoverrideprotected

Set/Get methods to set the lower threshold

Definition at line 111 of file otbClampVectorImageFilter.h.

ClampVectorImageFilter() [2/2]

template<class TInputImage , class TOutputImage = TInputImage>

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

privatedelete

Set/Get methods to set the lower threshold

Member Function Documentation

ClampAbove()

template<class TInputImage , class TOutputImage >

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

(

const OutputImageInternalPixelType &

thresh

)

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

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

Definition at line 63 of file otbClampVectorImageFilter.hxx.

ClampBelow()

template<class TInputImage , class TOutputImage >

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

(

const OutputImageInternalPixelType &

thresh

)

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

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

Definition at line 79 of file otbClampVectorImageFilter.hxx.

ClampOutside()

template<class TInputImage , class TOutputImage >

void otb::ClampVectorImageFilter< TInputImage, TOutputImage >::ClampOutside	(	const OutputImageInternalPixelType &	lower,
		const OutputImageInternalPixelType &	upper
	)

The values outside the range are set to OutsideValue.

The values outside the range are set to OutsideValue

Definition at line 96 of file otbClampVectorImageFilter.hxx.

CreateAnother()

template<class TInputImage , class TOutputImage = TInputImage>

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

(

void

)

const

GenerateOutputInformation()

template<class TInputImage , class TOutputImage = TInputImage>

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

inlineoverrideprotected

Set/Get methods to set the lower threshold

Definition at line 126 of file otbClampVectorImageFilter.h.

GetLower()

template<class TInputImage , class TOutputImage = TInputImage>

virtual OutputImageInternalPixelType otb::ClampVectorImageFilter< TInputImage, TOutputImage >::GetLower ( ) const

virtual

Set/Get methods to set the lower threshold

GetNameOfClass()

template<class TInputImage , class TOutputImage = TInputImage>

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

virtual

Run-time type information (and related methods).

GetUpper()

template<class TInputImage , class TOutputImage = TInputImage>

virtual OutputImageInternalPixelType otb::ClampVectorImageFilter< TInputImage, TOutputImage >::GetUpper ( ) const

virtual

Set/Get methods to set the lower threshold

New()

template<class TInputImage , class TOutputImage = TInputImage>

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

static

Method for creation through the object factory.

operator=()

template<class TInputImage , class TOutputImage = TInputImage>

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

privatedelete

Set/Get methods to set the lower threshold

PrintSelf()

template<class TInputImage , class TOutputImage >

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

overrideprotected

Set/Get methods to set the lower threshold

Definition at line 51 of file otbClampVectorImageFilter.hxx.

SetLower()

template<class TInputImage , class TOutputImage = TInputImage>

void otb::ClampVectorImageFilter< TInputImage, TOutputImage >::SetLower ( OutputImageInternalPixelType  val )

inline

Set/Get methods to set the lower threshold

Definition at line 89 of file otbClampVectorImageFilter.h.

SetUpper()

template<class TInputImage , class TOutputImage = TInputImage>

void otb::ClampVectorImageFilter< TInputImage, TOutputImage >::SetUpper ( OutputImageInternalPixelType  val )

inline

Set/Get methods to set the upper threshold

Definition at line 99 of file otbClampVectorImageFilter.h.

ThreadedGenerateData()

template<class TInputImage , class TOutputImage >

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

overrideprotected

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

Definition at line 120 of file otbClampVectorImageFilter.hxx.

Member Data Documentation

m_DLower

template<class TInputImage , class TOutputImage = TInputImage>

double otb::ClampVectorImageFilter< TInputImage, TOutputImage >::m_DLower

private

Set/Get methods to set the lower threshold

Definition at line 137 of file otbClampVectorImageFilter.h.

m_DUpper

template<class TInputImage , class TOutputImage = TInputImage>

double otb::ClampVectorImageFilter< TInputImage, TOutputImage >::m_DUpper

private

Set/Get methods to set the lower threshold

Definition at line 138 of file otbClampVectorImageFilter.h.

m_Lower

template<class TInputImage , class TOutputImage = TInputImage>

OutputImageInternalPixelType otb::ClampVectorImageFilter< TInputImage, TOutputImage >::m_Lower

private

Set/Get methods to set the lower threshold

Definition at line 140 of file otbClampVectorImageFilter.h.

m_Upper

template<class TInputImage , class TOutputImage = TInputImage>

OutputImageInternalPixelType otb::ClampVectorImageFilter< TInputImage, TOutputImage >::m_Upper

private

Set/Get methods to set the lower threshold

Definition at line 141 of file otbClampVectorImageFilter.h.

---

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

• otbClampVectorImageFilter.h
• otbClampVectorImageFilter.hxx