User Guide
API Documentation
get_state()
get_sensors()
step()
set_force()
set_force_world()
set_force_body()
set_body_wrench()
set_body_velocity()
set_scenario()
get_terrain_grid()
export_dataset()
OceanSimClient
OceanSimClient.PROTOCOL_VERSION
OceanSimClient.is_connected
OceanSimClient.launch_godot()
OceanSimClient.connect()
OceanSimClient.disconnect()
OceanSimClient.send()
OceanSimClient.send_command()
OceanSimClient.send_sim_control()
OceanSimClient.send_batch()
OceanSimClient.request_state()
OceanSimClient.get_latest_state()
OceanSimError
OceanSimConnectionError
OceanSimTimeoutError
OceanSimProtocolError
AUVState
AUVState.x
AUVState.y
AUVState.z
AUV
AUV.connect()
AUV.disconnect()
AUV.set_force()
AUV.set_force_world()
AUV.set_force_body()
AUV.set_body_wrench()
AUV.set_body_velocity()
AUV.hold_depth_step()
AUV.track_waypoint_step()
AUV.get_sensors()
AgentDefinition
AgentDefinition.from_dict()
AgentDefinition.to_dict()
ActionSpace
ActionSpace.validate()
OceanSimAgent
AgentFactory
AgentFactory.build_agent()
normalize_sensor_payload()
validate_sensor_payload()
validate_sensor_set()
OceanSimPointCloudMap
OceanSimPointCloudMap.add_cloud()
OceanSimPointCloudMap.add_pose()
OceanSimPointCloudMap.cloud_array()
OceanSimPointCloudMap.save_npz()
OceanSimPointCloudMap.load_npz()
OceanSimPointCloudMap.render_colored_map()
OceanSimPointCloudMap.render_exploration_map()
RGBDPointCloudSLAM
RGBDPointCloudSLAM.add_frame()
RGBDPointCloudSLAM.point_array()
RGBDPointCloudSLAM.color_array()
RGBDPointCloudSLAM.fused_arrays()
RGBDPointCloudSLAM.save_ply()
RGBDPointCloudSLAM.save_npz()
RGBDPointCloudSLAM.render()
OceanSimPklRecorder
OceanSimPklRecorder.scenario
OceanSimPklRecorder.voxel_size
OceanSimPklRecorder.max_points_per_frame
OceanSimPklRecorder.add_frame()
OceanSimPklRecorder.to_dataset()
OceanSimPklRecorder.save()
OceanSimPklRecorder.load()
dataset_to_mapper()
load_pkl_dataset()
OceanSimRunReplay
OceanSimRunReplay.open()
OceanSimRunReplay.frame_count()
OceanSimRunReplay.iter_frames()
OceanSimRunReplay.trajectory()
OceanSimRunReplay.sensor_frames()
OceanSimRunReplay.summary()
OceanSimRunReplay.tum_trajectory_rows()
OceanSimRunReplay.euroc_trajectory_rows()
Developer Guide