smarts.env.gymnasium.wrappers.metric.params module

class smarts.env.gymnasium.wrappers.metric.params.Collisions(active: bool = False)[source]

Parameters for collisions cost function.

active: bool = False

If True, enables computation of corresponding cost function. Else, disabled.

class smarts.env.gymnasium.wrappers.metric.params.Comfort(active: bool = False)[source]

Parameters for comfort cost function.

active: bool = False

If True, enables computation of corresponding cost function. Else, disabled.

class smarts.env.gymnasium.wrappers.metric.params.DistToDestination(active: bool = True)[source]

Parameters for distance to destination cost function.

active: bool = True

If True, enables computation of corresponding cost function. Else, disabled.

class smarts.env.gymnasium.wrappers.metric.params.DistToObstacles(active: bool = True, ignore: ~typing.List[str] = <factory>)[source]

Parameters for distance to obstacles cost function.

active: bool = True

If True, enables computation of corresponding cost function. Else, disabled.

ignore: List[str]

Vehicle id of neighbors to be excluded from being considered as an obstacle.

class smarts.env.gymnasium.wrappers.metric.params.JerkLinear(active: bool = True)[source]

Parameters for jerk linear cost function.

active: bool = True

If True, enables computation of corresponding cost function. Else, disabled.

class smarts.env.gymnasium.wrappers.metric.params.LaneCenterOffset(active: bool = True)[source]

Parameters for lane center offset cost function.

active: bool = True

If True, enables computation of corresponding cost function. Else, disabled.

class smarts.env.gymnasium.wrappers.metric.params.OffRoad(active: bool = False)[source]

Parameters for off road cost function.

active: bool = False

If True, enables computation of corresponding cost function. Else, disabled.

class smarts.env.gymnasium.wrappers.metric.params.Params(collisions: Collisions = Collisions(active=False), comfort: Comfort = Comfort(active=False), dist_to_destination: DistToDestination = DistToDestination(active=True), dist_to_obstacles: DistToObstacles = DistToObstacles(active=True, ignore=[]), jerk_linear: JerkLinear = JerkLinear(active=True), lane_center_offset: LaneCenterOffset = LaneCenterOffset(active=True), off_road: OffRoad = OffRoad(active=False), speed_limit: SpeedLimit = SpeedLimit(active=True), steps: Steps = Steps(active=True), vehicle_gap: VehicleGap = VehicleGap(active=False, actor=''), wrong_way: WrongWay = WrongWay(active=True))[source]

Parameters for cost functions.

collisions: Collisions = Collisions(active=False)
comfort: Comfort = Comfort(active=False)
dist_to_destination: DistToDestination = DistToDestination(active=True)
dist_to_obstacles: DistToObstacles = DistToObstacles(active=True, ignore=[])
jerk_linear: JerkLinear = JerkLinear(active=True)
lane_center_offset: LaneCenterOffset = LaneCenterOffset(active=True)
off_road: OffRoad = OffRoad(active=False)
speed_limit: SpeedLimit = SpeedLimit(active=True)
steps: Steps = Steps(active=True)
vehicle_gap: VehicleGap = VehicleGap(active=False, actor='')
wrong_way: WrongWay = WrongWay(active=True)
class smarts.env.gymnasium.wrappers.metric.params.SpeedLimit(active: bool = True)[source]

Parameters for speed limit cost function.

active: bool = True

If True, enables computation of corresponding cost function. Else, disabled.

class smarts.env.gymnasium.wrappers.metric.params.Steps(active: bool = True)[source]

Parameters for steps cost function.

active: bool = True

If True, enables computation of corresponding cost function. Else, disabled.

class smarts.env.gymnasium.wrappers.metric.params.VehicleGap(active: bool = False, actor: str = '')[source]

Parameters for gap between vehicles cost function.

active: bool = False

If True, enables computation of corresponding cost function. Else, disabled.

actor: str = ''

Gap between ego and the specified actor is computed.

class smarts.env.gymnasium.wrappers.metric.params.WrongWay(active: bool = True)[source]

Parameters for wrong way cost function.

active: bool = True

If True, enables computation of corresponding cost function. Else, disabled.