Monty.Frameworks.Environments.PositioningProcedures.GetGoodViewFactory (ExTbpMonty.Core v0.1.0)

Builds a GetGoodView for whichever object an episode is about.

Mirrors tbp/monty/frameworks/environments/positioning_procedures.py::GetGoodViewFactory. The target's semantic id is not known until the scene is built, so a config can only describe the procedure's settings here and ask for the procedure later.

The defaults are Monty's own: half the view, or three centimetres away.

Summary

Types

t()

Functions

create(factory, target_semantic_id)

A procedure for target_semantic_id, as the module and state a behaviour is called through.

from_config(config)

The factory a composed config entry describes, or why it is not one this port can build.

new(options)

A factory for :agent_id's procedure, with Monty's defaults for the rest.

Types

t()

@type t() :: %Monty.Frameworks.Environments.PositioningProcedures.GetGoodViewFactory{
  agent_id: atom() | String.t(),
  allow_translation: boolean(),
  good_view_distance: float(),
  good_view_percentage: float(),
  max_orientation_attempts: integer(),
  multiple_objects_present: boolean(),
  sensor_id: atom() | String.t()
}

Functions

create(factory, target_semantic_id)

A procedure for target_semantic_id, as the module and state a behaviour is called through.

{module, state} is how this port carries every behaviour implementation: a struct says what a procedure is, and the module named after it is what knows how to run it.

from_config(config)

@spec from_config(map()) :: {:ok, t()} | {:error, term()}

The factory a composed config entry describes, or why it is not one this port can build.

Every shipped evaluation config lists two of these: a view finder allowed to walk towards the object, and a patch camera that may only turn — allow_translation: false — because by then the body is where it should be and only the aim is wrong.

new(options)

@spec new(keyword()) :: t()

A factory for :agent_id's procedure, with Monty's defaults for the rest.