spacepy.pybats.ram.EfieldFile¶

class spacepy.pybats.ram.EfieldFile(filename, *args, **kwargs)[source]¶

Base class for reading electric field input and output ASCII files. Subclasses such as WeqFile are customized to handle specific formats.

The default object is configured to handle

__init__(filename, *args, **kwargs)[source]¶

Base class for “Data Model” representation data

Abstract method, reimplement

Attributes:

Methods

`add_potplot`([target, loc, zlim, n, figsize, ...])	Quickly add a potential plot to MPL object target.
`read`()	Load and parse the information in the file.

Attributes

add_potplot(target=None, loc=111, zlim=50, n=31, figsize=(5, 4), add_cbar=True, labcolor='lightgray', title='Noon')[source]¶

Quickly add a potential plot to MPL object target.

Parameters:

targetobject: The object on which plotting will happen.
figsizetuple: A two-item tuple/list giving the dimensions of the figure, in inches. Defaults to (5,4)
locinteger: The subplot triple that specifies the location of the axes object. Defaults to 111.
zlimreal: The upper limit for the color bar range. Defaults to 50.
nint: The number of contours. Defaults to 31.
labcolorcolor: A matplotlib-compatable color indicator for the ticks and labels.
titlestring: A string title to set at the top of the plot. Defaults to “Noon”.