Logo
Telescience Resource Kit
TReK Python  5.4.0 ART
Calibrator Class Reference

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

Inherits NamedItem.

Inherited by MathCalibrator, PolynomialCalibrator, and SplineCalibrator.

Public Member Functions

def Calibrator ( -> 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 copy (copy_from: object -> None ) -> def 
 Copies the contents of the provided 'copy_from' NamedItem into this NamedItem. 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 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 MathCalibrator, PolynomialCalibrator, and SplineCalibrator.

Member Function Documentation

◆ calibrate()

(input_value : float ) -> float

Virtual method for derived classes to calibrate an input value.

Parameters
[in]input_valueValue to calibrate.
Returns
Calibrated value.

Reimplemented in MathCalibrator, PolynomialCalibrator, and SplineCalibrator.

◆ clone()

() -> Calibrator

Creates and returns an extact copy of the object.

Defines the CalibratorSwitchSet class.

Reimplemented in MathCalibrator, PolynomialCalibrator, and SplineCalibrator.

◆ initialize()

() -> None

Initializes the object.

Reimplemented from NamedItem.

Reimplemented in MathCalibrator, PolynomialCalibrator, and SplineCalibrator.