spacepy.pybats.ram.BoundaryGroup

class spacepy.pybats.ram.BoundaryGroup(path='.', rotate=True, *args, **kwargs)

A class that collects many PlasmaBoundary objects together to work as a coherent group.

__init__(path='.', rotate=True, *args, **kwargs)

Base class for “Data Model” representation data

Abstract method, reimplement

Attributes:

attrsdict

dictionary of the attributes of the SpaceData object

Methods

add_ltut(var[, target, loc, cmap, zlim, ...])

Plot variable var as a contour against local time (y-axis) and universal time (x-axis) using the PyBats target method of other standard plotting methods.

Attributes

attrs

add_ltut(var, target=None, loc=111, cmap='inferno', zlim=None, add_cbar=True, clabel=None, xlabel='full', title=None, grid=True, ntick=5)

Plot variable var as a contour against local time (y-axis) and universal time (x-axis) using the PyBats target method of other standard plotting methods. Four items are returned: the Matplotlib Figure, Axes, Mesh, and ColorBar objects used (if add_cbar is set to False, the returned ColorBar object is simply set to False.)

Kwarg	Description
target	Select plot destination. Defaults to new figure/axis.
loc	The location of any generated subplots. Default is 111.
add_cbar	Toggles the automatic colorbar. Default is**True**.
cmap	Selects Matplotlib color table. Defaults to inferno.
zlim	Limits for z-axis. Defaults to best-guess.
clabel	Sets colorbar label. Defaults to var units.
xlabel	Sets x-axis limits, use ‘full’, ‘ticks’, or None.
title	Sets axis title; defaults to None.
grid	Show white dotted grid? Defaults to True
ntick	Number of attempted cbar ticks. Defaults to 5.

attrs: collections.abc.Mapping