Populations
A Population is a collection of gates.
Properties
Properties are getter methods and setter methods representing the underlying CellEngine object. Properties are the snake_case equivalent of those documented on the CellEngine API unless otherwise noted.
Methods
cellengine.resources.population.Population
experiment_id: str
property
gates: str
property
writable
id: str
property
Alias for _id.
name: str
property
writable
parent_id: Union[str, None]
property
writable
terminal_gate_gid: Union[str, None]
property
writable
unique_name: str
property
The unique name for this population (has ancestor names prepended and numerical suffixes appended until the name is unique).
This value is calculated by CellEngine; if the population is renamed,
this value will not be correct until pop.update() is called.
delete()
get(experiment_id, _id=None, name=None)
classmethod
Get Population by name or ID for a specific experiment. Either
name or _id must be specified.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
experiment_id |
str
|
ID of the experiment this attachment is connected with. |
required |
_id |
optional
|
ID of the attachment. |
None
|
name |
optional
|
Name of the experiment. |
None
|
update()
Save changes to this Population to CellEngine.