rtgym.arena package

Subpackages

• rtgym.arena.arena_shapes package
  • Submodules
  • rtgym.arena.arena_shapes.circle module
    • generate_circle_arena()
  • rtgym.arena.arena_shapes.cornered_rectangle module
    • generate_cornered_rectangle_arena()
  • rtgym.arena.arena_shapes.maze_0 module
    • generate_maze_0_arena()
  • rtgym.arena.arena_shapes.maze_1 module
    • generate_maze_1_arena()
  • rtgym.arena.arena_shapes.maze_2 module
    • generate_maze_2_arena()
  • rtgym.arena.arena_shapes.rectangle module
    • generate_rectangle_arena()
  • rtgym.arena.arena_shapes.trainer_0 module
    • generate_trainer_0_arena()
  • rtgym.arena.arena_shapes.triangle module
    • generate_triangle_arena()
    • point_in_triangle()
  • rtgym.arena.arena_shapes.two_rooms module
    • generate_two_rooms_arena()
  • Module contents

Submodules

rtgym.arena.arena module

class Arena(gym, **kwargs)

Bases: object

Arena environment for spatial navigation.

The Arena defines the physical space where agents navigate, including walls, obstacles, and free space. It manages the spatial layout and provides utilities for position validation and random position generation.

Parameters:

• gym (RatatouGym) – Parent gym environment.

• **kwargs – Additional keyword arguments.

spatial_resolution

Spatial resolution in units per pixel.

Type:

float

dimensions

Arena dimensions (height, width).

Type:

tuple

free_space

Coordinates of all free space positions.

Type:

np.ndarray

subscribers

List of objects subscribed to arena changes.

Type:

list

property arena_height

Get arena height.

Returns:

Arena height in pixels.

Return type:

int

property arena_map

Get the arena map.

Returns:

Arena map where 0 represents free space and 1 represents walls.

Return type:

np.ndarray

property arena_width

Get arena width.

Returns:

Arena width in pixels.

Return type:

int

generate_random_pos(size)

Get random positions in the arena

get_specs()

Get specs

init_arena_map(shape, **kwargs)

Set the arena map with a predefined shape.

Parameters:

shape (str) – Shape of the arena map.

property inv_arena_map

Get inverted arena map for visualization.

Returns:

Inverted arena map where 1 is free space, 0 is wall.

Return type:

np.ndarray

load(path)

Load arena map from an npz file

Parameters:

path (str) – Path to the file where the arena map is saved.

property map

Get arena map (alias for arena_map).

Returns:

Arena map where 0 is free space, 1 is wall.

Return type:

np.ndarray

notify_subscribers()

Notify all subscribers of arena changes.

Calls all registered subscriber functions to inform them that the arena has been modified.

print_specs()

Print specs

Parameters:

path (str) – Path to the file where the arena map is saved.

save(path)

Save arena map as an npz file

Parameters:

path (str) – Path to the file where the arena map is saved.

set_arena_map(arena_map)

Set arena map with custom layout.

Automatically pads edges with walls if they contain free space.

Parameters:

arena_map (np.ndarray) – Arena map where 0 is free space, 1 is wall.

Raises:

AssertionError – If arena_map is not a numpy array.

subscribe(subscriber)

Subscribe to arena change notifications.

Parameters:

subscriber (callable) – Function to call when arena changes.

validate_index(pos)

Check if the position is in the arena

vis()

Visualize arena

rtgym.arena.room_editor module

Module contents