Calibrator Class Reference

This class is the abstraction for all numeric calibration. More...

Inherits NamedItem.

Inherited by PolynomialCalibrator, and SplineCalibrator.

Public Member Functions
def	Calibrator ( -> def  -> def  -> def ) -> def
	Class initializer. More...
def	initialize ( -> None  -> def  -> def ) -> def
	Initializes the object. More...
def	calibrate (input_value: float -> float  -> def  -> def ) -> def
	Virtual method for derived classes to calibrate an input value. More...
def	clone ( -> Calibrator  -> def  -> def ) -> def
	Creates and returns an extact copy of the object. More...
Public Member Functions inherited from NamedItem
def	__eq__ (named_item: object -> bool  -> def  -> def ) -> def
	Equality operator "==". More...
def	copy (copy_from: object -> None  -> def  -> def ) -> def
	Copies the contents of the provided 'copy_from' NamedItem into this NamedItem. More...
def	get_alias ( -> str  -> def  -> def ) -> def
	Returns the alias of the item. More...
def	get_name ( -> str  -> def  -> def ) -> def
	Returns the name of the item. More...
def	get_long_description ( -> str  -> def  -> def ) -> def
	Returns the long description of the item. More...
def	get_short_description ( -> str  -> def  -> def ) -> def
	Returns the short description of the item. More...
def	get_user_description ( -> str  -> def  -> def ) -> def
	Returns the user description of the item. More...
def	get_owner ( -> str  -> def  -> def ) -> def
	Returns the owner of the item. More...
def	set_name (name: str -> None  -> def  -> def ) -> def
	Sets the name of the item. More...
def	set_alias (alias: str -> None  -> def  -> def ) -> def
	Sets the alias of the item. More...
def	set_short_description (description: str -> None  -> def  -> def ) -> def
	Sets the short description of the item. More...
def	set_long_description (description: str -> None  -> def  -> def ) -> def
	Sets the long description of the item. More...
def	set_user_description (description: str -> None  -> def  -> def ) -> def
	Sets the user description of the item. More...
def	set_owner (owner: str -> None  -> def  -> def ) -> def
	Sets the owner of the item. More...

Detailed Description

This class is the abstraction for all numeric calibration.

Calibration is supported for values that can be stored as a double precision floating point.

Constructor & Destructor Documentation

Calibrator()

(

)

-> def

Class initializer.

Reimplemented from NamedItem.

Reimplemented in PolynomialCalibrator, and SplineCalibrator.

Member Function Documentation

calibrate()

(

input_value

: float