spacepy.pybats.ram.LogFile

class spacepy.pybats.ram.LogFile(file, *args, **kwargs)

__init__(file, *args, **kwargs)

Base class for “Data Model” representation data

Abstract method, reimplement

Attributes:

attrsdict

dictionary of the attributes of the SpaceData object

Methods

add_dst_quicklook([target, loc, showObs, ...])	Create a quick-look plot of Dst.
read()	Load the ascii logfile located at self.filename.

Attributes

attrs

add_dst_quicklook(target=None, loc=111, showObs=True, showBiot=True)

Create a quick-look plot of Dst. If kyotodst module is installed, compare to observed Dst.

Two values are returned: the matplotlib Figure and Axes objects used to generate the plot (in that order.)

Parameters:

targetFigure or Axes

If None (default), a new figure is generated from scratch. If a matplotlib Figure object, a new axis is created to fill that figure. If a matplotlib Axes object, the plot is placed into that axis.

locint

Use to specify the subplot placement of the axis (e.g. loc=212, etc.) Used if target is a Figure or None. Default 111 (single plot).

showObsbool

Show observed Dst? Defaults to True

showBiotbool

Show Biot-Savart Dst? Defaults to True

Returns:

figmatplotlib figure object

axmatplotlib axes object

read()

Load the ascii logfile located at self.filename. This method is automatically called upon instantiation.

attrs: collections.abc.Mapping