pyLM  v1.1
A Python Problem Solving Environment for the simulation of stochastic biological systems
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | Public Attributes | List of all members
pySTDLM.Cells.CellShape Class Reference

Base class for a particular cell type for use in CellArranger (and later more) More...

Inheritance diagram for pySTDLM.Cells.CellShape:
pySTDLM.Cells.BoxCell pySTDLM.Cells.CapsuleCell pySTDLM.Cells.SphereCell pySTDLM.Cells.CapsuleShellCell

Public Member Functions

def __init__
 
def getVolume
 Volume occupied by cell NOTE: When overriding this class, you must specify a "computeVolume()" function of no arguments. More...
 
def boundingBox
 Return a bounding box for the cell TODO: Make it return an orientation as well. More...
 
def addToSimulation
 Add the cell to the simulation. More...
 
def translateCell
 Shift a cell in space by the specified amount. More...
 
def createModelCell
 Create model cell. More...
 
def setRegions
 Set regions. More...
 

Public Attributes

 name
 
 volume
 
 mins
 
 maxs
 
 membraneThickness
 
 memtype
 
 cyttype
 

Detailed Description

Base class for a particular cell type for use in CellArranger (and later more)

Constructor & Destructor Documentation

def pySTDLM.Cells.CellShape.__init__ (   self)

Member Function Documentation

def pySTDLM.Cells.CellShape.addToSimulation (   self,
  sim 
)

Add the cell to the simulation.

Parameters
self
simAn RDMESimulation object
def pySTDLM.Cells.CellShape.boundingBox (   self)

Return a bounding box for the cell TODO: Make it return an orientation as well.

def pySTDLM.Cells.CellShape.createModelCell (   self,
  attr 
)

Create model cell.

Parameters
self
attrsA dictionary of attributes
def pySTDLM.Cells.CellShape.getVolume (   self)

Volume occupied by cell NOTE: When overriding this class, you must specify a "computeVolume()" function of no arguments.

Returns
volume In intrinsic units
def pySTDLM.Cells.CellShape.setRegions (   self,
  membrane,
  cytoplasm 
)

Set regions.

Parameters
self
membraneThe name of the region in which the membrane should be considered
cytoplasmThe name of the region in which the cytoplasm should be considered
def pySTDLM.Cells.CellShape.translateCell (   self,
  point 
)

Shift a cell in space by the specified amount.

Parameters
self
point[x,y,z] translation in space

Member Data Documentation

pySTDLM.Cells.CellShape.cyttype
pySTDLM.Cells.CellShape.maxs
pySTDLM.Cells.CellShape.membraneThickness
pySTDLM.Cells.CellShape.memtype
pySTDLM.Cells.CellShape.mins
pySTDLM.Cells.CellShape.name
pySTDLM.Cells.CellShape.volume

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