|
BeSpiceWaveParserLimitedEdition
|
|
BeSpiceWaveParserLimitedEdition
|
This class defines curve objects. More...
Public Member Functions | |
| def | __init__ |
| A unique section identifier and curve index need to be passed to the constructor to build a valid curve object. More... | |
| def | findProperty |
| This function looks for the the curves's property defined by it's name. More... | |
| def | getCurveXYValueVector |
| This function returns 2 real data vectors holding x-axis and y-axis data for a specified curve. More... | |
| def | getCurveXYValueVectorAsNumpyArray |
| This function returns a numpy array holding x-axis and y-axis data for a specified curve. More... | |
| def | getName |
| This function returns the curve name. More... | |
| def | getDataTypeAsString |
| This function returns the curve's data type as string. More... | |
| def | getProperties |
| This function retrieves all curve properties and returns them in a dictionary. More... | |
| def | isValid |
| This function returns 1 if the curve object is valid. More... | |
| def | release |
| This function frees all data structures allocated for a particular curve. More... | |
Static Public Attributes | |
| int | sectionId = 0 |
| This member defines the unique section identifier. More... | |
| int | curveIndex = 0 |
| This member defines the curve index. More... | |
This class defines curve objects.
Curve objects are defined by their section identifier and their curve index, which are integer values. Each curve object represents a single curve contained in a data section. The first curve in a data section might be a sweep variable that holds only x-axis data. Sweep variables are identified by the property "prop_variable_sweep_variable".
| def af_py_waveform_parser_limited_edition.curve.__init__ | ( | self, | |
| section_id, | |||
| curve_index | |||
| ) |
A unique section identifier and curve index need to be passed to the constructor to build a valid curve object.
Otherwise the sectionId and curveIndex members are set to 0, which means that the curve object isn't valid.
| def af_py_waveform_parser_limited_edition.curve.findProperty | ( | ) |
This function looks for the the curves's property defined by it's name.
It returns the property's value.
| def af_py_waveform_parser_limited_edition.curve.getCurveXYValueVector | ( | first_index, | |
| last_index | |||
| ) |
This function returns 2 real data vectors holding x-axis and y-axis data for a specified curve.
The range of values can optionally be specified by first_index and last_index.
| def af_py_waveform_parser_limited_edition.curve.getCurveXYValueVectorAsNumpyArray | ( | first_index, | |
| last_index | |||
| ) |
This function returns a numpy array holding x-axis and y-axis data for a specified curve.
The range of values can optionally be specified by first_index and last_index.
| def af_py_waveform_parser_limited_edition.curve.getDataTypeAsString | ( | ) |
This function returns the curve's data type as string.
| def af_py_waveform_parser_limited_edition.curve.getName | ( | ) |
This function returns the curve name.
| def af_py_waveform_parser_limited_edition.curve.getProperties | ( | ) |
This function retrieves all curve properties and returns them in a dictionary.
| def af_py_waveform_parser_limited_edition.curve.isValid | ( | ) |
This function returns 1 if the curve object is valid.
| def af_py_waveform_parser_limited_edition.curve.release | ( | ) |
This function frees all data structures allocated for a particular curve.
|
static |
This member defines the curve index.
It is an ineger value.
|
static |
This member defines the unique section identifier.
It is an integer value.
1.8.6
