Skip to content
RatatouGym 1.0.0 documentation
Toggle navigation menu
⌘
K
RatatouGym 1.0.0 documentation
/
Index
Index
A
add_sensory() (Agent method)
(Sensory method)
Agent (class in rtgym.agent.agent)
AgentState (class in rtgym.dataclass.agent_state)
aggregate_res_maps() (Sensory method)
append() (RawTrajectory method)
apply_gaussian_blur() (Masking method)
arena (Agent property)
(BaseBehavior property)
Arena (class in rtgym.arena.arena)
arena (MMBase attribute)
(Sensory property)
(SMBase attribute)
arena_height (Arena property)
arena_map (Arena property)
(RatatouGym property)
arena_width (Arena property)
autonomous (Agent property)
AutonomousBehavior (class in rtgym.agent.behavior.autonomous_behavior)
avoid_boundary_dist (BehaviorConfig property)
B
BaseBehavior (class in rtgym.agent.behavior.base_behavior)
batch_size (RawAgentState property)
Behavior (class in rtgym.agent.behavior)
(class in rtgym.agent.behavior.behavior)
BehaviorConfig (class in rtgym.agent.behavior.behavior_config)
BoundaryCell (class in rtgym.agent.sensory.spatial_modulated)
(class in rtgym.agent.sensory.spatial_modulated.boundary_cell)
C
combine_trajectories() (in module rtgym.utils.data_processing)
common_params (Sensory property)
compute_layout() (in module rtgym.utils.verbose)
compute_res() (Sensory method)
config (BaseBehavior attribute)
controllable (Agent property)
ControllableBehavior (class in rtgym.agent.behavior.controllable_behavior)
coord (Trajectory property)
copy() (RawAgentState method)
(Trajectory method)
create_dataclass_result() (in module rtgym.utils.decode_response)
D
decode_response() (Sensory method)
decode_response_euclidean() (in module rtgym.utils.decode_response)
decode_response_faiss() (in module rtgym.utils.decode_response)
decode_response_interpolation() (in module rtgym.utils.decode_response)
decode_response_kdtree() (in module rtgym.utils.decode_response)
decode_response_torch() (in module rtgym.utils.decode_response)
dimensions (Arena attribute)
DirectionCell (class in rtgym.agent.sensory.movement_modulated)
(class in rtgym.agent.sensory.movement_modulated.direction_cell)
DirectionRad (class in rtgym.agent.sensory.movement_modulated)
(class in rtgym.agent.sensory.movement_modulated.direction_rad)
DisplacementAbs (class in rtgym.agent.sensory.movement_modulated)
(class in rtgym.agent.sensory.movement_modulated.displacement_abs)
distance_map (BaseBehavior attribute)
F
filter_sensories() (Sensory method)
float_coord (AgentState property)
(RawAgentState property)
(Trajectory property)
free_space (Arena attribute)
from_dict() (Trajectory class method)
G
gaussian_kernel_1d() (Masking method)
generate_circle_arena() (in module rtgym.arena.arena_shapes.circle)
generate_cornered_rectangle_arena() (in module rtgym.arena.arena_shapes.cornered_rectangle)
generate_maze_0_arena() (in module rtgym.arena.arena_shapes.maze_0)
generate_maze_1_arena() (in module rtgym.arena.arena_shapes.maze_1)
generate_maze_2_arena() (in module rtgym.arena.arena_shapes.maze_2)
generate_random_pos() (Arena method)
generate_rectangle_arena() (in module rtgym.arena.arena_shapes.rectangle)
generate_titles() (in module rtgym.utils.verbose)
generate_trainer_0_arena() (in module rtgym.arena.arena_shapes.trainer_0)
generate_trajectory() (AutonomousBehavior method)
(Behavior method)
,
[1]
generate_triangle_arena() (in module rtgym.arena.arena_shapes.triangle)
generate_two_rooms_arena() (in module rtgym.arena.arena_shapes.two_rooms)
get_gym_dimensions() (in module rtgym.utils.data_processing)
get_ratemap() (RatemapAggregator method)
get_response() (Agent method)
(DirectionCell method)
,
[1]
(DisplacementAbs method)
,
[1]
(HeadDirectionCell method)
,
[1]
(Sensory method)
(SMBase method)
(SpeedCell method)
,
[1]
get_responses() (DirectionRad method)
,
[1]
get_specs() (Arena method)
(BoundaryCell method)
,
[1]
(DirectionCell method)
,
[1]
(DirectionRad method)
,
[1]
(DisplacementAbs method)
,
[1]
(GridCell method)
,
[1]
(HeadDirectionCell method)
,
[1]
(MMBase method)
(PlaceCell method)
,
[1]
(SMBase method)
(SpeedCell method)
,
[1]
(WeakSMCell method)
,
[1]
get_trajectory() (ControllableBehavior method)
GridCell (class in rtgym.agent.sensory.spatial_modulated)
(class in rtgym.agent.sensory.spatial_modulated.grid_cell)
gym (BaseBehavior attribute)
H
hash_seed() (in module rtgym.utils.common)
HeadDirectionCell (class in rtgym.agent.sensory.movement_modulated)
(class in rtgym.agent.sensory.movement_modulated.head_direction_cell)
I
init_arena_map() (Arena method)
(RatatouGym method)
init_counts() (RatemapAggregator method)
init_from_profile() (AutonomousBehavior method)
(Behavior method)
,
[1]
(ControllableBehavior method)
(Sensory method)
initialized (BaseBehavior attribute)
,
[1]
int_coord (AgentState property)
(RawAgentState property)
(Trajectory property)
inv_arena_map (Arena property)
(RatatouGym property)
L
list_all() (Sensory method)
load() (Arena method)
(Sensory method)
(SMBase class method)
(Trajectory static method)
load_arena() (RatatouGym method)
load_from_dict() (GridCell class method)
,
[1]
load_from_state_dict() (Sensory method)
M
magnitude (MMBase attribute)
map (Arena property)
mask() (Masking method)
Masking (class in rtgym.utils.masking)
MMBase (class in rtgym.agent.sensory.movement_modulated.mm_base)
module
rtgym
rtgym.agent
rtgym.agent.agent
rtgym.agent.behavior
rtgym.agent.behavior.autonomous_behavior
rtgym.agent.behavior.base_behavior
rtgym.agent.behavior.behavior
rtgym.agent.behavior.behavior_config
rtgym.agent.behavior.controllable_behavior
rtgym.agent.sensory
rtgym.agent.sensory.movement_modulated
rtgym.agent.sensory.movement_modulated.direction_cell
rtgym.agent.sensory.movement_modulated.direction_rad
rtgym.agent.sensory.movement_modulated.displacement_abs
rtgym.agent.sensory.movement_modulated.head_direction_cell
rtgym.agent.sensory.movement_modulated.mm_base
rtgym.agent.sensory.movement_modulated.speed_cell
rtgym.agent.sensory.sensory
rtgym.agent.sensory.spatial_modulated
rtgym.agent.sensory.spatial_modulated.boundary_cell
rtgym.agent.sensory.spatial_modulated.grid_cell
rtgym.agent.sensory.spatial_modulated.place_cell
rtgym.agent.sensory.spatial_modulated.sm_base
rtgym.agent.sensory.spatial_modulated.weak_sm_cell
rtgym.arena
rtgym.arena.arena
rtgym.arena.arena_shapes
rtgym.arena.arena_shapes.circle
rtgym.arena.arena_shapes.cornered_rectangle
rtgym.arena.arena_shapes.maze_0
rtgym.arena.arena_shapes.maze_1
rtgym.arena.arena_shapes.maze_2
rtgym.arena.arena_shapes.rectangle
rtgym.arena.arena_shapes.trainer_0
rtgym.arena.arena_shapes.triangle
rtgym.arena.arena_shapes.two_rooms
rtgym.dataclass
rtgym.dataclass.agent_state
rtgym.dataclass.raw_agent_state
rtgym.dataclass.raw_trajectory
rtgym.dataclass.trajectory
rtgym.rtgym
rtgym.utils
rtgym.utils.common
rtgym.utils.data_processing
rtgym.utils.decode_response
rtgym.utils.masking
rtgym.utils.verbose
rtgym.utils.visualization
rtgym.utils.visualization.plot_ratemap
msigma (MMBase attribute)
N
n_cells (MMBase attribute)
(SMBase attribute)
n_steps (Trajectory property)
new_mask() (Masking method)
notify_subscribers() (Arena method)
num_sensories() (Sensory method)
P
perpend_angle_map (BaseBehavior attribute)
PlaceCell (class in rtgym.agent.sensory.spatial_modulated)
(class in rtgym.agent.sensory.spatial_modulated.place_cell)
plot_dual_field() (in module rtgym.utils.verbose)
plot_dual_fields() (in module rtgym.utils.verbose)
plot_ratemaps() (in module rtgym.utils.visualization.plot_ratemap)
plot_single_field() (in module rtgym.utils.verbose)
point_in_triangle() (in module rtgym.arena.arena_shapes.triangle)
prepare_fields() (in module rtgym.utils.verbose)
print_dict() (in module rtgym.utils.verbose)
print_specs() (Arena method)
(MMBase method)
(SMBase method)
R
random_pos() (RatatouGym method)
random_spawn() (Agent method)
random_traverse() (Agent method)
RatatouGym (class in rtgym.rtgym)
RatemapAggregator (class in rtgym.utils.data_processing)
RawAgentState (class in rtgym.dataclass.raw_agent_state)
RawTrajectory (class in rtgym.dataclass.raw_trajectory)
register_callback() (BehaviorConfig method)
require_init() (BaseBehavior static method)
reset() (ControllableBehavior method)
(RatemapAggregator method)
(RawAgentState method)
reshape() (Trajectory method)
response_map (PlaceCell attribute)
,
[1]
(SMBase attribute)
(WeakSMCell attribute)
,
[1]
restrain2ff() (in module rtgym.utils.data_processing)
rng (MMBase attribute)
(SMBase attribute)
rtgym
module
rtgym.agent
module
rtgym.agent.agent
module
rtgym.agent.behavior
module
rtgym.agent.behavior.autonomous_behavior
module
rtgym.agent.behavior.base_behavior
module
rtgym.agent.behavior.behavior
module
rtgym.agent.behavior.behavior_config
module
rtgym.agent.behavior.controllable_behavior
module
rtgym.agent.sensory
module
rtgym.agent.sensory.movement_modulated
module
rtgym.agent.sensory.movement_modulated.direction_cell
module
rtgym.agent.sensory.movement_modulated.direction_rad
module
rtgym.agent.sensory.movement_modulated.displacement_abs
module
rtgym.agent.sensory.movement_modulated.head_direction_cell
module
rtgym.agent.sensory.movement_modulated.mm_base
module
rtgym.agent.sensory.movement_modulated.speed_cell
module
rtgym.agent.sensory.sensory
module
rtgym.agent.sensory.spatial_modulated
module
rtgym.agent.sensory.spatial_modulated.boundary_cell
module
rtgym.agent.sensory.spatial_modulated.grid_cell
module
rtgym.agent.sensory.spatial_modulated.place_cell
module
rtgym.agent.sensory.spatial_modulated.sm_base
module
rtgym.agent.sensory.spatial_modulated.weak_sm_cell
module
rtgym.arena
module
rtgym.arena.arena
module
rtgym.arena.arena_shapes
module
rtgym.arena.arena_shapes.circle
module
rtgym.arena.arena_shapes.cornered_rectangle
module
rtgym.arena.arena_shapes.maze_0
module
rtgym.arena.arena_shapes.maze_1
module
rtgym.arena.arena_shapes.maze_2
module
rtgym.arena.arena_shapes.rectangle
module
rtgym.arena.arena_shapes.trainer_0
module
rtgym.arena.arena_shapes.triangle
module
rtgym.arena.arena_shapes.two_rooms
module
rtgym.dataclass
module
rtgym.dataclass.agent_state
module
rtgym.dataclass.raw_agent_state
module
rtgym.dataclass.raw_trajectory
module
rtgym.dataclass.trajectory
module
rtgym.rtgym
module
rtgym.utils
module
rtgym.utils.common
module
rtgym.utils.data_processing
module
rtgym.utils.decode_response
module
rtgym.utils.masking
module
rtgym.utils.verbose
module
rtgym.utils.visualization
module
rtgym.utils.visualization.plot_ratemap
module
S
s_res (BaseBehavior property)
(RatatouGym property)
(Sensory property)
save() (Arena method)
(Sensory method)
(SMBase method)
save_arena() (RatatouGym method)
sens_category (SMBase attribute)
sens_type (BoundaryCell attribute)
,
[1]
,
[2]
,
[3]
(DirectionCell attribute)
,
[1]
,
[2]
,
[3]
(DirectionRad attribute)
,
[1]
,
[2]
,
[3]
(DisplacementAbs attribute)
,
[1]
,
[2]
,
[3]
(GridCell attribute)
,
[1]
(HeadDirectionCell attribute)
,
[1]
,
[2]
,
[3]
(MMBase attribute)
(PlaceCell attribute)
,
[1]
,
[2]
,
[3]
(SMBase attribute)
(SpeedCell attribute)
,
[1]
,
[2]
,
[3]
(WeakSMCell attribute)
,
[1]
,
[2]
,
[3]
sensories (Agent property)
Sensory (class in rtgym.agent.sensory.sensory)
sensory_key (MMBase attribute)
(SMBase attribute)
set_arena_map() (Arena method)
(RatatouGym method)
set_behavior() (Agent method)
set_m_max() (Masking method)
set_m_min() (Masking method)
set_sensory() (Agent method)
set_sensory_manually() (Agent method)
(RatatouGym method)
slice() (Trajectory method)
SMBase (class in rtgym.agent.sensory.spatial_modulated.sm_base)
spatial_resolution (Agent property)
(Arena attribute)
spawn() (Agent method)
SpeedCell (class in rtgym.agent.sensory.movement_modulated)
(class in rtgym.agent.sensory.movement_modulated.speed_cell)
state (Agent property)
state_dict() (GridCell method)
,
[1]
(Trajectory method)
states2ff() (in module rtgym.utils.data_processing)
states_to_ratemap() (in module rtgym.utils.data_processing)
step() (Agent method)
(ControllableBehavior method)
subscribe() (Arena method)
subscribers (Arena attribute)
T
t_range() (Trajectory method)
t_res (BaseBehavior property)
(MMBase attribute)
(RatatouGym property)
(Sensory property)
temporal_resolution (Agent property)
title_single_field() (in module rtgym.utils.verbose)
to() (Masking method)
to_agent_state() (RawAgentState method)
to_coord() (RatatouGym method)
to_sec() (RatatouGym method)
to_tensor() (Masking method)
to_trajectory() (RawTrajectory method)
to_ts() (RatatouGym method)
Trajectory (class in rtgym.dataclass.trajectory)
U
update() (RatemapAggregator method)
update_state() (RawTrajectory method)
V
validate_index() (Arena method)
vis() (Arena method)
(DirectionCell method)
,
[1]
(HeadDirectionCell method)
,
[1]
(MMBase method)
(SMBase method)
(SpeedCell method)
,
[1]
vis_gif() (RatatouGym method)
vis_traj() (RatatouGym method)
visualize_fields() (in module rtgym.utils.verbose)
W
WeakSMCell (class in rtgym.agent.sensory.spatial_modulated)
(class in rtgym.agent.sensory.spatial_modulated.weak_sm_cell)