MCPcopy Index your code
hub / github.com/SLiCAP/SLiCAP_python / plot

Function plot

SLiCAP/SLiCAPplots.py:1257–1370  ·  view source on GitHub ↗

Plots x-y data, or multiple pairs of x-y data. :param fileName: Name of the file for saving it to disk. :type fileName: str :param title: Title of the figure. :type title: str :param axisType: Type of axis: 'lin', 'log', 'semilogx', 'semilogy' or 'polar'. :type axisTy

(fileName, title, axisType, plotData, xName = '', xScale = '', 
         xUnits = '', yName = '', yScale = '', yUnits = '', xLim = [] , 
         yLim = [], show = False, save = True)

Source from the content-addressed store, hash-verified

1255 return fig
1256
1257def plot(fileName, title, axisType, plotData, xName = '', xScale = '',
1258 xUnits = '', yName = '', yScale = '', yUnits = '', xLim = [] ,
1259 yLim = [], show = False, save = True):
1260 """
1261 Plots x-y data, or multiple pairs of x-y data.
1262
1263 :param fileName: Name of the file for saving it to disk.
1264 :type fileName: str
1265
1266 :param title: Title of the figure.
1267 :type title: str
1268
1269 :param axisType: Type of axis: 'lin', 'log', 'semilogx', 'semilogy' or 'polar'.
1270 :type axisType: str
1271
1272 :param plotData: dictionary with key-value pairs or dictionary with traces
1273
1274 - key: *str* label for the trace
1275 - value:
1276
1277 #. *list* [<xData>, <yData>]
1278
1279 - xData: *list*: x values
1280 - yData: *list*: y values
1281
1282 #. *SLiCAPplots.trace* object
1283
1284 :type plotData: dict, SLiCAPplots.trace
1285
1286 :param xName: Name of the variable to be plotted along the x axis. Defaults to ''.
1287 :type xName: str
1288
1289 :param xScale: Scale factor of the x axis variable. Defaults to ''.
1290 :type xScale: str
1291
1292 :param xUnits: Units of the x axis variable. Defaults to ''.
1293 :type xUnits: str
1294
1295 :param xLim: Limits for the x-axis scale: [<xmin>, <xmax>]
1296 :type xLim: list
1297
1298 :param yName: Name of the variable to be plotted along the y axis. Defaults to ''.
1299 :type funcType: str, sympy.Symbol
1300
1301 :param yScale: Scale factor of the y axis variable. Defaults to ''.
1302 :type yScale: str
1303
1304 :param yUnits: Units of the y axis variable. Defaults to ''.
1305 :type yUnits: str
1306
1307 :param yLim: Limits for the y-axis scale: [<ymin>, <ymax>]
1308 :type yLim: list
1309
1310 :param show: If 'True' the plot will be shown in the workspace.
1311 :type show: bool
1312
1313 :param save: If 'True' the plot will be saved to the img folder in both pdf and svg format. Defaults to True.
1314 :type show: bool

Callers

nothing calls this directly

Calls 5

figureClass · 0.85
axisClass · 0.85
traceClass · 0.85
formatMethod · 0.80
plotMethod · 0.80

Tested by

no test coverage detected