"""Constants used in the project."""
# Copyright 2025 Institute of Light and Matter, CNRS UMR 5306, University Claude Bernard Lyon 1
# Contributors: Oscar DUFOUR, Maxime STAPELLE, Alexandre NICOLAS
# This software is a computer program designed to generate a realistic crowd from anthropometric data and
# simulate the mechanical interactions that occur within it and with obstacles.
# This software is governed by the CeCILL-B license under French law and abiding by the rules of distribution
# of free software. You can use, modify and/ or redistribute the software under the terms of the CeCILL-B
# license as circulated by CEA, CNRS and INRIA at the following URL "http://www.cecill.info".
# As a counterpart to the access to the source code and rights to copy, modify and redistribute granted by
# the license, users are provided only with a limited warranty and the software's author, the holder of the
# economic rights, and the successive licensors have only limited liability.
# In this respect, the user's attention is drawn to the risks associated with loading, using, modifying
# and/or developing or reproducing the software by the user in light of its specific status of free software,
# that may mean that it is complicated to manipulate, and that also therefore means that it is reserved
# for developers and experienced professionals having in-depth computer knowledge. Users are therefore
# encouraged to load and test the software's suitability as regards their requirements in conditions enabling
# the security of their systems and/or data to be ensured and, more generally, to use and operate it in the
# same conditions as regards security.
# The fact that you are presently reading this means that you have had knowledge of the CeCILL-B license and that
# you accept its terms.
from enum import Enum, auto
from types import MappingProxyType
import numpy as np
# Fix the seed
np.random.seed(0)
# Conversion factors
#: Conversion factor from pixels to centimeters used to map the cadaver torso image with superimposed disks to the modeled 2D shape.
PIXEL_TO_CM_PEDESTRIAN: float = 30.0 / (2.0 * 405.97552)
#: Conversion factor from pixels to centimeters used to map the bike image with superimposed rectangles to the modeled 2D shape.
PIXEL_TO_CM_BIKE: float = 142.0 / 204.0
#: Conversion factor from millimeters to centimeters.
MM_TO_CM: float = 0.1
#: Conversion factor from inches to centimeters.
INCH_TO_CM: float = 2.54
#: Conversion factor from pounds to kilograms.
LB_TO_KG: float = 0.453592
#: Conversion factor from centimeters to meters.
CM_TO_M: float = 0.01
#: Conversion factor from meters to centimeters.
M_TO_CM: float = 100.0
# Initial agents / measures
#: Fixed number of segments per quarter circle for approximating disk boundaries as Shapely polygons.
DISK_QUAD_SEGS: int = 10
#: Size of the minimum distance between two points when simplifying polygons representing one contour of a 3D agent.
POLYGON_TOLERANCE: float = 0.04
#: Size of the altitude bins, chosen to reduce the number of contours used to represent a 3D agent
DISTANCE_BTW_TARGET_KEYS_ALTITUDES: float = 2.0
#: Maximum number of iterations for the dual annealing optimization algorithm used to fit the 2D shape of an agent.
NB_FUNCTION_EVALS: int = 80
#: Default number of disks used to approximate the 2D shape of a pedestrian.
DISK_NUMBER: int = 5
#: Default damping coefficient for the fluid friction force between floor and agents (1/s)
DEFAULT_FLOOR_DAMPING: float = 2.0
#: Default damping coefficient for the fluid friction torque between floor and agents (1/s)
DEFAULT_ANGULAR_DAMPING: float = 2.0
#: Width of the sigmoid used to fit the 3D shape to anthropometric data, with the transition at knee height (cm).
EPSILON_SMOOTHING_KNEES: float = 8.0
#: Width of the sigmoid used to fit the 3D shape to anthropometric data, with the transition at neck height (cm).
EPSILON_SMOOTHING_NECK: float = 2.0
#: Altitude of the neck for the default male 3D pedestrian (cm).
NECK_HEIGHT_MALE: float = 160.0
#: Altitude of the neck for the default female 3D pedestrian (cm).
NECK_HEIGHT_FEMALE: float = 150.0
#: Altitude of the knees for the default male 3D pedestrian (cm).
KNEES_HEIGHT_MALE: float = 59.0
#: Altitude of the knees for the default female 3D pedestrian (cm).
KNEES_HEIGHT_FEMALE: float = 50.0
#: Ratio of the altitude of the horizontal slice used to measure bideltoid breadth in the 186.6 cm reference cryogenic male specimen
#: to its total height (identical for male and female).
HEIGHT_OF_BIDELTOID_OVER_HEIGHT: float = 151.6 / 186.6
# Material properties
#: Default young modulus of the concrete material used for obstacles (N/m).
YOUNG_MODULUS_CONCRETE: float = 1.7e9
#: Default young modulus of the naked human body material (N/m).
YOUNG_MODULUS_HUMAN_NAKED: float = 4.0e6
#: Default young modulus of the clothed human body material (N/m).
YOUNG_MODULUS_HUMAN_CLOTHES: float = 3.1e6
#: Default shear modulus of the concrete material used for obstacles (N/m).
SHEAR_MODULUS_CONCRETE: float = 7.10e8 # N/m
#: Default shear modulus of the naked human body material (N/m) under the incompressibility hypothesis i.e. nu = 0.5.
SHEAR_MODULUS_HUMAN_NAKED: float = 1.38e6
#: Default shear modulus of the clothed human body material (N/m) under the incompressibility hypothesis i.e. nu = 0.5.
SHEAR_MODULUS_HUMAN_CLOTHES: float = 9.0e5
#: Default normal-contact damping coefficient (N·s/m), used both for agent–agent and agent–obstacle interactions.
GAMMA_NORMAL: float = 1.3 * 10**3
#: Default tangential-contact damping coefficient (N·s/m), used both for agent–agent and agent–obstacle interactions.
GAMMA_TANGENTIAL: float = 1.3 * 10**3
#: Default coefficient of kinetic friction (dimensionless), used both for agent–agent and agent–obstacle interactions.
KINETIC_FRICTION: float = 0.5
# Crowd class
#: Default number of agents in the crowd.
DEFAULT_AGENT_NUMBER: int = 4
#: Maximum number of attempts to place an agent in the crowd without overlap for the packing algorithm.
MAX_NB_ITERATIONS: int = 130
#: Default repulsion length (cm) used in the packing algorithm to avoid initial overlaps between agents.
DEFAULT_REPULSION_LENGTH: float = 5.0
#: Default desired direction (degrees) for all agents in the crowd.
DEFAULT_DESIRED_DIRECTION: float = 0.0
#: Boolean variable selecting between pseudo‑random orientation and perfect alignment for all agents in the crowd.
DEFAULT_VARIABLE_ORIENTATION: bool = False
#: Large value used to represent infinity.
INFINITE: float = 1.0e10
#: Intensity of the random forces (degrees) applied to agents during the packing algorithm to help them escape local overlaps.
INTENSITY_ROTATIONAL_FORCE: float = 10.0
#: Intensity of the random forces (cm) applied to agents during the packing algorithm to help them escape local overlaps.
INTENSITY_TRANSLATIONAL_FORCE: float = 5.0
#: Default grid size in the X direction (cm) for the packing of the pedestrians on a grid.
GRID_SIZE_X: float = 31.0
#: Default grid size in the Y direction (cm) for the packing of the pedestrians on a grid.
GRID_SIZE_Y: float = 60.0
#: Default grid size in the X direction (cm) for the packing of the bikes on a grid.
GRID_SIZE_X_BIKE: float = 200.0
#: Default grid size in the Y direction (cm) for the packing of the bikes on a grid.
GRID_SIZE_Y_BIKE: float = 200.0
#: Initial temperature used to stabilize crowd packing by gradually reducing the magnitude of rotations.
INITIAL_TEMPERATURE: float = 1.0
#: Cooling rate for the packing algorithm T<- max(T, T - COOLING_RATE)
ADDITIVE_COOLING: float = 0.1
# Crowd Statistics
#: Default weight of a bike (kg) used for the initialization of a bike.
DEFAULT_BIKE_WEIGHT: float = 30.0
#: Default weight of a pedestrian (kg) used for the initialization of a pedestrian.
DEFAULT_PEDESTRIAN_WEIGHT: float = 70.0
# Decisional force and torque
#: Default propulsion force in the X direction (N) used to populate the AgentDynamics file.
DECISIONAL_TRANSLATIONAL_FORCE_X: float = 10.0**2
#: Default propulsion force in the Y direction (N) used to populate the AgentDynamics file.
DECISIONAL_TRANSLATIONAL_FORCE_Y: float = 10.0**2
#: Default propulsion torque (N.m) used to populate the AgentDynamics file.
DECISIONAL_TORQUE: float = 0.0
# Initial velocity
#: Default initial translational velocity in the X direction (m/s) used to populate the AgentDynamics file.
INITIAL_TRANSLATIONAL_VELOCITY_X: float = 0.0
#: Default initial translational velocity in the Y direction (m/s) used to populate the AgentDynamics file.
INITIAL_TRANSLATIONAL_VELOCITY_Y: float = 0.0
#: Default initial rotational velocity (rad/s) used to populate the AgentDynamics file.
INITIAL_ROTATIONAL_VELOCITY: float = 0.0
# Agent Interactions
#: Default initial tangential force in the X direction (N) used to populate the AgentInteractions file.
INITIAL_TANGENTIAL_FORCE_X: float = 0.0
#: Default initial tangential force in the Y direction (N) used to populate the AgentInteractions file.
INITIAL_TANGENTIAL_FORCE_Y: float = 0.0
#: Default initial normal force in the X direction (N) used to populate the AgentInteractions file.
INITIAL_NORMAL_FORCE_X: float = 0.0
#: Default initial normal force in the Y direction (N) used to populate the AgentInteractions file.
INITIAL_NORMAL_FORCE_Y: float = 0.0
#: Default initial tangential relative displacement in the X direction (m) used to populate the AgentInteractions file.
INITIAL_TANGENTIAL_RELATIVE_DISPLACEMENT_X: float = 0.0
#: Default initial tangential relative displacement in the Y direction (m) used to populate the AgentInteractions file.
INITIAL_TANGENTIAL_RELATIVE_DISPLACEMENT_Y: float = 0.0
[docs]
class BackupDataTypes(Enum):
"""Enum for backup data types."""
zip = auto()
pickle = auto()
xml = auto()
[docs]
class AgentTypes(Enum):
"""Enum for agent types."""
pedestrian = auto()
bike = auto()
custom = auto()
[docs]
class ShapeTypes(Enum):
"""Enum for shape types."""
disk = auto()
rectangle = auto()
polygon = auto()
[docs]
class PedestrianParts(Enum):
"""Enum for pedestrian parts."""
sex = auto()
bideltoid_breadth = auto()
chest_depth = auto()
height = auto()
[docs]
class Sex(Enum):
"""Enum for pedestrian sex."""
male = auto()
female = auto()
[docs]
class BikeParts(Enum):
"""Bike is an enumeration that defines different parts of a bike."""
wheel_width = auto()
total_length = auto()
handlebar_length = auto()
top_tube_length = auto()
[docs]
class CommonMeasures(Enum):
"""CommonMeasures is an enumeration that defines different common measures."""
weight = auto()
moment_of_inertia = auto()
[docs]
class StatType(Enum):
"""StatType is an enumeration that defines different types of statistics."""
mean = auto()
std_dev = auto()
min = auto()
max = auto()
#: Immutable dictionary containing default statistical data for crowd generation.
CrowdStat = MappingProxyType(
{
"male_proportion": 0.5,
"pedestrian_proportion": 1.0,
"bike_proportion": 0.0,
# Male measurements
"male_bideltoid_breadth_min": 30.0, # cm
"male_bideltoid_breadth_max": 65.0, # cm
"male_bideltoid_breadth_mean": 51.0, # cm
"male_bideltoid_breadth_std_dev": 2.0, # cm
"male_chest_depth_min": 15.0, # cm
"male_chest_depth_max": 45.0, # cm
"male_chest_depth_mean": 26.0, # cm
"male_chest_depth_std_dev": 2.0, # cm
"male_height_min": 140.0, # cm
"male_height_max": 240.0, # cm
"male_height_mean": 178.0, # cm
"male_height_std_dev": 8.0, # cm
"male_weight_min": 30.0, # kg
"male_weight_max": 160.0, # kg
"male_weight_mean": 85.0, # kg
"male_weight_std_dev": 15.0, # kg
# Female measurements
"female_bideltoid_breadth_min": 30.0, # cm
"female_bideltoid_breadth_max": 60.0, # cm
"female_bideltoid_breadth_mean": 45.0, # cm
"female_bideltoid_breadth_std_dev": 1.5, # cm
"female_chest_depth_min": 15.0, # cm
"female_chest_depth_max": 45.0, # cm
"female_chest_depth_mean": 24.0, # cm
"female_chest_depth_std_dev": 1.5, # cm
"female_height_min": 140.0, # cm
"female_height_max": 210.0, # cm
"female_height_mean": 164.0, # cm
"female_height_std_dev": 7.0, # cm
"female_weight_min": 30.0, # kg
"female_weight_max": 130.0, # kg
"female_weight_mean": 67.0, # kg
"female_weight_std_dev": 11.0, # kg
# Wheel dimensions
"wheel_width_min": 2.0, # cm
"wheel_width_max": 20.0, # cm
"wheel_width_mean": 6.0, # cm
"wheel_width_std_dev": 0.50, # cm
# Total length
"total_length_min": 100.0, # cm
"total_length_max": 200.0, # cm
"total_length_mean": 142.0, # cm
"total_length_std_dev": 5.0, # cm
# Handlebar dimensions
"handlebar_length_min": 30.0, # cm
"handlebar_length_max": 90.0, # cm
"handlebar_length_mean": 45.0, # cm
"handlebar_length_std_dev": 5.0, # cm
# Top tube dimensions
"top_tube_length_min": 40.0, # cm
"top_tube_length_max": 90.0, # cm
"top_tube_length_mean": 61.0, # cm
"top_tube_length_std_dev": 5.0, # cm
# Bike weights
"bike_weight_min": 10.0, # kg
"bike_weight_max": 100.0, # kg
"bike_weight_mean": 30.0, # kg
"bike_weight_std_dev": 5.0, # kg
}
)
[docs]
class MaterialNames(Enum):
"""Enum for material names."""
concrete = auto()
human_clothes = auto()
human_naked = auto()
[docs]
class MaterialProperties(Enum):
"""Enum for material properties."""
young_modulus = auto()
shear_modulus = auto()