RVL::RVLScalarLogisticInverse< Scalar > Class Template Reference

This BFO implements the inverse of the scalar version of the logistic function $ f(x) = x (1 + s^2 x^2)^{-1/2} + m $, where $ s=2/(f_{\rm max} - f_{\rm min})$ and $ m=(f_{\rm max} + f_{\rm min})/2$. More...

#include <logistic.hh>

Inheritance diagram for RVL::RVLScalarLogisticInverse< Scalar >:

RVL::BinaryLocalFunctionObject< Scalar > RVL::FunctionObject RVL::BinaryLocalEvaluation< Scalar > RVL::Writeable RVL::LocalEvaluation< Scalar > List of all members.

Public Member Functions

 RVLScalarLogisticInverse (Scalar fmin=ScalarFieldTraits< Scalar >::Zero(), Scalar fmax=ScalarFieldTraits< Scalar >::One())
 ~RVLScalarLogisticInverse ()
void operator() (LocalDataContainer< Scalar > &x, LocalDataContainer< Scalar > const &y)
string getName () const

Detailed Description

template<class Scalar>
class RVL::RVLScalarLogisticInverse< Scalar >

This BFO implements the inverse of the scalar version of the logistic function $ f(x) = x (1 + s^2 x^2)^{-1/2} + m $, where $ s=2/(f_{\rm max} - f_{\rm min})$ and $ m=(f_{\rm max} + f_{\rm min})/2$.

The inverse is $ f^{-1}(y) = (y-m) (1 - s^2(y-m)^2))^{-1/2}$, well-defined when $f_{\rm min} < y < f_{\rm max}$.

Definition at line 121 of file logistic.hh.


Constructor & Destructor Documentation

template<class Scalar>
RVL::RVLScalarLogisticInverse< Scalar >::RVLScalarLogisticInverse ( Scalar  fmin = ScalarFieldTraits<Scalar>::Zero(),
Scalar  fmax = ScalarFieldTraits<Scalar>::One() 
)

Definition at line 127 of file logistic.hh.

template<class Scalar>
RVL::RVLScalarLogisticInverse< Scalar >::~RVLScalarLogisticInverse (  ) 

Definition at line 145 of file logistic.hh.


Member Function Documentation

template<class Scalar>
void RVL::RVLScalarLogisticInverse< Scalar >::operator() ( LocalDataContainer< Scalar > &  x,
LocalDataContainer< Scalar > const &  y 
) [virtual]

Implements RVL::BinaryLocalEvaluation< Scalar >.

Definition at line 153 of file logistic.hh.

References RVL::LocalDataContainer< DataType >::getData(), and RVL::LocalDataContainer< DataType >::getSize().

template<class Scalar>
string RVL::RVLScalarLogisticInverse< Scalar >::getName (  )  const [virtual]

Implements RVL::FunctionObject.

Definition at line 178 of file logistic.hh.


The documentation for this class was generated from the following file:
Generated on 5 Jan 2017 for LocalRVL by  doxygen 1.4.7