Orfeo ToolBox  4.2
Orfeo ToolBox is not a black box
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::ThresholdVectorImageFilter< TInputImage, TOutputImage > Class Template Reference

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

#include <otbThresholdVectorImageFilter.h>

+ Inheritance diagram for otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for otb::ThresholdVectorImageFilter< 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< SelfPointer
 
typedef ThresholdVectorImageFilter Self
 
typedef
itk::ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual InputImageInternalPixelType GetLower () const
 
virtual const char * GetNameOfClass () const
 
virtual
OutputImageInternalPixelType 
GetOutsideValue () const
 
virtual InputImageInternalPixelType GetUpper () const
 
virtual void SetLower (InputImageInternalPixelType _arg)
 
virtual void SetOutsideValue (OutputImageInternalPixelType _arg)
 
virtual void SetUpper (InputImageInternalPixelType _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 ()
 
- Static Public Member Functions inherited from itk::ImageSource< TOutputImage >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter (void)
 

Protected Member Functions

 ThresholdVectorImageFilter ()
 
virtual ~ThresholdVectorImageFilter ()
 
void GenerateOutputInformation (void)
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType ThrethreadId)
 

Private Member Functions

 ThresholdVectorImageFilter (const Self &)
 
void operator= (const Self &)
 

Private Attributes

InputImageInternalPixelType m_Lower
 
OutputImageInternalPixelType m_OutsideValue
 
InputImageInternalPixelType m_Upper
 

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 41 of file otbThresholdVectorImageFilter.h.

Member Typedef Documentation

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

Definition at line 48 of file otbThresholdVectorImageFilter.h.

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

Definition at line 62 of file otbThresholdVectorImageFilter.h.

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

Definition at line 61 of file otbThresholdVectorImageFilter.h.

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

Definition at line 59 of file otbThresholdVectorImageFilter.h.

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

Definition at line 60 of file otbThresholdVectorImageFilter.h.

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

Some additional typedefs.

Definition at line 54 of file otbThresholdVectorImageFilter.h.

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

Definition at line 69 of file otbThresholdVectorImageFilter.h.

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

Definition at line 68 of file otbThresholdVectorImageFilter.h.

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

Definition at line 66 of file otbThresholdVectorImageFilter.h.

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

Definition at line 67 of file otbThresholdVectorImageFilter.h.

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

Some additional typedefs.

Definition at line 65 of file otbThresholdVectorImageFilter.h.

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

Definition at line 47 of file otbThresholdVectorImageFilter.h.

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

Standard class typedefs.

Definition at line 45 of file otbThresholdVectorImageFilter.h.

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

Definition at line 46 of file otbThresholdVectorImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage >
otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::ThresholdVectorImageFilter ( )
protected
template<class TInputImage , class TOutputImage = TInputImage>
virtual otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::~ThresholdVectorImageFilter ( )
inlineprotectedvirtual

Definition at line 98 of file otbThresholdVectorImageFilter.h.

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

Member Function Documentation

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

Definition at line 114 of file otbThresholdVectorImageFilter.h.

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

Run-time type information (and related methods).

Reimplemented from itk::ImageSource< TOutputImage >.

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

Get the "outside" pixel value.

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

Method for creation through the object factory.

template<class TInputImage , class TOutputImage = TInputImage>
void otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::operator= ( const Self )
private
template<class TInputImage , class TOutputImage >
void otb::ThresholdVectorImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protected

Definition at line 53 of file otbThresholdVectorImageFilter.txx.

References m_OutsideValue.

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

Set/Get methods to set the lower threshold

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.

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

Set/Get methods to set the upper threshold

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

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 131 of file otbThresholdVectorImageFilter.txx.

References itk::ProgressReporter::CompletedPixel(), and m_OutsideValue.

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 74 of file otbThresholdVectorImageFilter.txx.

References itk::NumericTraits< T >::NonpositiveMin().

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 91 of file otbThresholdVectorImageFilter.txx.

References itk::NumericTraits< T >::max().

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 108 of file otbThresholdVectorImageFilter.txx.

Member Data Documentation

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

Definition at line 126 of file otbThresholdVectorImageFilter.h.

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

Definition at line 125 of file otbThresholdVectorImageFilter.h.

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

Definition at line 127 of file otbThresholdVectorImageFilter.h.


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