LIRRA  1.0.0
Loading...
Searching...
No Matches
rl_stl.envs.patrol_plan.PatrolPlanEnv Class Reference

Public Member Functions

 __init__ (self, LevelTables T, PatrolPD nominal, np.ndarray track_weight, float gamma0, int|None n_cost, float effort_weight, np.ndarray obs_mean, np.ndarray obs_std, PlanEnvConfig cfg=PlanEnvConfig())
 
int observation_size (self)
 
int action_size (self)
 
 nominal_rollout (self, x0, idx)
 
 clock_reference (self, x0, idx, int length)
 
mjx_env.State reset (self, jax.Array rng)
 
mjx_env.State step (self, mjx_env.State state, jax.Array action)
 

Public Attributes

 T
 
 cfg
 
 obs_mean
 
 obs_std
 
 A
 
 B
 
 C
 
 cost_w
 
 track_w
 
 effort_w
 
 pos
 
 vel
 
 inp
 
 kp
 
 kd
 
 n_ax
 
 n_wp
 
 reg
 
 wps
 
 wp_tol
 
 leg_a
 
 leg_ab
 
 u_lo
 
 u_hi
 
 clock
 

Protected Member Functions

 _advance (self, x, idx)
 
 _u_nom (self, x, idx)
 
 _u_stop (self, x)
 
 _reference (self, s)
 
 _patrol_s (self, p)
 
 _waypoint_pass (self, p0, p1)
 
 _obs (self, s)
 
 _plan (self, s, action)
 

Detailed Description

Minimal Playground-compatible env (``reset``/``step``, ``observation_size``/``action_size``).

Constructor & Destructor Documentation

◆ __init__()

rl_stl.envs.patrol_plan.PatrolPlanEnv.__init__ (   self,
LevelTables  T,
PatrolPD  nominal,
np.ndarray  track_weight,
float  gamma0,
int | None  n_cost,
float  effort_weight,
np.ndarray  obs_mean,
np.ndarray  obs_std,
PlanEnvConfig   cfg = PlanEnvConfig() 
)

Member Function Documentation

◆ _advance()

rl_stl.envs.patrol_plan.PatrolPlanEnv._advance (   self,
  x,
  idx 
)
protected

◆ _obs()

rl_stl.envs.patrol_plan.PatrolPlanEnv._obs (   self,
  s 
)
protected

◆ _patrol_s()

rl_stl.envs.patrol_plan.PatrolPlanEnv._patrol_s (   self,
  p 
)
protected
Path parameter of ``p`` on the closed polyline through the waypoints, in ``[0, n_wp]``
(as :func:`rl_stl.evaluation.patrol._patrol_projection`).

◆ _plan()

rl_stl.envs.patrol_plan.PatrolPlanEnv._plan (   self,
  s,
  action 
)
protected

◆ _reference()

rl_stl.envs.patrol_plan.PatrolPlanEnv._reference (   self,
  s 
)
protected
``(x_nom (N+1, n), u_nom (N, m), waypoint index)`` for the plan rooted at ``s``.

◆ _u_nom()

rl_stl.envs.patrol_plan.PatrolPlanEnv._u_nom (   self,
  x,
  idx 
)
protected

◆ _u_stop()

rl_stl.envs.patrol_plan.PatrolPlanEnv._u_stop (   self,
  x 
)
protected
Stopping input past the end of the cached plan: damp the planar velocity, hold set-points.

◆ _waypoint_pass()

rl_stl.envs.patrol_plan.PatrolPlanEnv._waypoint_pass (   self,
  p0,
  p1 
)
protected
``(forward pass, backward pass, miss [m])`` of the step ``p0 -> p1`` across a waypoint
(at most one per step; the waypoint legs are much longer than one step).

◆ action_size()

int rl_stl.envs.patrol_plan.PatrolPlanEnv.action_size (   self)

◆ clock_reference()

rl_stl.envs.patrol_plan.PatrolPlanEnv.clock_reference (   self,
  x0,
  idx,
int  length 
)
Clock reference from the episode start: ``X (length+1, n)``, ``U (length, m)``, and the
waypoint index ``I (length,)`` used at each step (as :class:`ClockReference`).

◆ nominal_rollout()

rl_stl.envs.patrol_plan.PatrolPlanEnv.nominal_rollout (   self,
  x0,
  idx 
)

◆ observation_size()

int rl_stl.envs.patrol_plan.PatrolPlanEnv.observation_size (   self)

◆ reset()

mjx_env.State rl_stl.envs.patrol_plan.PatrolPlanEnv.reset (   self,
jax.Array  rng 
)

◆ step()

mjx_env.State rl_stl.envs.patrol_plan.PatrolPlanEnv.step (   self,
mjx_env.State  state,
jax.Array  action 
)

Member Data Documentation

◆ A

rl_stl.envs.patrol_plan.PatrolPlanEnv.A

◆ B

rl_stl.envs.patrol_plan.PatrolPlanEnv.B

◆ C

rl_stl.envs.patrol_plan.PatrolPlanEnv.C

◆ cfg

rl_stl.envs.patrol_plan.PatrolPlanEnv.cfg

◆ clock

rl_stl.envs.patrol_plan.PatrolPlanEnv.clock

◆ cost_w

rl_stl.envs.patrol_plan.PatrolPlanEnv.cost_w

◆ effort_w

rl_stl.envs.patrol_plan.PatrolPlanEnv.effort_w

◆ inp

rl_stl.envs.patrol_plan.PatrolPlanEnv.inp

◆ kd

rl_stl.envs.patrol_plan.PatrolPlanEnv.kd

◆ kp

rl_stl.envs.patrol_plan.PatrolPlanEnv.kp

◆ leg_a

rl_stl.envs.patrol_plan.PatrolPlanEnv.leg_a

◆ leg_ab

rl_stl.envs.patrol_plan.PatrolPlanEnv.leg_ab

◆ n_ax

rl_stl.envs.patrol_plan.PatrolPlanEnv.n_ax

◆ n_wp

rl_stl.envs.patrol_plan.PatrolPlanEnv.n_wp

◆ obs_mean

rl_stl.envs.patrol_plan.PatrolPlanEnv.obs_mean

◆ obs_std

rl_stl.envs.patrol_plan.PatrolPlanEnv.obs_std

◆ pos

rl_stl.envs.patrol_plan.PatrolPlanEnv.pos

◆ reg

rl_stl.envs.patrol_plan.PatrolPlanEnv.reg

◆ T

rl_stl.envs.patrol_plan.PatrolPlanEnv.T

◆ track_w

rl_stl.envs.patrol_plan.PatrolPlanEnv.track_w

◆ u_hi

rl_stl.envs.patrol_plan.PatrolPlanEnv.u_hi

◆ u_lo

rl_stl.envs.patrol_plan.PatrolPlanEnv.u_lo

◆ vel

rl_stl.envs.patrol_plan.PatrolPlanEnv.vel

◆ wp_tol

rl_stl.envs.patrol_plan.PatrolPlanEnv.wp_tol

◆ wps

rl_stl.envs.patrol_plan.PatrolPlanEnv.wps

The documentation for this class was generated from the following file: