f1tenth_gym Logo
stable

INSTALLATION

  • Installation
    • Using docker
    • Using pip

USAGE

  • Basic Usage Example
  • Customized Usage Example
    • Custom Map
      • Map Metadata File (yaml)
      • Map Image File
      • Using a Custom Map
      • Random Track Generator (Beta)
    • Multiple Agents
    • Changing Parameters in Vehicle Dynamics

REPRODUCIBILITY

  • Reproducing experiments when using the environment

API REFERENCE

  • Base Classes
    • f110_gym.envs.base_classes
      • f110_gym.envs.base_classes.__init__()
      • f110_gym.envs.base_classes.update_params()
      • f110_gym.envs.base_classes.set_map()
      • f110_gym.envs.base_classes.reset()
      • f110_gym.envs.base_classes.ray_cast_agents()
      • f110_gym.envs.base_classes.check_ttc()
      • f110_gym.envs.base_classes.update_pose()
      • f110_gym.envs.base_classes.update_opp_poses()
      • f110_gym.envs.base_classes.update_scan()
      • f110_gym.envs.base_classes.params
      • f110_gym.envs.base_classes.is_ego
      • f110_gym.envs.base_classes.time_step
      • f110_gym.envs.base_classes.num_beams
      • f110_gym.envs.base_classes.fov
      • f110_gym.envs.base_classes.state
      • f110_gym.envs.base_classes.opp_poses
      • f110_gym.envs.base_classes.accel
      • f110_gym.envs.base_classes.steer_angle_vel
      • f110_gym.envs.base_classes.steer_buffer
      • f110_gym.envs.base_classes.steer_buffer_size
      • f110_gym.envs.base_classes.in_collision
      • f110_gym.envs.base_classes.ttc_thresh
      • f110_gym.envs.base_classes.scan_simulator
      • f110_gym.envs.base_classes.current_scan
      • f110_gym.envs.base_classes.cosines
      • f110_gym.envs.base_classes.scan_angles
      • f110_gym.envs.base_classes.side_distances
    • __init__()
    • set_map()
    • update_params()
    • check_collision()
    • step()
    • reset()
    • num_agents
    • time_step
    • ego_idx
    • params
    • agent_poses
    • agents
    • collisions
    • collision_idx
  • Dynamic Models
    • f110_gym.envs.dynamic_models
      • f110_gym.envs.dynamic_models.accl_constraints()
      • f110_gym.envs.dynamic_models.steering_constraint()
      • f110_gym.envs.dynamic_models.vehicle_dynamics_ks()
      • f110_gym.envs.dynamic_models.vehicle_dynamics_st()
      • f110_gym.envs.dynamic_models.pid()
      • f110_gym.envs.dynamic_models.func_KS()
      • f110_gym.envs.dynamic_models.func_ST()
      • f110_gym.envs.dynamic_models.cache
      • f110_gym.envs.dynamic_models.setUp()
      • f110_gym.envs.dynamic_models.test_derivatives()
      • f110_gym.envs.dynamic_models.test_zeroinit_roll()
      • f110_gym.envs.dynamic_models.test_zeroinit_dec()
      • f110_gym.envs.dynamic_models.test_zeroinit_acc()
      • f110_gym.envs.dynamic_models.test_zeroinit_rollleft()
      • f110_gym.envs.dynamic_models.mu
      • f110_gym.envs.dynamic_models.C_Sf
      • f110_gym.envs.dynamic_models.C_Sr
      • f110_gym.envs.dynamic_models.lf
      • f110_gym.envs.dynamic_models.lr
      • f110_gym.envs.dynamic_models.h
      • f110_gym.envs.dynamic_models.m
      • f110_gym.envs.dynamic_models.I
      • f110_gym.envs.dynamic_models.s_min
      • f110_gym.envs.dynamic_models.s_max
      • f110_gym.envs.dynamic_models.sv_min
      • f110_gym.envs.dynamic_models.sv_max
      • f110_gym.envs.dynamic_models.v_min
      • f110_gym.envs.dynamic_models.v_max
      • f110_gym.envs.dynamic_models.v_switch
      • f110_gym.envs.dynamic_models.a_max
  • Laser Scan Simulator Models
    • f110_gym.envs.laser_models
      • f110_gym.envs.laser_models.get_dt()
      • f110_gym.envs.laser_models.xy_2_rc()
      • f110_gym.envs.laser_models.distance_transform()
      • f110_gym.envs.laser_models.trace_ray()
      • f110_gym.envs.laser_models.get_scan()
      • f110_gym.envs.laser_models.check_ttc_jit()
      • f110_gym.envs.laser_models.cross()
      • f110_gym.envs.laser_models.are_collinear()
      • f110_gym.envs.laser_models.get_range()
      • f110_gym.envs.laser_models.ray_cast()
      • f110_gym.envs.laser_models.main()
      • f110_gym.envs.laser_models.__init__()
      • f110_gym.envs.laser_models.set_map()
      • f110_gym.envs.laser_models.scan()
      • f110_gym.envs.laser_models.get_increment()
      • f110_gym.envs.laser_models.num_beams
      • f110_gym.envs.laser_models.fov
      • f110_gym.envs.laser_models.std_dev
      • f110_gym.envs.laser_models.eps
      • f110_gym.envs.laser_models.theta_dis
      • f110_gym.envs.laser_models.max_range
      • f110_gym.envs.laser_models.angle_increment
      • f110_gym.envs.laser_models.theta_index_increment
      • f110_gym.envs.laser_models.orig_c
      • f110_gym.envs.laser_models.orig_s
      • f110_gym.envs.laser_models.orig_x
      • f110_gym.envs.laser_models.orig_y
      • f110_gym.envs.laser_models.map_height
      • f110_gym.envs.laser_models.map_width
      • f110_gym.envs.laser_models.map_resolution
      • f110_gym.envs.laser_models.dt
      • f110_gym.envs.laser_models.rng
      • f110_gym.envs.laser_models.sines
      • f110_gym.envs.laser_models.cosines
      • f110_gym.envs.laser_models.map_img
      • f110_gym.envs.laser_models.origin
    • setUp()
    • test_map_berlin()
    • test_map_skirk()
    • test_fps()
    • num_beams
    • fov
    • num_test
    • test_poses
    • berlin_scan
    • skirk_scan
  • Collision Models
    • f110_gym.envs.collision_models
      • f110_gym.envs.collision_models.perpendicular()
      • f110_gym.envs.collision_models.tripleProduct()
      • f110_gym.envs.collision_models.avgPoint()
      • f110_gym.envs.collision_models.indexOfFurthestPoint()
      • f110_gym.envs.collision_models.support()
      • f110_gym.envs.collision_models.collision()
      • f110_gym.envs.collision_models.collision_multiple()
      • f110_gym.envs.collision_models.get_trmtx()
      • f110_gym.envs.collision_models.get_vertices()
      • f110_gym.envs.collision_models.cache
      • f110_gym.envs.collision_models.setUp()
      • f110_gym.envs.collision_models.test_get_vert()
      • f110_gym.envs.collision_models.test_get_vert_fps()
      • f110_gym.envs.collision_models.test_random_collision()
      • f110_gym.envs.collision_models.test_multiple_collisions()
      • f110_gym.envs.collision_models.test_fps()
      • f110_gym.envs.collision_models.vertices1
      • f110_gym.envs.collision_models.length
      • f110_gym.envs.collision_models.width
  • Gym Environment
    • f110_gym.envs.f110_env
      • f110_gym.envs.f110_env.VIDEO_W
      • f110_gym.envs.f110_env.VIDEO_H
      • f110_gym.envs.f110_env.WINDOW_W
      • f110_gym.envs.f110_env.WINDOW_H
      • f110_gym.envs.f110_env.__init__()
      • f110_gym.envs.f110_env.__del__()
      • f110_gym.envs.f110_env.step()
      • f110_gym.envs.f110_env.reset()
      • f110_gym.envs.f110_env.update_map()
      • f110_gym.envs.f110_env.update_params()
      • f110_gym.envs.f110_env.render()
      • f110_gym.envs.f110_env.map_name
      • f110_gym.envs.f110_env.map_path
      • f110_gym.envs.f110_env.map_ext
      • f110_gym.envs.f110_env.params
      • f110_gym.envs.f110_env.num_agents
      • f110_gym.envs.f110_env.timestep
      • f110_gym.envs.f110_env.ego_idx
      • f110_gym.envs.f110_env.start_thresh
      • f110_gym.envs.f110_env.poses_x
      • f110_gym.envs.f110_env.poses_y
      • f110_gym.envs.f110_env.poses_theta
      • f110_gym.envs.f110_env.collisions
      • f110_gym.envs.f110_env.near_start
      • f110_gym.envs.f110_env.num_toggles
      • f110_gym.envs.f110_env.lap_times
      • f110_gym.envs.f110_env.lap_counts
      • f110_gym.envs.f110_env.current_time
      • f110_gym.envs.f110_env.near_starts
      • f110_gym.envs.f110_env.toggle_list
      • f110_gym.envs.f110_env.start_xs
      • f110_gym.envs.f110_env.start_ys
      • f110_gym.envs.f110_env.start_thetas
      • f110_gym.envs.f110_env.start_rot
      • f110_gym.envs.f110_env.sim
      • f110_gym.envs.f110_env.renderer
      • f110_gym.envs.f110_env.current_obs
      • f110_gym.envs.f110_env.metadata
      • f110_gym.envs.f110_env._check_done()
      • f110_gym.envs.f110_env._update_state()
  • What’s In an Observation
  • Rendering Engine
    • f110_gym.envs.rendering
      • f110_gym.envs.rendering.ZOOM_IN_FACTOR
      • f110_gym.envs.rendering.ZOOM_OUT_FACTOR
      • f110_gym.envs.rendering.CAR_LENGTH
      • f110_gym.envs.rendering.CAR_WIDTH
      • f110_gym.envs.rendering.__init__()
      • f110_gym.envs.rendering.update_map()
      • f110_gym.envs.rendering.on_resize()
      • f110_gym.envs.rendering.on_mouse_drag()
      • f110_gym.envs.rendering.on_mouse_scroll()
      • f110_gym.envs.rendering.on_close()
      • f110_gym.envs.rendering.on_draw()
      • f110_gym.envs.rendering.update_obs()
      • f110_gym.envs.rendering.left
      • f110_gym.envs.rendering.right
      • f110_gym.envs.rendering.bottom
      • f110_gym.envs.rendering.top
      • f110_gym.envs.rendering.zoom_level
      • f110_gym.envs.rendering.zoomed_width
      • f110_gym.envs.rendering.zoomed_height
      • f110_gym.envs.rendering.batch
      • f110_gym.envs.rendering.map_points
      • f110_gym.envs.rendering.poses
      • f110_gym.envs.rendering.vertices
      • f110_gym.envs.rendering.score_label
      • f110_gym.envs.rendering.fps_display
      • f110_gym.envs.rendering.ego_idx
      • f110_gym.envs.rendering.cars
    • pyglet.gl
f1tenth_gym
  • Search

© Copyright 2021, Hongrui Zheng, Matthew O'Kelly, Aman Sinha. Revision 24726dda.

Built with Sphinx using a theme provided by Read the Docs.