diff --git a/api/cpp/doctrees/environment.pickle b/api/cpp/doctrees/environment.pickle index 33b63a92..18af78dd 100644 Binary files a/api/cpp/doctrees/environment.pickle and b/api/cpp/doctrees/environment.pickle differ diff --git a/api/python/doctrees/api/autonomysim.ai.doctree b/api/python/doctrees/api/autonomysim.ai.doctree new file mode 100644 index 00000000..ab9b8d9a Binary files /dev/null and b/api/python/doctrees/api/autonomysim.ai.doctree differ diff --git a/api/python/doctrees/api/autonomysim.ai.imitation.doctree b/api/python/doctrees/api/autonomysim.ai.imitation.doctree new file mode 100644 index 00000000..2c8e66c8 Binary files /dev/null and b/api/python/doctrees/api/autonomysim.ai.imitation.doctree differ diff --git a/api/python/doctrees/api/autonomysim.ai.reinforcement.doctree b/api/python/doctrees/api/autonomysim.ai.reinforcement.doctree new file mode 100644 index 00000000..147774a7 Binary files /dev/null and b/api/python/doctrees/api/autonomysim.ai.reinforcement.doctree differ diff --git a/api/python/doctrees/api/autonomysim.ai.vision.doctree b/api/python/doctrees/api/autonomysim.ai.vision.doctree new file mode 100644 index 00000000..ca28e8da Binary files /dev/null and b/api/python/doctrees/api/autonomysim.ai.vision.doctree differ diff --git a/api/python/doctrees/api/autonomysim.doctree b/api/python/doctrees/api/autonomysim.doctree index c3e4228a..78adf149 100644 Binary files a/api/python/doctrees/api/autonomysim.doctree and b/api/python/doctrees/api/autonomysim.doctree differ diff --git a/api/python/doctrees/api/autonomysim.gym.doctree b/api/python/doctrees/api/autonomysim.gym.doctree new file mode 100644 index 00000000..5698283d Binary files /dev/null and b/api/python/doctrees/api/autonomysim.gym.doctree differ diff --git a/api/python/doctrees/api/autonomysim.gym.envs.doctree b/api/python/doctrees/api/autonomysim.gym.envs.doctree new file mode 100644 index 00000000..50f2df5a Binary files /dev/null and b/api/python/doctrees/api/autonomysim.gym.envs.doctree differ diff --git a/api/python/doctrees/api/autonomysim.sensors.doctree b/api/python/doctrees/api/autonomysim.sensors.doctree new file mode 100644 index 00000000..88c60bc6 Binary files /dev/null and b/api/python/doctrees/api/autonomysim.sensors.doctree differ diff --git a/api/python/doctrees/api/autonomysim.unreal.doctree b/api/python/doctrees/api/autonomysim.unreal.doctree new file mode 100644 index 00000000..34a0f6f1 Binary files /dev/null and b/api/python/doctrees/api/autonomysim.unreal.doctree differ diff --git a/api/python/doctrees/api/autonomysim.utils.doctree b/api/python/doctrees/api/autonomysim.utils.doctree new file mode 100644 index 00000000..9a8c638f Binary files /dev/null and b/api/python/doctrees/api/autonomysim.utils.doctree differ diff --git a/api/python/doctrees/api/autonomysim.utils.io.doctree b/api/python/doctrees/api/autonomysim.utils.io.doctree new file mode 100644 index 00000000..c57c8dc2 Binary files /dev/null and b/api/python/doctrees/api/autonomysim.utils.io.doctree differ diff --git a/api/python/doctrees/api/modules.doctree b/api/python/doctrees/api/modules.doctree new file mode 100644 index 00000000..858c3097 Binary files /dev/null and b/api/python/doctrees/api/modules.doctree differ diff --git a/api/python/doctrees/environment.pickle b/api/python/doctrees/environment.pickle index a4a2e6ee..2a75b7f1 100644 Binary files a/api/python/doctrees/environment.pickle and b/api/python/doctrees/environment.pickle differ diff --git a/api/python/doctrees/index.doctree b/api/python/doctrees/index.doctree index 70d2dc28..cbdb686a 100644 Binary files a/api/python/doctrees/index.doctree and b/api/python/doctrees/index.doctree differ diff --git a/api/python/html/_modules/autonomysim/client.html b/api/python/html/_modules/autonomysim/client.html index f2d525c9..daaba879 100644 --- a/api/python/html/_modules/autonomysim/client.html +++ b/api/python/html/_modules/autonomysim/client.html @@ -32,10 +32,9 @@ - + - - + @@ -196,94 +195,6 @@
-[docs]
+[docs]
class VehicleClient:
def __init__(self, ip="", port=41451, timeout_value=3600):
if ip == "":
@@ -324,7 +235,7 @@ Source code for autonomysim.client
# ----------------------------------- Common vehicle APIs ---------------------------------------------
-[docs]
+[docs]
def reset(self):
"""
Reset the vehicle to its original starting state
@@ -335,7 +246,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def ping(self):
"""
If connection is established then this call will return true otherwise it will be blocked until timeout
@@ -347,32 +258,32 @@ Source code for autonomysim.client
-[docs]
+[docs]
def getMinRequiredClientVersion(self):
return self.client.call("getMinRequiredClientVersion")
# basic flight control
-[docs]
+[docs]
def enableApiControl(self, is_enabled, vehicle_name=""):
"""
Enables or disables API control for vehicle corresponding to vehicle_name
@@ -385,7 +296,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def isApiControlEnabled(self, vehicle_name=""):
"""
Returns true if API control is established.
@@ -402,7 +313,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def armDisarm(self, arm, vehicle_name=""):
"""
Arms or disarms vehicle
@@ -418,7 +329,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simPause(self, is_paused):
"""
Pauses simulation
@@ -430,7 +341,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simIsPause(self):
"""
Returns true if the simulation is paused
@@ -442,7 +353,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simContinueForTime(self, seconds):
"""
Continue the simulation for the specified number of seconds
@@ -454,7 +365,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simContinueForFrames(self, frames):
"""
Continue (or resume if paused) the simulation for the specified number of frames, after which the simulation will be paused.
@@ -466,7 +377,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def getHomeGeoPoint(self, vehicle_name=""):
"""
Get the Home location of the vehicle
@@ -481,7 +392,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def confirmConnection(self):
"""
Checks state of connection every 1 sec and reports it in Console so user can see the progress for connection.
@@ -523,7 +434,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simSetLightIntensity(self, light_name, intensity):
"""
Change intensity of named light
@@ -539,7 +450,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simSwapTextures(self, tags, tex_id=0, component_id=0, material_id=0):
"""
Runtime Swap Texture API
@@ -563,7 +474,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simSetObjectMaterial(self, object_name, material_name, component_id=0):
"""
Runtime Swap Texture API
@@ -582,7 +493,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simSetObjectMaterialFromTexture(
self, object_name, texture_path, component_id=0
):
@@ -605,7 +516,7 @@ Source code for autonomysim.client
# time-of-day control
# time - of - day control
-[docs]
+[docs]
def simSetTimeOfDay(
self,
is_enabled,
@@ -644,7 +555,7 @@ Source code for autonomysim.client
# weather
-[docs]
+[docs]
def simEnableWeather(self, enable):
"""
Enable Weather effects. Needs to be called before using `simSetWeatherParameter` API
@@ -656,7 +567,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simSetWeatherParameter(self, param, val):
"""
Enable various weather effects
@@ -672,7 +583,7 @@ Source code for autonomysim.client
# simGetImage returns compressed png in array of bytes
# image_type uses one of the ImageType members
-[docs]
+[docs]
def simGetImage(self, camera_name, image_type, vehicle_name="", external=False):
"""
Get a single image
@@ -706,7 +617,7 @@ Source code for autonomysim.client
# simGetImage returns compressed png in array of bytes
# image_type uses one of the ImageType members
-[docs]
+[docs]
def simGetImages(self, requests, vehicle_name="", external=False):
"""
Get multiple images
@@ -731,7 +642,7 @@ Source code for autonomysim.client
# CinemAutonomySim
-[docs]
+[docs]
def simGetPresetLensSettings(self, camera_name, vehicle_name="", external=False):
result = self.client.call(
"simGetPresetLensSettings", camera_name, vehicle_name, external
@@ -742,7 +653,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simGetLensSettings(self, camera_name, vehicle_name="", external=False):
result = self.client.call(
"simGetLensSettings", camera_name, vehicle_name, external
@@ -753,7 +664,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simSetPresetLensSettings(
self, preset_lens_settings, camera_name, vehicle_name="", external=False
):
@@ -767,7 +678,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simGetPresetFilmbackSettings(
self, camera_name, vehicle_name="", external=False
):
@@ -780,7 +691,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simSetPresetFilmbackSettings(
self, preset_filmback_settings, camera_name, vehicle_name="", external=False
):
@@ -794,7 +705,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simGetFilmbackSettings(self, camera_name, vehicle_name="", external=False):
result = self.client.call(
"simGetFilmbackSettings", camera_name, vehicle_name, external
@@ -805,7 +716,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simSetFilmbackSettings(
self, sensor_width, sensor_height, camera_name, vehicle_name="", external=False
):
@@ -820,7 +731,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simGetFocalLength(self, camera_name, vehicle_name="", external=False):
return self.client.call(
"simGetFocalLength", camera_name, vehicle_name, external
@@ -828,7 +739,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simSetFocalLength(
self, focal_length, camera_name, vehicle_name="", external=False
):
@@ -838,7 +749,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simEnableManualFocus(
self, enable, camera_name, vehicle_name="", external=False
):
@@ -848,7 +759,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simGetFocusDistance(self, camera_name, vehicle_name="", external=False):
return self.client.call(
"simGetFocusDistance", camera_name, vehicle_name, external
@@ -856,7 +767,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simSetFocusDistance(
self, focus_distance, camera_name, vehicle_name="", external=False
):
@@ -866,7 +777,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simGetFocusAperture(self, camera_name, vehicle_name="", external=False):
return self.client.call(
"simGetFocusAperture", camera_name, vehicle_name, external
@@ -874,7 +785,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simSetFocusAperture(
self, focus_aperture, camera_name, vehicle_name="", external=False
):
@@ -884,7 +795,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simEnableFocusPlane(self, enable, camera_name, vehicle_name="", external=False):
self.client.call(
"simEnableFocusPlane", enable, camera_name, vehicle_name, external
@@ -892,7 +803,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simGetCurrentFieldOfView(self, camera_name, vehicle_name="", external=False):
return self.client.call(
"simGetCurrentFieldOfView", camera_name, vehicle_name, external
@@ -901,7 +812,7 @@ Source code for autonomysim.client
# End CinemAutonomySim
-[docs]
+[docs]
def simTestLineOfSightToPoint(self, point, vehicle_name=""):
"""
Returns whether the target point is visible from the perspective of the inputted vehicle
@@ -917,7 +828,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simTestLineOfSightBetweenPoints(self, point1, point2):
"""
Returns whether the target point is visible from the perspective of the source point
@@ -933,7 +844,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simGetWorldExtents(self):
"""
Returns a list of GeoPoints representing the minimum and maximum extents of the world
@@ -946,7 +857,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simRunConsoleCommand(self, command):
"""
Allows the client to execute a command in Unreal's native console, via an API.
@@ -964,7 +875,7 @@ Source code for autonomysim.client
# gets the static meshes in the unreal scene
-[docs]
+[docs]
def simGetMeshPositionVertexBuffers(self):
"""
Returns the static meshes that make up the scene
@@ -982,7 +893,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simGetCollisionInfo(self, vehicle_name=""):
"""
Args:
@@ -997,7 +908,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simSetVehiclePose(self, pose, ignore_collision, vehicle_name=""):
"""
Set the pose of the vehicle
@@ -1013,7 +924,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simGetVehiclePose(self, vehicle_name=""):
"""
The position inside the returned Pose is in the frame of the vehicle's starting point
@@ -1029,7 +940,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simSetTraceLine(self, color_rgba, thickness=1.0, vehicle_name=""):
"""
Modify the color and thickness of the line when Tracing is enabled
@@ -1045,7 +956,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simGetObjectPose(self, object_name):
"""
The position inside the returned Pose is in the world frame
@@ -1061,7 +972,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simSetObjectPose(self, object_name, pose, teleport=True):
"""
Set the pose of the object(actor) in the environment
@@ -1081,7 +992,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simGetObjectScale(self, object_name):
"""
Gets scale of an object in the world
@@ -1097,7 +1008,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simSetObjectScale(self, object_name, scale_vector):
"""
Sets scale of an object in the world
@@ -1113,7 +1024,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simListSceneObjects(self, name_regex=".*"):
"""
Lists the objects present in the environment
@@ -1130,7 +1041,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simLoadLevel(self, level_name):
"""
Loads a level specified by its name
@@ -1145,7 +1056,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simListAssets(self):
"""
Lists all the assets present in the Asset Registry
@@ -1157,7 +1068,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simSpawnObject(
self,
object_name,
@@ -1192,7 +1103,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simDestroyObject(self, object_name):
"""Removes selected object from the world
@@ -1206,7 +1117,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simSetSegmentationObjectID(self, mesh_name, object_id, is_name_regex=False):
"""
Set segmentation ID for specific objects
@@ -1229,7 +1140,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simGetSegmentationObjectID(self, mesh_name):
"""
Returns Object ID for the given mesh name
@@ -1243,7 +1154,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simAddDetectionFilterMeshName(
self, camera_name, image_type, mesh_name, vehicle_name="", external=False
):
@@ -1271,7 +1182,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simSetDetectionFilterRadius(
self, camera_name, image_type, radius_cm, vehicle_name="", external=False
):
@@ -1296,7 +1207,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simClearDetectionMeshNames(
self, camera_name, image_type, vehicle_name="", external=False
):
@@ -1320,7 +1231,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simGetDetections(
self, camera_name, image_type, vehicle_name="", external=False
):
@@ -1345,7 +1256,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simPrintLogMessage(self, message, message_param="", severity=0):
"""
Prints the specified message in the simulator's window.
@@ -1365,7 +1276,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simGetCameraInfo(self, camera_name, vehicle_name="", external=False):
"""
Get details about the camera
@@ -1387,7 +1298,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simGetDistortionParams(self, camera_name, vehicle_name="", external=False):
"""
Get camera distortion parameters
@@ -1407,7 +1318,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simSetDistortionParams(
self, camera_name, distortion_params, vehicle_name="", external=False
):
@@ -1429,7 +1340,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simSetDistortionParam(
self, camera_name, param_name, value, vehicle_name="", external=False
):
@@ -1454,7 +1365,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simSetCameraPose(self, camera_name, pose, vehicle_name="", external=False):
"""
- Control the pose of a selected camera
@@ -1472,7 +1383,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simSetCameraFov(
self, camera_name, fov_degrees, vehicle_name="", external=False
):
@@ -1492,7 +1403,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simGetGroundTruthKinematics(self, vehicle_name=""):
"""
Get Ground truth kinematics of the vehicle
@@ -1512,7 +1423,7 @@ Source code for autonomysim.client
simGetGroundTruthKinematics.__annotations__ = {"return": KinematicsState}
-[docs]
+[docs]
def simSetKinematics(self, state, ignore_collision, vehicle_name=""):
"""
Set the kinematics state of the vehicle
@@ -1528,7 +1439,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simGetGroundTruthEnvironment(self, vehicle_name=""):
"""
Get ground truth environment state
@@ -1549,7 +1460,7 @@ Source code for autonomysim.client
# sensor APIs
-[docs]
+[docs]
def getImuData(self, imu_name="", vehicle_name=""):
"""
Args:
@@ -1565,7 +1476,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def getBarometerData(self, barometer_name="", vehicle_name=""):
"""
Args:
@@ -1581,7 +1492,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def getMagnetometerData(self, magnetometer_name="", vehicle_name=""):
"""
Args:
@@ -1597,7 +1508,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def getGpsData(self, gps_name="", vehicle_name=""):
"""
Args:
@@ -1613,7 +1524,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def getDistanceSensorData(self, distance_sensor_name="", vehicle_name=""):
"""
Args:
@@ -1631,7 +1542,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def getLidarData(self, lidar_name="", vehicle_name=""):
"""
Args:
@@ -1647,7 +1558,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simGetLidarSegmentation(self, lidar_name="", vehicle_name=""):
"""
NOTE: Deprecated API, use `getLidarData()` API instead
@@ -1668,7 +1579,7 @@ Source code for autonomysim.client
# Plotting APIs
-[docs]
+[docs]
def simFlushPersistentMarkers(self):
"""
Clear any persistent markers - those plotted with setting `is_persistent=True` in the APIs below
@@ -1677,7 +1588,7 @@ Source code for autonomysim.client
-[docs]
+[docs]
def simPlotPoints(
self,
points,
@@ -1702,7 +1613,7 @@ Source code for autonomysim.client