OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | List of all members
otb::ThresholdVectorImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <otbThresholdVectorImageFilter.h>

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

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
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< SelfPointer
 
typedef ThresholdVectorImageFilter Self
 
typedef itk::ImageToImageFilter< TInputImage, TOutputImage > Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
virtual OutputImageInternalPixelType GetOutsideValue () const
 
virtual void SetOutsideValue (OutputImageInternalPixelType _arg)
 
void ThresholdAbove (const InputImageInternalPixelType &thresh)
 
void ThresholdBelow (const InputImageInternalPixelType &thresh)
 
void ThresholdOutside (const InputImageInternalPixelType &lower, const InputImageInternalPixelType &upper)
 

Static Public Member Functions

static Pointer New ()
 
OutputImageInternalPixelType m_OutsideValue
 
InputImageInternalPixelType m_Lower
 
InputImageInternalPixelType m_Upper
 
virtual void SetLower (InputImageInternalPixelType _arg)
 
virtual InputImageInternalPixelType GetLower () const
 
virtual void SetUpper (InputImageInternalPixelType _arg)
 
virtual InputImageInternalPixelType GetUpper () const
 
 ThresholdVectorImageFilter ()
 
 ~ThresholdVectorImageFilter () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType ThrethreadId) override
 
void GenerateOutputInformation (void) override
 
 ThresholdVectorImageFilter (const Self &)=delete
 
void operator= (const Self &)=delete
 

Detailed Description

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

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

ThresholdVectorImageFilter sets image values to a user-specified "outside" value (by default, "black") if the image values are below, above, or between simple threshold values.

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

Definition at line 44 of file otbThresholdVectorImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputImage , class TOutputImage = TInputImage>
typedef itk::SmartPointer<const Self> otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::ConstPointer

Definition at line 51 of file otbThresholdVectorImageFilter.h.

◆ InputImageInternalPixelType

template<class TInputImage , class TOutputImage = TInputImage>
typedef InputImageType::InternalPixelType otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::InputImageInternalPixelType

Definition at line 65 of file otbThresholdVectorImageFilter.h.

◆ InputImagePixelType

template<class TInputImage , class TOutputImage = TInputImage>
typedef InputImageType::PixelType otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::InputImagePixelType

Definition at line 64 of file otbThresholdVectorImageFilter.h.

◆ InputImagePointer

template<class TInputImage , class TOutputImage = TInputImage>
typedef InputImageType::ConstPointer otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::InputImagePointer

Definition at line 62 of file otbThresholdVectorImageFilter.h.

◆ InputImageRegionType

template<class TInputImage , class TOutputImage = TInputImage>
typedef InputImageType::RegionType otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::InputImageRegionType

Definition at line 63 of file otbThresholdVectorImageFilter.h.

◆ InputImageType

template<class TInputImage , class TOutputImage = TInputImage>
typedef TInputImage otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::InputImageType

Some additional typedefs.

Definition at line 57 of file otbThresholdVectorImageFilter.h.

◆ OutputImageInternalPixelType

template<class TInputImage , class TOutputImage = TInputImage>
typedef OutputImageType::InternalPixelType otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::OutputImageInternalPixelType

Definition at line 72 of file otbThresholdVectorImageFilter.h.

◆ OutputImagePixelType

template<class TInputImage , class TOutputImage = TInputImage>
typedef OutputImageType::PixelType otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::OutputImagePixelType

Definition at line 71 of file otbThresholdVectorImageFilter.h.

◆ OutputImagePointer

template<class TInputImage , class TOutputImage = TInputImage>
typedef OutputImageType::Pointer otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::OutputImagePointer

Definition at line 69 of file otbThresholdVectorImageFilter.h.

◆ OutputImageRegionType

template<class TInputImage , class TOutputImage = TInputImage>
typedef OutputImageType::RegionType otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Definition at line 70 of file otbThresholdVectorImageFilter.h.

◆ OutputImageType

template<class TInputImage , class TOutputImage = TInputImage>
typedef TOutputImage otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::OutputImageType

Some additional typedefs.

Definition at line 68 of file otbThresholdVectorImageFilter.h.

◆ Pointer

template<class TInputImage , class TOutputImage = TInputImage>
typedef itk::SmartPointer<Self> otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::Pointer

Definition at line 50 of file otbThresholdVectorImageFilter.h.

◆ Self

template<class TInputImage , class TOutputImage = TInputImage>
typedef ThresholdVectorImageFilter otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

Definition at line 48 of file otbThresholdVectorImageFilter.h.

◆ Superclass

template<class TInputImage , class TOutputImage = TInputImage>
typedef itk::ImageToImageFilter<TInputImage, TOutputImage> otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::Superclass

Definition at line 49 of file otbThresholdVectorImageFilter.h.

Constructor & Destructor Documentation

◆ ThresholdVectorImageFilter() [1/2]

template<class TInputImage , class TOutputImage >
otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::ThresholdVectorImageFilter
protected

Set/Get methods to set the lower threshold

Definition at line 38 of file otbThresholdVectorImageFilter.hxx.

◆ ~ThresholdVectorImageFilter()

template<class TInputImage , class TOutputImage = TInputImage>
otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::~ThresholdVectorImageFilter ( )
inlineoverrideprotected

Set/Get methods to set the lower threshold

Definition at line 103 of file otbThresholdVectorImageFilter.h.

◆ ThresholdVectorImageFilter() [2/2]

template<class TInputImage , class TOutputImage = TInputImage>
otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::ThresholdVectorImageFilter ( const Self )
privatedelete

Set/Get methods to set the lower threshold

Member Function Documentation

◆ CreateAnother()

template<class TInputImage , class TOutputImage = TInputImage>
virtual::itk::LightObject::Pointer otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::CreateAnother ( void  ) const

◆ GenerateOutputInformation()

template<class TInputImage , class TOutputImage = TInputImage>
void otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation ( void  )
inlineoverrideprotected

Set/Get methods to set the lower threshold

Definition at line 118 of file otbThresholdVectorImageFilter.h.

◆ GetLower()

template<class TInputImage , class TOutputImage = TInputImage>
virtual InputImageInternalPixelType otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::GetLower ( ) const
virtual

Set/Get methods to set the lower threshold

◆ GetNameOfClass()

template<class TInputImage , class TOutputImage = TInputImage>
virtual const char* otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

◆ GetOutsideValue()

template<class TInputImage , class TOutputImage = TInputImage>
virtual OutputImageInternalPixelType otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::GetOutsideValue ( ) const
virtual

Get the "outside" pixel value.

◆ GetUpper()

template<class TInputImage , class TOutputImage = TInputImage>
virtual InputImageInternalPixelType otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::GetUpper ( ) const
virtual

Set/Get methods to set the lower threshold

◆ New()

template<class TInputImage , class TOutputImage = TInputImage>
static Pointer otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::New ( )
static

Method for creation through the object factory.

◆ operator=()

template<class TInputImage , class TOutputImage = TInputImage>
void otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::operator= ( const Self )
privatedelete

Set/Get methods to set the lower threshold

◆ PrintSelf()

template<class TInputImage , class TOutputImage >
void otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

Set/Get methods to set the lower threshold

Definition at line 50 of file otbThresholdVectorImageFilter.hxx.

◆ SetLower()

template<class TInputImage , class TOutputImage = TInputImage>
virtual void otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::SetLower ( InputImageInternalPixelType  _arg)
virtual

Set/Get methods to set the lower threshold

◆ SetOutsideValue()

template<class TInputImage , class TOutputImage = TInputImage>
virtual void otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::SetOutsideValue ( OutputImageInternalPixelType  _arg)
virtual

Set the "outside" pixel value. The default value NumericTraits<PixelType>::Zero.

◆ SetUpper()

template<class TInputImage , class TOutputImage = TInputImage>
virtual void otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::SetUpper ( InputImageInternalPixelType  _arg)
virtual

Set/Get methods to set the upper threshold

◆ ThreadedGenerateData()

template<class TInputImage , class TOutputImage >
void otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData ( const OutputImageRegionType outputRegionForThread,
itk::ThreadIdType  ThrethreadId 
)
overrideprotected

ThresholdVectorImageFilter 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 116 of file otbThresholdVectorImageFilter.hxx.

◆ ThresholdAbove()

template<class TInputImage , class TOutputImage >
void otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::ThresholdAbove ( const InputImageInternalPixelType 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 OutsideValue

Definition at line 63 of file otbThresholdVectorImageFilter.hxx.

◆ ThresholdBelow()

template<class TInputImage , class TOutputImage >
void otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::ThresholdBelow ( const InputImageInternalPixelType 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 78 of file otbThresholdVectorImageFilter.hxx.

◆ ThresholdOutside()

template<class TInputImage , class TOutputImage >
void otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::ThresholdOutside ( const InputImageInternalPixelType lower,
const InputImageInternalPixelType upper 
)

The values outside the range are set to OutsideValue.

The values outside the range are set to OutsideValue

Definition at line 94 of file otbThresholdVectorImageFilter.hxx.

Member Data Documentation

◆ m_Lower

template<class TInputImage , class TOutputImage = TInputImage>
InputImageInternalPixelType otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::m_Lower
private

Set/Get methods to set the lower threshold

Definition at line 130 of file otbThresholdVectorImageFilter.h.

◆ m_OutsideValue

template<class TInputImage , class TOutputImage = TInputImage>
OutputImageInternalPixelType otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::m_OutsideValue
private

Set/Get methods to set the lower threshold

Definition at line 129 of file otbThresholdVectorImageFilter.h.

◆ m_Upper

template<class TInputImage , class TOutputImage = TInputImage>
InputImageInternalPixelType otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::m_Upper
private

Set/Get methods to set the lower threshold

Definition at line 131 of file otbThresholdVectorImageFilter.h.


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