pim/road-gen
1
0
Fork 0
mirror of https://github.com/pim-n/road-gen.git synced 2026-02-03 09:23:09 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation

Browse Source
This commit is contained in:
Pim Nelissen
2026-01-30 19:56:58 +01:00
parent 39625e4166
commit 371d0d1e75
1 changed files with 4 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
src/road_gen/generators/segmented_road_generator.py
View File

@ -42,11 +42,10 @@ class SegmentedRoadGenerator(BaseRoadGenerator):
alpha (float, optional): Dirichlet concentration parameter. A higher value leads to more uniform apportionment of the length amongst the segments, while a lower value allows more random apportionment. Defaults to 1.0. alpha (float, optional): Dirichlet concentration parameter. A higher value leads to more uniform apportionment of the length amongst the segments, while a lower value allows more random apportionment. Defaults to 1.0.
Raises: Raises:
ValueError: _description_ ValueError: "No valid radius for this turn segment" means a turn is too tight given its segment length and the velocity. To fix this, you can try to reduce the amount of segments or increase length. Increasing alpha (Dirichlet concentration parameter) can also help because this reduces the odds of very small lengths being assigned to turn segments.
ValueError: _description_
Returns: Returns:
np.ndarray: _description_ Tuple[np.ndarray, np.ndarray]: x and y coordinates of the waypoints describing the random road.
""" """
if not all(segment in prefabs.PREFABS.keys() for segment in segments): if not all(segment in prefabs.PREFABS.keys() for segment in segments):
raise ValueError(f"Invalid segment type provided. Available choices: {prefabs.SEGMENTS.keys()}") raise ValueError(f"Invalid segment type provided. Available choices: {prefabs.SEGMENTS.keys()}")