TReK Python  5.3.2
Telemetry/Command API
SplineCalibrator Class Reference

This class calibrates a value using a series of line segments. More...

Inherits Calibrator.

Public Member Functions

Initialize / Finalize

Functions handling class initialization and finalization.

def SplineCalibrator ( Optional[SplineCalibrator] spline_calibrator=None, Optional[c_void_p] native_ptr=None, is_clone: bool=False) -> def 
 Class initializer. More...
 
def clone () -> SplineCalibrator 
 Creates and returns an extact copy of the object. More...
 
def copy (copy_from: object) -> None 
 Copies the contents of the provided 'copy_from' SplineCalibrator. More...
 
def initialize () -> None 
 Initializes the object. More...
 
def load_file (filename: str) -> None 
 Loads the SplineCalibrator definition from the specified file. More...
 
def save_file (filename: str) -> None 
 Saves the SplineCalibrator 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 clear_all_points () -> None 
 Removes all points defining the line segments.
 
def get_number_of_points () -> int 
 Returns the number of points in the calibrator. More...
 
def get_points () -> List[SplineCalibratorPoint
 Gets all of the points for the calibrator. More...
 
def add_point (new_converted: float, new_calibrated: float) -> None 
 Adds a point to the calibrator. More...
 
def SplineCalibrator () -> 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 series of line segments.

The number of line segments allowed is unbouded.

Constructor & Destructor Documentation

◆ SplineCalibrator()

SplineCalibrator (spline_calibrator : Optional[SplineCalibrator]