landlab.components.species_evolution.zone#

Zone functions and class of SpeciesEvolver.

class Connection[source]#

Bases: IntEnum

Zone connection type.

Connection type represents the connectivity of zones in two time steps. It is described with the pattern, x-to-y where x and y are the descriptive counts (none, one, or many) of zone(s) at the earlier and later time step, respectively. For example, a connection type of one-to-many is a zone in the earlier time step that spatially overlaps multiple zones in the later time step.

MANY_TO_MANY = 6#
MANY_TO_ONE = 5#
NONE_TO_NONE = 0#
NONE_TO_ONE = 1#
ONE_TO_MANY = 4#
ONE_TO_NONE = 2#
ONE_TO_ONE = 3#
classmethod __contains__(value)#

Return True if value is in cls.

value is in cls if: 1) value is a member of cls, or 2) value is the value of one of the cls’s members.

__dir__()#

Returns public methods and other interesting attributes.

classmethod __getitem__(name)#

Return the member matching name.

classmethod __iter__()#

Return members in definition order.

classmethod __len__()#

Return the number of members (no aliases)

__new__(value)#
class Zone[source]#

Bases: object

Zone object of SpeciesEvolver.

The nodes and attributes of the spatial entities that taxa populate. This class is not intended to be managed directly.

Initialize a zone.

Parameters:

  • controller (ZoneController) – A SpeciesEvolver ZoneController.

  • mask (ndarray) – The mask of the zone. True elements of this array correspond to the grid nodes of the zone.

__init__(controller, mask)[source]#

Initialize a zone.

Parameters:

  • controller (ZoneController) – A SpeciesEvolver ZoneController.

  • mask (ndarray) – The mask of the zone. True elements of this array correspond to the grid nodes of the zone.

__new__(**kwargs)#
property area#

Zone area calculated as the sum of cell area at grid nodes.

property mask#

The mask of the zone.

property successors#

A list of zones connected to zone at the current time step.