Signal¶
-
public class
Signal
extends PythonAdapter¶ Class mimicking the CDBSignal Python class. In a few aspects, it is more object-oriented and lazy-evaluated to simplify manipulation in MATLAB/IDL.
Author: pipek
Constructors¶
Signal¶
-
protected
Signal
(Signal parent, int nthChild, PythonAdapter signalTree, DictionaryAdapter unitFactorTree)¶ Constructor for dependent objects from signal tree with unit factor.
Parameters: - parent – Signal that uses this as an axis.
- nthChild – The order of this signal among axes in the parent signal.
- signalTree – Signal subtree.
- unitFactorTree – Unit factor subtree.
Signal¶
-
protected
Signal
(Signal parent, int nthChild, PythonAdapter signalTree, String units)¶ Constructor for dependent objects from signal tree without unit factor.
Parameters: - parent – Signal that uses this as an axis.
- nthChild – The order of this signal among axes in the parent signal.
- signalTree – Signal subtree.
- units – Most times, this will be “default”, but any other value can used.
Methods¶
getAxes¶
-
public SortedMap<String, Signal>
getAxes
()¶ A map of all existing axes.
Throws: - CDBException – Non-existent axes are omitted.
Returns: A dictionary of [ axis_name, Signal object ] values.
getAxis¶
getData¶
getGenericSignal¶
-
public GenericSignal
getGenericSignal
()¶
getGenericSignalReference¶
-
public GenericSignal
getGenericSignalReference
()¶
getParameters¶
-
public SignalParameters
getParameters
()¶
getPythonObject¶
-
public PyObject
getPythonObject
()¶ Return the Python object of CDBSignal class.
Returns: null if CDBSignal not found. Note: This method catches exceptions thus hiding problems.
getSignalCalibration¶
-
public SignalCalibration
getSignalCalibration
(boolean includeUnitFactor)¶ Signal calibration for default/DAV/RAW.
Throws:
getTimeAxis¶
getUnit¶
-
public String
getUnit
()¶ Unit name.
Throws: - CDBException – RAW/DAQ/default GS units or units from factor tree (if requested).
getUnitFactor¶
-
public double
getUnitFactor
()¶ Unit factor, by which the default signal has to be multiplied.
Throws: - CDBException – If DAV/RAW/default are selected, this factor is 1.0. If another unit/unit system is selected, this is a conversion from the default unit to the selected one. Internally, this reflects unit_factor_tree returned from Python.