streamplot.StreamMask Class Reference

Inheritance diagram for streamplot.StreamMask:

Public Member Functions
def	__init__ (self, density)
def	__getitem__ (self, args)

Public Attributes
	nx
	ny
	shape

Private Member Functions
def	_start_trajectory (self, xm, ym)
def	_undo_trajectory (self)
def	_update_trajectory (self, xm, ym)

Private Attributes
	_mask
	_current_xy
	_traj

Detailed Description

Mask to keep track of discrete regions crossed by streamlines.

The resolution of this grid determines the approximate spacing between
trajectories. Streamlines are only allowed to pass through zeroed cells:
When a streamline enters a cell, that cell is set to 1, and no new
streamlines are allowed to enter.

Definition at line 340 of file streamplot.py.

Constructor & Destructor Documentation

__init__()

def streamplot.StreamMask.__init__	(		self,
			density
	)

Definition at line 349 of file streamplot.py.

Member Function Documentation

__getitem__()

def streamplot.StreamMask.__getitem__	(		self,
			args
	)

Definition at line 364 of file streamplot.py.

_start_trajectory()

def streamplot.StreamMask._start_trajectory (   self,   xm,   ym  )

private

Start recording streamline trajectory

Definition at line 367 of file streamplot.py.

_undo_trajectory()

def streamplot.StreamMask._undo_trajectory (   self )

private

Remove current trajectory from mask

Definition at line 372 of file streamplot.py.

_update_trajectory()

def streamplot.StreamMask._update_trajectory (   self,   xm,   ym  )

private

Update current trajectory position in mask.

If the new position has already been filled, raise `InvalidIndexError`.

Definition at line 377 of file streamplot.py.

Member Data Documentation

_current_xy

streamplot.StreamMask._current_xy

private

Definition at line 362 of file streamplot.py.

_mask

streamplot.StreamMask._mask

private

Definition at line 359 of file streamplot.py.

_traj

streamplot.StreamMask._traj

private

Definition at line 369 of file streamplot.py.

nx

streamplot.StreamMask.nx

Definition at line 353 of file streamplot.py.

ny

streamplot.StreamMask.ny

Definition at line 353 of file streamplot.py.

shape

streamplot.StreamMask.shape

Definition at line 360 of file streamplot.py.

---

The documentation for this class was generated from the following file:

• /home/webadmin/src/fosite/src/tools/plot/streamplot.py