Skip to content

Commit

Permalink
fixed typo in merge
Browse files Browse the repository at this point in the history
  • Loading branch information
stimpfli committed Jan 16, 2025
1 parent 01b42ff commit 8312cfa
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion flygym/examples/olfaction/plume_tracking_arena.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,30 @@ class OdorPlumeArena(BaseArena):
odor plume. The plume simulation is stored in an HDF5 file. In this
class, we implement logics that calculate the intensity of the odor
at the fly's location at the correct time.
Parameters
----------
plume_data_path : Path
Path to the HDF5 file containing the plume simulation data.
main_camera_name : str
Name of the main camera used to render the plume simulation.
dimension_scale_factor : float, optional
Scaling factor for the plume simulation grid. Each cell in the
plume grid is this many millimeters in the simulation. By
default 0.5.
plume_simulation_fps : float, optional
Frame rate of the plume simulation. Each frame in the plume
dataset is ``1 / plume_simulation_fps`` seconds in the physics
simulation. By default 200.
intensity_scale_factor : float, optional
Scaling factor for the intensity of the odor. By default 1.0.
friction : tuple[float, float, float], optional
Friction parameters for the floor geom. By default (1, 0.005,
0.0001).
num_sensors : int, optional
Number of olfactory sensors on the fly. By default 4.
"""

def __init__(
self,
plume_data_path: Path,
Expand All @@ -30,7 +54,7 @@ def __init__(
plume_data_path : Path
Path to the HDF5 file containing the plume simulation data.
main_camera_name : str
Name of the main camera used to render the plume simulation.
Name of the main camera used to render the plume.
dimension_scale_factor : float, optional
Scaling factor for the plume simulation grid. Each cell in the
plume grid is this many millimeters in the simulation. By
Expand Down

0 comments on commit 8312cfa

Please sign in to comment.