sample_waveform#

PostProcessorCircuit.sample_waveform(waveform_data, waveform_sweep, waveform_unit='V', waveform_sweep_unit='s', unit_interval=1e-09, clock_tics=None, pandas_enabled=False)[source]#

Sampling a waveform at clock times plus half unit interval.

Parameters:

waveform_datalist: Waveform data.
waveform_sweeplist: Waveform sweep data.
waveform_unitstr, optional: Waveform units. The default values is V.
waveform_sweep_unitstr, optional: Time units. The default value is s.
unit_intervalfloat, optional: Unit interval in seconds. The default is 1e-9.
clock_ticslist, optional: List with clock tics. The default is None, in which case the clock tics from the AMI receiver are used.
pandas_enabledbool, optional: Whether to enable the Pandas data format. The default is False.

Returns:

list or pandas.Series: Sampled waveform in Volts at different times in seconds.

Examples

>>> from ansys.aedt.core import Circuit
>>> circuit = Circuit()
>>> circuit.post.sample_ami_waveform(name,probe_name,source_name,circuit.available_variations.nominal)