Construct an instance of me to intialize a yampex.plot.Plotter object for a new Matplotlib Figure window. Then call my various methods on that instance to plot results.

Constructor arguments are the total number of subplots, or the number of columns and then rows of subplots.

Each call accepts at least one argument, a 2-sequence containing the initial charging interval and the Ngspice results Vectors_Ngspice object.

Additional optional arguments are (2) the minimum TIME value to include in the subplot (default is to include the earliest) and (3) the maximum TIME value to include (default is to include the latest).

You can specify a particular subplot with its integer index by setting the keyword k to that index in the call.

Call my done method with no arguments when done setting up all subplots.

Parameters	dims	The desired dimensions of the figure as a string with "x" separating width from height.
	xy	Set `True` if these are xy plots and not having time as the x-axis variable. In that case, supply a third or fourth argument to any call will raise an exception.
	timeWarp	Set to a non-unity value if there was a thermal timeWarp in the simulation.
	fiti	The initial time allocated for fast initial temperature increase, for irregular but simulation-friendly initial warm-up. The default is `None` for no such irregular warm-up. Note: timeWarp, if any, still applies.
	fs	The switching frequency (Hz).
	dc0	The starting (or only) duty cycle (fractional, 0-1).
	dc1	The ending duty cycle (fractional, 0-1), when ramped from dc0.

Method	__init__	Undocumented
Method	__getattr__	If the name matches, returns a wrapper function that calls the named one of my underscored subplotting methods with an initial time interval ti and a possibly trimmed V.
Method	setResult	Undocumented
Method	done	Call this with no args when done plotting and I can draw my `Figure` with all subplots.
Method	power	Given a `Vectors` object V and a string in_or_out that is either 'in' or 'out', returns the input or output power.
Method	timeWarpInfo	Adds info to the next subplot about the thermal timeWarp that was used, and possibly also the fiti. (Both are attributes set up from constructor keywords.)
Method	tempInfo	For the temperature with the supplied name, adds to the next subplot info about its average Tmean and maximum Tmax in degrees C, and its slope Tslope in deg/seg.
Method	voltageInfo	Adds info about the time-averaged input and output voltages, my switching frequency fs and, if specified, my start and ending duty cycles dc0, dc1.
Method	_voltages	Plots the input and output voltages.
Method	_voltages_internal	Plots the MOSFET terminal voltages, plus the output.
Method	_currents	Plots the input and output current (Amps).
Method	_currents_internal	Plots the current (Amps) in the most important internal current paths.
Method	_temps	Plots the MOSFET junction and case temperatures.
Method	_power	Plots the power in vs out, and also power dissipated in the inrush limiters if they are present.
Method	_efficiency	Plots the converter efficiency vs duty cycle.

def __init__(self, *args, **kw):

Undocumented

def __getattr__(self, name):

If the name matches, returns a wrapper function that calls the named one of my underscored subplotting methods with an initial time interval ti and a possibly trimmed V.

The wrapper function (which is what you actually call) takes a single argument ti_V, a 2-sequence containing ti and the untrimmed V. It accepts keywords tMin and tMax for time trimming and k for specifying which subplot to use if not the default progression.

If my xy attribute is set True for xy plots, there is no time trimming of V and specifying tMin or tMax raises an exception.

def setResult(self, ti_V):

Undocumented

def done(self):

Call this with no args when done plotting and I can draw my Figure with all subplots.

def power(self, V, in_or_out):

Given a Vectors object V and a string in_or_out that is either 'in' or 'out', returns the input or output power.

def timeWarpInfo(self):

Adds info to the next subplot about the thermal timeWarp that was used, and possibly also the fiti. (Both are attributes set up from constructor keywords.)

def tempInfo(self, name, Tmean, Tmax, Tslope):

For the temperature with the supplied name, adds to the next subplot info about its average Tmean and maximum Tmax in degrees C, and its slope Tslope in deg/seg.

Relies on the value of my timeWarp attribute, set via that constructor keyword.

def voltageInfo(self, V):

Adds info about the time-averaged input and output voltages, my switching frequency fs and, if specified, my start and ending duty cycles dc0, dc1.

def _voltages(self, ti, V, sp, k=None):

Plots the input and output voltages.

def _voltages_internal(self, ti, V, sp, k=None):

Plots the MOSFET terminal voltages, plus the output.

def _currents(self, ti, V, sp, k=None):

Plots the input and output current (Amps).

def _currents_internal(self, ti, V, sp, k=None):

Plots the current (Amps) in the most important internal current paths.

def _temps(self, ti, V, sp, k=None):

Plots the MOSFET junction and case temperatures.

def _power(self, ti, V, sp, k=None):

Plots the power in vs out, and also power dissipated in the inrush limiters if they are present.

def _efficiency(self, ti, V, sp, k=None):

Plots the converter efficiency vs duty cycle.

API Documentation for pingspice, generated by pydoctor at 2021-09-18 08:41:11.

pingspice.examples.boost.ResultsPlotter(object) class documentation

`pingspice.examples.boost.ResultsPlotter(object)` class documentation