BeSpiceWaveParserLimitedEdition
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Variables
004_example_wp_py_obj_numpy_and_matplotlib.py File Reference

This file contains an example for the use of the BeSpice Wave python module access functions. More...

Variables

tuple 004_example_wp_py_obj_numpy_and_matplotlib.af_wp_module = af_waveform_path.import_module()
 
tuple 004_example_wp_py_obj_numpy_and_matplotlib.af_wp_obj = af_waveform_path.get_parser_object()
 This functionallows to retrieve the main parser object. More...
 
string 004_example_wp_py_obj_numpy_and_matplotlib.script_path = ""
 Call help(af_waveform_path.get_module_name()) to read the builtin help. More...
 
string 004_example_wp_py_obj_numpy_and_matplotlib.file_name = "../example/fourbitadder.spi3"
 Define the path to the example waveform file. More...
 
tuple 004_example_wp_py_obj_numpy_and_matplotlib.return_code = af_wp_obj.readFile(file_name)
 Read the waveform file. More...
 
string 004_example_wp_py_obj_numpy_and_matplotlib.search_expression = "prop_variable_name == \"v(x1.x1.x2.x7.*)\""
 This functionallows to check if the returned result is a retun code. More...
 
tuple 004_example_wp_py_obj_numpy_and_matplotlib.find_curves = af_wp_obj.findCurves(search_expression)
 The search is performed on the parser object. More...
 
tuple 004_example_wp_py_obj_numpy_and_matplotlib.curve_name = af_wp_curve_obj.getName()
 
tuple 004_example_wp_py_obj_numpy_and_matplotlib.narray = af_wp_curve_obj.getCurveXYValueVectorAsNumpyArray()
 

Detailed Description

This file contains an example for the use of the BeSpice Wave python module access functions.

The used functions allow to parse spice simulation results and to retrieve the contained data.

The comments in the example code give more explanations on the performed API function calls.

If a waveform file is passed as 1st argument, the specified file will be read instead of the included example.