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 |
| Class initializer. More... | |
| def | clone () -> PolynomialCalibrator |
| Creates and returns an extact copy of the object. More... | |
| def | copy (copy_from: object) -> None |
| Copies the contents of the provided 'copy_from' PolynomialCalibrator. More... | |
| def | initialize () -> None |
| Initializes the object. More... | |
| def | load_file (filename: str) -> None |
| Loads the PolynomialCalibrator definition from the specified file. More... | |
| def | save_file (filename: str) -> None |
| Saves the PolynomialCalibrator definition to the specified file. More... | |
Calibration | |
Functions for handling calibration. | |
| def | calibrate (input_value: float) -> float |
| Performs the calibration on the input value. More... | |
| def | get_coefficient (power: int) -> float |
| Gets the coefficient value for the specified term. More... | |
| def | get_order () -> int |
| Returns the current order of the calibrator. More... | |
| def | set_coefficient (power: int, input_value: float) -> None |
| Sets the coefficient value for the specified term. More... | |
| def | set_order (input_value: int, keep_coefficients: bool=False) -> None |
| Sets the order for the polynomial calibrator. More... | |
| def | PolynomialCalibrator () -> def |
| Class initializer. More... | |
| def | initialize () -> None |
| Initializes the object. More... | |
| def | calibrate (input_value: float) -> float |
| Virtual method for derived classes to calibrate an input value. More... | |
| def | clone () -> Calibrator |
| Creates and returns an extact copy of the object. More... | |
 Public Member Functions inherited from NamedItem | |
| def | __eq__ (named_item: object) -> bool |
| Equality operator "==". More... | |
| def | get_alias () -> str |
| Returns the alias of the item. More... | |
| def | get_name () -> str |
| Returns the name of the item. More... | |
| def | get_long_description () -> str |
| Returns the long description of the item. More... | |
| def | get_short_description () -> str |
| Returns the short description of the item. More... | |
| def | get_user_description () -> str |
| Returns the user description of the item. More... | |
| def | get_owner () -> str |
| Returns the owner of the item. More... | |
| def | set_name (name: str) -> None |
| Sets the name of the item. More... | |
| def | set_alias (alias: str) -> None |
| Sets the alias of the item. More... | |
| def | set_short_description (description: str) -> None |
| Sets the short description of the item. More... | |
| def | set_long_description (description: str) -> None |
| Sets the long description of the item. More... | |
| def | set_user_description (description: str) -> None |
| Sets the user description of the item. More... | |
| def | set_owner (owner: str) -> None |
| Sets the owner 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()
| PolynomialCalibrator | ( | poly_calibrator | : Optional[PolynomialCalibrator] |