TReK Python  5.3.2
Telemetry/Command API
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 
 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 copy (copy_from: object) -> None 
 Copies the contents of the provided 'copy_from' NamedItem into this NamedItem. 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 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()

Calibrator () -> def

Class initializer.

Reimplemented from NamedItem.

Reimplemented in PolynomialCalibrator, and SplineCalibrator.

Member Function Documentation

◆ calibrate()

calibrate (input_value : float