Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
vpdt_gaussian_mthresh_detector< gaussian_type > Class Template Reference

A simple Mahalanobis distance detector for a Gaussian. More...

#include <vpdt_gaussian_detector.h>

Public Types

typedef bool return_type
 the functor return type. More...
 
typedef gaussian_type distribution_type
 the distribution operated on by the detector. More...
 
typedef gaussian_type::field_type F
 the data type to represent a point in the field. More...
 
typedef vpdt_field_traits< F >::scalar_type T
 define the scalar type (normally specified by template parameter T). More...
 

Public Member Functions

 vpdt_gaussian_mthresh_detector (const T &thresh=T(2.5))
 Constructor. More...
 
bool operator() (const gaussian_type &g, const F &sample, bool &result) const
 The main function. More...
 

Public Attributes

T sqr_threshold
 the threshold on Mahalanobis distance. More...
 

Static Public Attributes

static const unsigned int return_dim = 1
 the functor return type. More...
 

Detailed Description

template<class gaussian_type>
class vpdt_gaussian_mthresh_detector< gaussian_type >

A simple Mahalanobis distance detector for a Gaussian.

Detects samples that lie within some Mahalanobis distance

Definition at line 20 of file vpdt_gaussian_detector.h.

Member Typedef Documentation

◆ distribution_type

template<class gaussian_type >
typedef gaussian_type vpdt_gaussian_mthresh_detector< gaussian_type >::distribution_type

the distribution operated on by the detector.

Definition at line 28 of file vpdt_gaussian_detector.h.

◆ F

template<class gaussian_type >
typedef gaussian_type::field_type vpdt_gaussian_mthresh_detector< gaussian_type >::F

the data type to represent a point in the field.

Definition at line 31 of file vpdt_gaussian_detector.h.

◆ return_type

template<class gaussian_type >
typedef bool vpdt_gaussian_mthresh_detector< gaussian_type >::return_type

the functor return type.

Definition at line 24 of file vpdt_gaussian_detector.h.

◆ T

template<class gaussian_type >
typedef vpdt_field_traits<F>::scalar_type vpdt_gaussian_mthresh_detector< gaussian_type >::T

define the scalar type (normally specified by template parameter T).

Definition at line 33 of file vpdt_gaussian_detector.h.

Constructor & Destructor Documentation

◆ vpdt_gaussian_mthresh_detector()

template<class gaussian_type >
vpdt_gaussian_mthresh_detector< gaussian_type >::vpdt_gaussian_mthresh_detector ( const T thresh = T(2.5))
inline

Constructor.

Definition at line 36 of file vpdt_gaussian_detector.h.

Member Function Documentation

◆ operator()()

template<class gaussian_type >
bool vpdt_gaussian_mthresh_detector< gaussian_type >::operator() ( const gaussian_type &  g,
const F sample,
bool &  result 
) const
inline

The main function.

Return values
trueif the Mahalanobis distance is less than the threshold

Definition at line 41 of file vpdt_gaussian_detector.h.

Member Data Documentation

◆ return_dim

template<class gaussian_type >
const unsigned int vpdt_gaussian_mthresh_detector< gaussian_type >::return_dim = 1
static

the functor return type.

Definition at line 26 of file vpdt_gaussian_detector.h.

◆ sqr_threshold

template<class gaussian_type >
T vpdt_gaussian_mthresh_detector< gaussian_type >::sqr_threshold

the threshold on Mahalanobis distance.

Definition at line 48 of file vpdt_gaussian_detector.h.


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