IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
ipsdk::geom::Sphere3dCostFunction Class Reference

Cost function for sphere 3d parameters non linear optimization. More...

#include <Sphere3dCostFunction.h>

Inheritance diagram for ipsdk::geom::Sphere3dCostFunction:
ipsdk::math::BaseCostFunction

Public Types

enum  eEstimParams { eEP_CenterX, eEP_CenterY, eEP_CenterZ, eEP_Radius }
 
enum  eDataType { eDT_X, eDT_Y, eDT_Z }
 

Public Member Functions

void init (const math::DataSet &dataSet)
 object initialization More...
 
Constructors and destructor
 Sphere3dCostFunction ()
 
 ~Sphere3dCostFunction ()
 
- Public Member Functions inherited from ipsdk::math::BaseCostFunction
bool isInit () const
 check for object initialization
 
ipUInt32 getNbParameters () const
 retrieve number of parameters associated to cost function More...
 
ipUInt32 getNbEquations () const
 retrieve number of equations associated to cost function More...
 
BoolResult computeEquations (const Vector &parameters, Vector &equations) const
 computation of function equations More...
 
BoolResult computeJacobian (const Vector &parameters, Matrix &jacobian) const
 computation of function jacobian More...
 
void clear ()
 clear of object data
 
 BaseCostFunction ()
 
virtual ~BaseCostFunction ()=0
 

Static Public Attributes

static const ipUInt32 g_parameterSize = eEstimParams::size
 size of estimated parameters
 
static const ipUInt32 g_dataSize = eDataType::size
 size of data into data set
 

Protected Member Functions

BoolResult processEquations (const math::Vector &parameters, math::Vector &equations) const
 computation of function equation in derived class
 
BoolResult processJacobian (const math::Vector &parameters, math::Matrix &jacobian) const
 computation of function jacobian in derived class More...
 
void clearDerived ()
 clear of object data in derived class
 
- Protected Member Functions inherited from ipsdk::math::BaseCostFunction
void initBase (const ipUInt32 nbParameters, const ipUInt32 nbEquations)
 base class initialization More...
 

Protected Attributes

math::DataSet _dataSet
 data set associated to object
 
- Protected Attributes inherited from ipsdk::math::BaseCostFunction
ipUInt32 _nbParameters
 number of parameters associated to cost function
 
ipUInt32 _nbEquations
 number of equations associated to cost function
 
bool _bInit
 object flag initialization
 

Detailed Description

Cost function for sphere 3d parameters non linear optimization.

Author
E. Noirfalise
Date
2017/05/23

Member Enumeration Documentation

◆ eEstimParams

description of estimated parameters

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eEP_CenterX 

x coordinate of sphere center

eEP_CenterY 

y coordinate of sphere center

eEP_CenterZ 

z coordinate of sphere center

eEP_Radius 

radius of sphere

◆ eDataType

description of data into data set

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eDT_X 

x coordinate of contour point

eDT_Y 

y coordinate of contour point

eDT_Z 

z coordinate of contour point

Member Function Documentation

◆ init()

void ipsdk::geom::Sphere3dCostFunction::init ( const math::DataSet dataSet)

object initialization

Exceptions
ipsdk::geom::IPSDKGeometryExceptionif math::checkDataSize(dataSet, g_dataSize) == false

◆ processJacobian()

BoolResult ipsdk::geom::Sphere3dCostFunction::processJacobian ( const math::Vector parameters,
math::Matrix jacobian 
) const
protectedvirtual

computation of function jacobian in derived class

Note
base class implementation process finite difference

Reimplemented from ipsdk::math::BaseCostFunction.


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