Package pype :: Module pype

Module pype

pype: python physiology environment

This is the main module for pype. It gets imported by both data collection and data analysis programs/tasks. In general, any pype-related program or task should probably import this module as early on as possible.

Author -- James A. Mazer (mazerj@gmail.com)

Classes
	PypeApp Pype Application Class.
	FixWin Fixation Window Encapsulation
	Timer
	Holder Dummy class.
	EmbeddedFigure Create matplotlib figure embedded in tkinter parent window.
	SimplePlotWindow Toplevel plot window for use with matplotlib.
	EyeTribeThreadRunner

Functions

MYNAME(level=0)
Get name of calling function (or, if level=1: caller of caller, etc.

source code

addicon(app, button, file)

source code

getapp()
Get global handle to running PypeApp.

source code

subject()
Query subject id string.

source code

subjectrc(file="")
Query subject-specific config directory.

source code

pyperc(file="")
Query config directory.

source code

now(military=1)
Get current timestring.

source code

loadwarn(*args)
OBSOLETE

source code

show_about(file, timeout=None)
Display a about/splash screen. If transient is True, then return, but use callback to close it after 10 secs, otherwise user must close.

source code

Function Details

getapp()

source code

Get global handle to running PypeApp.

Returns:: PypeApp instance or None (if PypeApp hasn't been instantiated)

subject()

source code

Query subject id string.

This is usually supplied by starting pype with the -s argument.

Returns:: (string) subject id

subjectrc(file="")

source code

Query subject-specific config directory.

Each subject should have a private directory for config and state files etc. By default this is ~/.pyperc/subj_id. The default can be altered by setting the $PYPERC environment variable.

Returns:: (string) name of subject config directory

pyperc(file="")

source code

Query config directory.

By default this is ~/.pyperc, but can be overridden by setting the $PYPERC envronment var.

Returns:: (string) name of .pyperc config directory

now(military=1)

source code

Get current timestring.

Returns:: (strin) timestring in form HHMM or HHMM[am|pm] depending on whether 'military' is true or false.

loadwarn(*args)

source code

OBSOLETE

Pype now extends the import module to provide this functionality automatically as needed.