PolynomialCalibrator Class Reference

This class calibrates a value using a polynomial equation. More...

Inherits Calibrator.

Public Member Functions
Initialize / Finalize
Functions handling class initialization and destruction.
def	PolynomialCalibrator ( Optional[PolynomialCalibrator] poly_calibrator=None, Optional[c_void_p] native_ptr=None, is_clone: bool=False -> def ) -> def
	Class initializer. More...
def	clone ( -> PolynomialCalibrator ) -> def
	Creates and returns an extact copy of the object. More...
def	copy (copy_from: object -> None ) -> def
	Copies the contents of the provided 'copy_from' PolynomialCalibrator. More...
def	initialize ( -> None ) -> def
	Initializes the object. More...
def	load_file (filename: str -> None ) -> def
	Loads the PolynomialCalibrator definition from the specified file. More...
def	save_file (filename: str -> None ) -> def
	Saves the PolynomialCalibrator definition to the specified file. More...
Calibration
Functions for handling calibration.
def	calibrate (input_value: float -> float ) -> def
	Performs the calibration on the input value. More...
def	get_coefficient (power: int -> float ) -> def
	Gets the coefficient value for the specified term. More...
def	get_order ( -> int ) -> def
	Returns the current order of the calibrator. More...
def	set_coefficient (power: int, input_value: float -> None ) -> def
	Sets the coefficient value for the specified term. More...
def	set_order (input_value: int, keep_coefficients: bool=False -> None ) -> def
	Sets the order for the polynomial calibrator. More...
def	PolynomialCalibrator ( -> def ) -> def
	Class initializer. More...
def	initialize ( -> None ) -> def
	Initializes the object. More...
def	calibrate (input_value: float -> float ) -> def
	Virtual method for derived classes to calibrate an input value. More...
def	clone ( -> Calibrator ) -> def
	Creates and returns an extact copy of the object. More...
Public Member Functions inherited from NamedItem
def	remove_all_attributes ( -> None ) -> def
	Removes all attributes.
def	remove_attribute (name: str -> None ) -> def
	Removes the attribute by name. More...
def	__eq__ (named_item: object -> bool ) -> def
	Equality operator "==". More...
def	add_attribute (name: str, value: str -> None ) -> def
	Adds an attribute to the item. More...
def	get_alias ( -> str ) -> def
	Returns the alias of the item. More...
def	get_attribute (name: str -> str ) -> def
	Get the value of the specified attribute. More...
def	get_attribute_list ( -> list[str] ) -> def
	Gets a list of the attribute names. More...
def	get_name ( -> str ) -> def
	Returns the name of the item. More...
def	get_long_description ( -> str ) -> def
	Returns the long description of the item. More...
def	get_short_description ( -> str ) -> def
	Returns the short description of the item. More...
def	get_user_description ( -> str ) -> def
	Returns the user description of the item. More...
def	get_owner ( -> str ) -> def
	Returns the owner of the item. More...
def	get_path ( -> str ) -> def
	Returns the path for the item. More...
def	set_name (name: str -> None ) -> def
	Sets the name of the item. More...
def	set_alias (alias: str -> None ) -> def
	Sets the alias of the item. More...
def	set_short_description (description: str -> None ) -> def
	Sets the short description of the item. More...
def	set_long_description (description: str -> None ) -> def
	Sets the long description of the item. More...
def	set_user_description (description: str -> None ) -> def
	Sets the user description of the item. More...
def	set_owner (owner: str -> None ) -> def
	Sets the owner of the item. More...
def	set_path (path: str -> None ) -> def
	Sets the path of the item. More...

Detailed Description

This class calibrates a value using a polynomial equation.

The order of the equation is not limited by this class, but restrictions may be placed by projects.

Constructor & Destructor Documentation

PolynomialCalibrator()

(	poly_calibrator	: Optional[PolynomialCalibrator]
		native_ptr	: Optional[c_void_p]
		is_clone	: bool
		)	-> def

Class initializer.

Parameters

[in]	poly_calibrator	(Optional) PolynomialCalibrator to copy.
[in]	native_ptr	(Optional) Internal parameter, do not provide.
[in]	is_clone	(Optional) Internal parameter, do not provide.

Reimplemented from Calibrator.

Member Function Documentation

calibrate()

(

input_value

: float

)

-> float

Performs the calibration on the input value.

Parameters

[in]

input_value

Value to calibrate.

Returns

Calibrated value.

Reimplemented from Calibrator.

clone()

(

)

-> PolynomialCalibrator

Creates and returns an extact copy of the object.

Reimplemented from Calibrator.

copy()

(

copy_from

: object

)

-> None

Copies the contents of the provided 'copy_from' PolynomialCalibrator.

Parameters

[in]

copy_from

PolynomialCalibrator to copy from.

Exceptions

TypeError

if 'copy_from' is not a PolynomialCalibrator.

Reimplemented from NamedItem.

get_coefficient()

(

power

: int

)

-> float

Gets the coefficient value for the specified term.

Parameters

[in]

power

The power of the term.

Returns

The value for the coefficient.

Exceptions

TrekError

15016 - TREK_DATA_INVALID_VALUE

get_order()

(

)

-> int

Returns the current order of the calibrator.

Returns

The current order of the calibrator.

initialize()

(

)

-> None

Initializes the object.

Reimplemented from Calibrator.

load_file()

(

filename

: str

)

-> None

Loads the PolynomialCalibrator definition from the specified file.

Reads an XML PolynomialCalibrator.

Parameters

[in]

filename

The file from which to load the polynomial calibrator object.

save_file()

(

filename

: str

)

-> None

Saves the PolynomialCalibrator definition to the specified file.

Writes an XML PolynomialCalibrator.

Parameters

[in]

filename

The file to save the polynomial calibrator object.

set_coefficient()

(	power	: int
		input_value	: float
		)	-> None

Sets the coefficient value for the specified term.

Parameters

[in]	power	The power of the term.
[in]	input_value	The new value for the coefficient.

Exceptions

TrekError

15016 - TREK_DATA_INVALID_VALUE

set_order()

(	input_value	: int
		keep_coefficients	: bool
		)	-> None

Sets the order for the polynomial calibrator.

If the order is higher than the previous value, memory is destroyed and then recreated.

Parameters

[in]	input_value	The new order (> 0).
[in]	keep_coefficients	If false, coefficients are set to 0.

Exceptions

TrekError

15016 - TREK_DATA_INVALID_VALUE