boxit_pg Namespace Reference

Classes
class	boxit_pg_
Functions
def	defaults
	def paramgui(self, useGlobals=True): """ Opens a parameter GUI for this task.
def	check_params
	This function sets the default values but also will return the list of parameters or the default value of a given parameter.
def	description
def	itsdefault
Variables
tuple	boxit_pg

---

Function Documentation

def boxit_pg.check_params	(		self,
			param = None,
			value = None
	)

This function sets the default values but also will return the list of parameters or the default value of a given parameter.

Definition at line 238 of file boxit_pg.py.

def boxit_pg.defaults	(		self,
			param = None
	)

def paramgui(self, useGlobals=True): """ Opens a parameter GUI for this task.

If useGlobals is true, then any relevant global parameter settings are used. """ import paramgui

a=inspect.stack() stacklevel=0 for k in range(len(a)): if (string.find(a[k][1], 'ipython console') > 0) or (string.find(a[k][1], '<string>') >= 0): stacklevel=k break myf = sys._getframe(stacklevel).f_globals

if useGlobals: paramgui.setGlobals(myf) else: paramgui.setGlobals({})

paramgui.runTask('boxit', myf['_ip']) paramgui.setGlobals({})

Definition at line 200 of file boxit_pg.py.

def boxit_pg.description	(		self,
			key = 'boxit',
			subkey = None
	)

Definition at line 274 of file boxit_pg.py.

def boxit_pg.itsdefault	(		self,
			paramname
	)

Definition at line 293 of file boxit_pg.py.

---

Variable Documentation

tuple boxit_pg.boxit_pg

Definition at line 308 of file boxit_pg.py.