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

This class performs the detection of outlier with the Box and Whisker technique. More...

#include <otbBoxAndWhiskerImageFilter.h>

+ Inheritance diagram for otb::BoxAndWhiskerImageFilter< TInputImage >:
+ Collaboration diagram for otb::BoxAndWhiskerImageFilter< TInputImage >:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
Superclass::InputImageConstPointer 
InputImageConstPointer
 
typedef
Superclass::InputImagePixelType 
InputImagePixelType
 
typedef
Superclass::InputImagePointer 
InputImagePointer
 
typedef
Superclass::InputImageRegionType 
InputImageRegionType
 
typedef Superclass::InputImageType InputImageType
 
typedef
Superclass::OutputImagePixelType 
OutputImagePixelType
 
typedef
Superclass::OutputImagePointer 
OutputImagePointer
 
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
 
typedef Superclass::OutputImageType OutputImageType
 
typedef InputImageType::PixelType PixelType
 
typedef itk::SmartPointer< SelfPointer
 
typedef InputImageType::RegionType RegionType
 
typedef BoxAndWhiskerImageFilter Self
 
typedef InputImageType::SizeType SizeType
 
typedef
itk::InPlaceImageFilter
< TInputImage > 
Superclass
 
typedef
InputImageType::InternalPixelType 
ValueType
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual double GetBeta () const
 
virtual const char * GetNameOfClass () const
 
virtual unsigned int GetNumberFound () const
 
virtual const SizeTypeGetRadius ()
 
virtual void SetBeta (double _arg)
 
virtual void SetRadius (SizeType _arg)
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageSource< TOutputImage >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter (void)
 

Static Public Attributes

static const unsigned int InputImageDimension = InputImageType::ImageDimension
 
static const unsigned int OutputImageDimension = OutputImageType::ImageDimension
 

Protected Member Functions

 BoxAndWhiskerImageFilter ()
 
virtual ~BoxAndWhiskerImageFilter ()
 
virtual void AllocateOutputs ()
 
virtual void GenerateOutputInformation ()
 
PixelType PerformBoxAndWhiskerDetection (const PixelType &pixel)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId)
 

Private Member Functions

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

Private Attributes

double m_Beta
 
long int m_NumberFound
 
SizeType m_Radius
 

Detailed Description

template<class TInputImage>
class otb::BoxAndWhiskerImageFilter< TInputImage >

This class performs the detection of outlier with the Box and Whisker technique.

This is appropriated to perform simple outlier detection over vector data. The input image has to contain vector pixel through a VectorImage type. When an outlier is detected, it is treated to as an missing value through the function

otb::EuclideanDistanceMetricWithMissingValue::SetToMissingValue()

.

A component is considered to as a missing value when \( \| x_i - \beta \left( x_{3/4} - x_{1/4} \right) \| > \| x_{1/2} \| \) where \( x_{1/4}, x_{1/2}, x_{3/4} \) stand for the first, second (median) and third quantile values.

See Also
EuclideanDistanceMetricWithMissingValue

Definition at line 46 of file otbBoxAndWhiskerImageFilter.h.

Member Typedef Documentation

template<class TInputImage>
typedef itk::SmartPointer<const Self> otb::BoxAndWhiskerImageFilter< TInputImage >::ConstPointer

Definition at line 54 of file otbBoxAndWhiskerImageFilter.h.

template<class TInputImage>
typedef Superclass::InputImageConstPointer otb::BoxAndWhiskerImageFilter< TInputImage >::InputImageConstPointer

Definition at line 70 of file otbBoxAndWhiskerImageFilter.h.

template<class TInputImage>
typedef Superclass::InputImagePixelType otb::BoxAndWhiskerImageFilter< TInputImage >::InputImagePixelType

Definition at line 72 of file otbBoxAndWhiskerImageFilter.h.

template<class TInputImage>
typedef Superclass::InputImagePointer otb::BoxAndWhiskerImageFilter< TInputImage >::InputImagePointer

Definition at line 69 of file otbBoxAndWhiskerImageFilter.h.

template<class TInputImage>
typedef Superclass::InputImageRegionType otb::BoxAndWhiskerImageFilter< TInputImage >::InputImageRegionType

Definition at line 71 of file otbBoxAndWhiskerImageFilter.h.

template<class TInputImage>
typedef Superclass::InputImageType otb::BoxAndWhiskerImageFilter< TInputImage >::InputImageType

Definition at line 68 of file otbBoxAndWhiskerImageFilter.h.

template<class TInputImage>
typedef Superclass::OutputImagePixelType otb::BoxAndWhiskerImageFilter< TInputImage >::OutputImagePixelType

Definition at line 66 of file otbBoxAndWhiskerImageFilter.h.

template<class TInputImage>
typedef Superclass::OutputImagePointer otb::BoxAndWhiskerImageFilter< TInputImage >::OutputImagePointer

Definition at line 64 of file otbBoxAndWhiskerImageFilter.h.

template<class TInputImage>
typedef Superclass::OutputImageRegionType otb::BoxAndWhiskerImageFilter< TInputImage >::OutputImageRegionType

Definition at line 65 of file otbBoxAndWhiskerImageFilter.h.

template<class TInputImage>
typedef Superclass::OutputImageType otb::BoxAndWhiskerImageFilter< TInputImage >::OutputImageType

Template parameters typedefs

Definition at line 60 of file otbBoxAndWhiskerImageFilter.h.

template<class TInputImage>
typedef InputImageType::PixelType otb::BoxAndWhiskerImageFilter< TInputImage >::PixelType

Definition at line 74 of file otbBoxAndWhiskerImageFilter.h.

template<class TInputImage>
typedef itk::SmartPointer<Self> otb::BoxAndWhiskerImageFilter< TInputImage >::Pointer

Definition at line 53 of file otbBoxAndWhiskerImageFilter.h.

template<class TInputImage>
typedef InputImageType::RegionType otb::BoxAndWhiskerImageFilter< TInputImage >::RegionType

Definition at line 77 of file otbBoxAndWhiskerImageFilter.h.

template<class TInputImage>
typedef BoxAndWhiskerImageFilter otb::BoxAndWhiskerImageFilter< TInputImage >::Self

Standard class typedefs.

Definition at line 51 of file otbBoxAndWhiskerImageFilter.h.

template<class TInputImage>
typedef InputImageType::SizeType otb::BoxAndWhiskerImageFilter< TInputImage >::SizeType

Definition at line 76 of file otbBoxAndWhiskerImageFilter.h.

template<class TInputImage>
typedef itk::InPlaceImageFilter<TInputImage> otb::BoxAndWhiskerImageFilter< TInputImage >::Superclass

Definition at line 52 of file otbBoxAndWhiskerImageFilter.h.

template<class TInputImage>
typedef InputImageType::InternalPixelType otb::BoxAndWhiskerImageFilter< TInputImage >::ValueType

Definition at line 75 of file otbBoxAndWhiskerImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage >
otb::BoxAndWhiskerImageFilter< TInputImage >::BoxAndWhiskerImageFilter ( )
protected

Definition at line 39 of file otbBoxAndWhiskerImageFilter.txx.

template<class TInputImage>
virtual otb::BoxAndWhiskerImageFilter< TInputImage >::~BoxAndWhiskerImageFilter ( )
inlineprotectedvirtual

Definition at line 94 of file otbBoxAndWhiskerImageFilter.h.

template<class TInputImage>
otb::BoxAndWhiskerImageFilter< TInputImage >::BoxAndWhiskerImageFilter ( const Self )
private

Member Function Documentation

template<class TInputImage >
void otb::BoxAndWhiskerImageFilter< TInputImage >::AllocateOutputs ( )
protectedvirtual

Definition at line 154 of file otbBoxAndWhiskerImageFilter.txx.

template<class TInputImage>
virtual::itk::LightObject::Pointer otb::BoxAndWhiskerImageFilter< TInputImage >::CreateAnother ( void  ) const
template<class TInputImage >
void otb::BoxAndWhiskerImageFilter< TInputImage >::GenerateOutputInformation ( void  )
protectedvirtual

Definition at line 141 of file otbBoxAndWhiskerImageFilter.txx.

template<class TInputImage>
virtual double otb::BoxAndWhiskerImageFilter< TInputImage >::GetBeta ( ) const
virtual

Fix the whisker

template<class TInputImage>
virtual const char* otb::BoxAndWhiskerImageFilter< TInputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::InPlaceImageFilter< TInputImage >.

template<class TInputImage>
virtual unsigned int otb::BoxAndWhiskerImageFilter< TInputImage >::GetNumberFound ( ) const
virtual
template<class TInputImage>
virtual const SizeType& otb::BoxAndWhiskerImageFilter< TInputImage >::GetRadius ( )
virtual
template<class TInputImage>
static Pointer otb::BoxAndWhiskerImageFilter< TInputImage >::New ( )
static

Method for creation through the object factory.

template<class TInputImage>
void otb::BoxAndWhiskerImageFilter< TInputImage >::operator= ( const Self )
private
template<class TInputImage >
BoxAndWhiskerImageFilter< TInputImage >::PixelType otb::BoxAndWhiskerImageFilter< TInputImage >::PerformBoxAndWhiskerDetection ( const PixelType pixel)
protected

Perform the outlier detection

Definition at line 105 of file otbBoxAndWhiskerImageFilter.txx.

template<class TInputImage>
virtual void otb::BoxAndWhiskerImageFilter< TInputImage >::SetBeta ( double  _arg)
virtual
template<class TInputImage>
virtual void otb::BoxAndWhiskerImageFilter< TInputImage >::SetRadius ( SizeType  _arg)
virtual

Get the Radius (all to 1)

template<class TInputImage >
void otb::BoxAndWhiskerImageFilter< TInputImage >::ThreadedGenerateData ( const OutputImageRegionType outputRegionForThread,
itk::ThreadIdType  threadId 
)
protectedvirtual

Main computation method implemented as a multithreaded filter

Process each of the boundary faces. These are N-d regions which border the edge of the buffer.

Definition at line 52 of file otbBoxAndWhiskerImageFilter.txx.

References itk::ImageConstIterator< TImage >::Get(), itk::ImageRegionConstIterator< TImage >::GoToBegin(), itk::ImageConstIterator< TImage >::IsAtEnd(), and itk::ImageRegionIterator< TImage >::Set().

Member Data Documentation

template<class TInputImage>
const unsigned int otb::BoxAndWhiskerImageFilter< TInputImage >::InputImageDimension = InputImageType::ImageDimension
static

Dimension

Definition at line 80 of file otbBoxAndWhiskerImageFilter.h.

template<class TInputImage>
double otb::BoxAndWhiskerImageFilter< TInputImage >::m_Beta
private

Definition at line 109 of file otbBoxAndWhiskerImageFilter.h.

template<class TInputImage>
long int otb::BoxAndWhiskerImageFilter< TInputImage >::m_NumberFound
private

Definition at line 110 of file otbBoxAndWhiskerImageFilter.h.

template<class TInputImage>
SizeType otb::BoxAndWhiskerImageFilter< TInputImage >::m_Radius
private

Definition at line 108 of file otbBoxAndWhiskerImageFilter.h.

template<class TInputImage>
const unsigned int otb::BoxAndWhiskerImageFilter< TInputImage >::OutputImageDimension = OutputImageType::ImageDimension
static

Definition at line 81 of file otbBoxAndWhiskerImageFilter.h.


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