Corkyw10/docs fix typos links (#4243)
* Fixed typo in code snippet. Swapped order of altitude and azimuth * Fixed image links that needed '../' prefix to be visible on the live documentation * Removed reference to velocity being affected 2 frames after it is set * Updated Python API with missing 'set_pedestrians_cross_factor' method * Regenerated python_api.md
This commit is contained in:
Corinne
GitHub
parent
1aa7eccba7
commit
293dad7923
|
|
@ -99,15 +99,15 @@ be below `0.01666` and ideally below `0.01`.
|
|||
|
||||
To demonstrate the effect of optimal physical sub-stepping, consider the following graphs. The first graph shown below illustrates velocity over time in simulations with different fixed simulation time steps. The physical delta time is constant in all simulations at the default value of `0.01`. We can see that velocity is not affected by the difference in simulation time steps only.
|
||||
|
||||
>>>>>
|
||||
>>>>>
|
||||
|
||||
The second graph shows velocity over time in simulations with a fixed simulation time step of `0.04`. We can see that once the physical delta time surpasses `0.01`, deviations start to occur in the constancy of velocity, increasing in severity as physical delta time increases.
|
||||
|
||||
>>>>>
|
||||
>>>>>
|
||||
|
||||
We can demonstrate this deviation again by showing the effect of the same difference in physical delta time with a fixed simulation time step in the measurement of z-acceleration, with convergence occurring only when the physical delta time is `0.01` or less.
|
||||
|
||||
>>>>>
|
||||
>>>>>
|
||||
|
||||
---
|
||||
## Client-server synchrony
|
||||
|
|
|
|||
|
|
@ -105,17 +105,13 @@ Enables or disables the simulation of physics on this actor.
|
|||
- **Parameters:**
|
||||
- `enabled` (_bool_)
|
||||
- <a name="carla.Actor.set_target_angular_velocity"></a>**<font color="#7fb800">set_target_angular_velocity</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**angular_velocity**</font>)
|
||||
Sets the actor's angular velocity vector. The modification will be effective two frames after the setting. Also, this is applied before the physics step so the resulting angular velocity will be affected by external forces at this frame such as friction.
|
||||
Sets the actor's angular velocity vector. This is applied before the physics step so the resulting angular velocity will be affected by external forces such as friction.
|
||||
- **Parameters:**
|
||||
- `angular_velocity` (_[carla.Vector3D](#carla.Vector3D)<small> – deg/s</small>_)
|
||||
- **Note:** <font color="#8E8E8E">_The update will not be effective until two frames after it is set.
|
||||
_</font>
|
||||
- <a name="carla.Actor.set_target_velocity"></a>**<font color="#7fb800">set_target_velocity</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**velocity**</font>)
|
||||
Sets the actor's velocity vector. The modification will be effective two frames after the setting. Also, this is applied before the physics step so the resulting velocity will be affected by external forces at this frame such as friction.
|
||||
Sets the actor's velocity vector. This is applied before the physics step so the resulting angular velocity will be affected by external forces such as friction.
|
||||
- **Parameters:**
|
||||
- `velocity` (_[carla.Vector3D](#carla.Vector3D)_)
|
||||
- **Note:** <font color="#8E8E8E">_The update will not be effective until two frames after it is set.
|
||||
_</font>
|
||||
- <a name="carla.Actor.set_transform"></a>**<font color="#7fb800">set_transform</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**transform**</font>)
|
||||
Teleports the actor to a given transform (location and rotation).
|
||||
- **Parameters:**
|
||||
|
|
@ -3144,6 +3140,11 @@ Retrieves an object containing weather parameters currently active in the simula
|
|||
- **Setter:** _[carla.World.set_weather](#carla.World.set_weather)_
|
||||
|
||||
##### Setters
|
||||
- <a name="carla.World.set_pedestrians_cross_factor"></a>**<font color="#7fb800">set_pedestrians_cross_factor</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**percentage**</font>)
|
||||
- **Parameters:**
|
||||
- `percentage` (_float_) – Sets the percentage of pedestrians that can walk on the road or cross at any point on the road. Value should be between `0.0` and `1.0`. For example, a value of `0.1` would allow 10% of pedestrians to walk on the road. __Default is `0.0`__.
|
||||
- **Note:** <font color="#8E8E8E">_Should be set before pedestrians are spawned.
|
||||
_</font>
|
||||
- <a name="carla.World.set_weather"></a>**<font color="#7fb800">set_weather</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**weather**</font>)
|
||||
Changes the weather parameteres ruling the simulation to another ones defined in an object.
|
||||
- **Parameters:**
|
||||
|
|
|
|||
|
|
@ -337,7 +337,7 @@ The sensor creates a conic view that is translated to a 2D point map of the elem
|
|||
Points measured are contained in [carla.RadarMeasurement](python_api.md#carla.RadarMeasurement) as an array of [carla.RadarDetection](python_api.md#carla.RadarDetection), which specifies their polar coordinates, distance and velocity.
|
||||
This raw data provided by the radar sensor can be easily converted to a format manageable by __numpy__:
|
||||
```py
|
||||
# To get a numpy [[vel, altitude, azimuth, depth],...[,,,]]:
|
||||
# To get a numpy [[vel, azimuth, altitude, depth],...[,,,]]:
|
||||
points = np.frombuffer(radar_data.raw_data, dtype=np.dtype('f4'))
|
||||
points = np.reshape(points, (len(radar_data), 4))
|
||||
```
|
||||
|
|
|
|||
|
|
@ -181,9 +181,7 @@
|
|||
type: carla.Vector3D
|
||||
param_units: deg/s
|
||||
doc: >
|
||||
Sets the actor's angular velocity vector. The modification will be effective two frames after the setting. Also, this is applied before the physics step so the resulting angular velocity will be affected by external forces at this frame such as friction.
|
||||
note: >
|
||||
The update will not be effective until two frames after it is set.
|
||||
Sets the actor's angular velocity vector. This is applied before the physics step so the resulting angular velocity will be affected by external forces such as friction.
|
||||
# --------------------------------------
|
||||
- def_name: set_location
|
||||
params:
|
||||
|
|
@ -213,9 +211,7 @@
|
|||
- param_name: velocity
|
||||
type: carla.Vector3D
|
||||
doc: >
|
||||
Sets the actor's velocity vector. The modification will be effective two frames after the setting. Also, this is applied before the physics step so the resulting velocity will be affected by external forces at this frame such as friction.
|
||||
note: >
|
||||
The update will not be effective until two frames after it is set.
|
||||
Sets the actor's velocity vector. This is applied before the physics step so the resulting angular velocity will be affected by external forces such as friction.
|
||||
# --------------------------------------
|
||||
- def_name: __str__
|
||||
# --------------------------------------
|
||||
|
|
|
|||
|
|
@ -651,6 +651,15 @@
|
|||
If the layer is already unloaded the call has no effect.
|
||||
warning: This only affects "Opt" maps. The minimum layout includes roads, sidewalks, traffic lights and traffic signs.
|
||||
# --------------------------------------
|
||||
- def_name: set_pedestrians_cross_factor
|
||||
params:
|
||||
- param_name: percentage
|
||||
type: float
|
||||
doc: >
|
||||
Sets the percentage of pedestrians that can walk on the road or cross at any point on the road. Value should be between `0.0` and `1.0`. For example, a value of `0.1` would allow 10% of pedestrians to walk on the road. __Default is `0.0`__.
|
||||
note: >
|
||||
Should be set before pedestrians are spawned.
|
||||
# --------------------------------------
|
||||
- def_name: __str__
|
||||
return:
|
||||
string
|
||||
|
|
|
|||
Loading…
Reference in New Issue