pySTDLM.CellArranger.CellArranger Class Reference

A base class for laying out cells in a 3D space. More...

Inheritance diagram for pySTDLM.CellArranger.CellArranger:

Public Member Functions
def	__init__
	Create a CellArranger. More...
def	cellFactory
def	packVolume
	Pack a specified volume with cells. More...
def	addToSimulation
	Add packed volume to RDME simulation. More...

Public Attributes
	allowedCellTypes
	allowedForms
	cellType
	cellAttributes
	cells
	packerName
	arrangerAttributes

Detailed Description

A base class for laying out cells in a 3D space.

Constructor & Destructor Documentation

def pySTDLM.CellArranger.CellArranger.__init__	(		self,
			cellType = None,
			cellAttributes = None,
			arrangerAttributes = None,
			name = 'Unknown'
	)

Create a CellArranger.

Parameters

self
cellType	The type of cell this packer represents, can be one of: ["Sphere", "Capsule", "Box", "CapsuleShell"]
cellAttributes	A dictionary with the required attributes specified for the cell and the form
arrangerAttributes	A dictionary with the required/optional requirements for the individiual arranger

Member Function Documentation

def pySTDLM.CellArranger.CellArranger.addToSimulation	(		self,
			sim
	)

Add packed volume to RDME simulation.

Parameters

self
sim	An RDMESimulation object

def pySTDLM.CellArranger.CellArranger.cellFactory

(

self

)

def pySTDLM.CellArranger.CellArranger.packVolume	(		self,
			sim,
			volume = None
	)

Pack a specified volume with cells.

Parameters

self
volume	A volume specified as [[xmin,ymin,zmin],[xmax,ymax,zmax]] (TODO: Add angles)
form	The form of the packing, which can one of: ["Random", "RandomSpherical", "TightGrid", "LooseGrid", "SkewedGrid"]

Returns

A tuple of the form [volumePacked, volumePercent, numberCells]

Member Data Documentation

pySTDLM.CellArranger.CellArranger.allowedCellTypes

pySTDLM.CellArranger.CellArranger.allowedForms

pySTDLM.CellArranger.CellArranger.arrangerAttributes

pySTDLM.CellArranger.CellArranger.cellAttributes

pySTDLM.CellArranger.CellArranger.cells

pySTDLM.CellArranger.CellArranger.cellType

pySTDLM.CellArranger.CellArranger.packerName

---

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

• CellArranger.py