social_force#

Module Contents#

class SocialForceModel[source]#

Parameters for Social Force Model

All attributes are initialized with reasonably good defaults.

See the scientific publication for more details about this model https://doi.org/10.1038/35035023

bodyForce[source]#

describes the strength with which an agent is influenced by pushing forces from obstacles and neighbors in its direct proximity. [in kg s^-2] (is called k)

friction[source]#

describes the strength with which an agent is influenced by frictional forces from obstacles and neighbors in its direct proximity. [in kg m^-1 s^-1] (is called \(\kappa\))

bodyForce: float = 120000[source]#
friction: float = 240000[source]#
class SocialForceModelAgentParameters[source]#

Parameters required to create an Agent in the Social Force Model.

See the scientific publication for more details about this model https://doi.org/10.1038/35035023

position[source]#

Position of the agent.

orientation[source]#

Orientation of the agent.

journey_id[source]#

Id of the journey the agent follows.

stage_id[source]#

Id of the stage the agent targets.

velocity[source]#

current velocity of the agent.

mass[source]#

mass of the agent. [in kg] (is called m)

desiredSpeed[source]#

desired Speed of the agent. [in m/s] (is called v0)

reactionTime[source]#

reaction Time of the agent. [in s] (is called \(\tau\))

agentScale[source]#

indicates how strong an agent is influenced by pushing forces from neighbors. [in N] (is called A)

obstacleScale[source]#

indicates how strong an agent is influenced by pushing forces from obstacles. [in N] (is called A)

forceDistance[source]#

indicates how much the distance between an agent and obstacles or neighbors influences social forces. [in m] (is called B)

radius[source]#

radius of the space an agent occupies. [in m] (is called r)

position: tuple[float, float] = (0.0, 0.0)[source]#
orientation: tuple[float, float] = (0.0, 0.0)[source]#
journey_id: int[source]#
stage_id: int[source]#
velocity: tuple[float, float] = (0.0, 0.0)[source]#
mass: float = 80.0[source]#
desiredSpeed: float = 0.8[source]#
reactionTime: float = 0.5[source]#
agentScale: float = 2000[source]#
obstacleScale: float = 2000[source]#
forceDistance: float = 0.08[source]#
radius: float = 0.3[source]#
class SocialForceModelState(backing)[source]#
property velocity: float[source]#

velocity of this agent.

Return type:

float

property mass: float[source]#

mass of this agent.

Return type:

float

property desiredSpeed: float[source]#

desired Speed of this agent.

Return type:

float

property reactionTime: float[source]#

reaction Time of this agent.

Return type:

float

property agentScale: float[source]#

agent Scale of this agent.

Return type:

float

property obstacleScale: float[source]#

obstacle Scale of this agent.

Return type:

float

property forceDistance: float[source]#

force Distance of this agent.

Return type:

float

property radius: float[source]#

radius of this agent.

Return type:

float