tbp.monty.simulators

• tbp.monty.simulators.habitat
  • tbp.monty.simulators.habitat.actions
    • SetAgentPitch
    • SetAgentPose
    • SetSensorPitch
    • SetSensorPose
    • SetSensorRotation
    • SetYaw
  • tbp.monty.simulators.habitat.actuator
    • HabitatActuator
      • HabitatActuator.action_name()
      • HabitatActuator.actuate_look_down()
      • HabitatActuator.actuate_look_up()
      • HabitatActuator.actuate_move_forward()
      • HabitatActuator.actuate_move_tangentially()
      • HabitatActuator.actuate_orient_horizontal()
      • HabitatActuator.actuate_orient_vertical()
      • HabitatActuator.actuate_set_agent_pitch()
      • HabitatActuator.actuate_set_agent_pose()
      • HabitatActuator.actuate_set_sensor_pitch()
      • HabitatActuator.actuate_set_sensor_pose()
      • HabitatActuator.actuate_set_sensor_rotation()
      • HabitatActuator.actuate_set_yaw()
      • HabitatActuator.actuate_turn_left()
      • HabitatActuator.actuate_turn_right()
      • HabitatActuator.to_habitat()
    • HabitatActuatorRequirements
      • HabitatActuatorRequirements.__init__()
      • HabitatActuatorRequirements.get_agent()
  • tbp.monty.simulators.habitat.agents
    • HabitatAgent
      • HabitatAgent.agent_id
      • HabitatAgent.position
      • HabitatAgent.rotation
      • HabitatAgent.height
      • HabitatAgent.__init__()
      • HabitatAgent.get_spec()
      • HabitatAgent.initialize()
      • HabitatAgent.process_observations()
    • MultiSensorAgent
      • MultiSensorAgent.agent_id
      • MultiSensorAgent.sensor_ids
      • MultiSensorAgent.resolutions
      • MultiSensorAgent.positions
      • MultiSensorAgent.rotations
      • MultiSensorAgent.zooms
      • MultiSensorAgent.semantics
      • MultiSensorAgent.height
      • MultiSensorAgent.rotation_step
      • MultiSensorAgent.translation_step
      • MultiSensorAgent.action_space_type
      • MultiSensorAgent.__init__()
      • MultiSensorAgent.get_spec()
      • MultiSensorAgent.initialize()
    • SingleSensorAgent
      • SingleSensorAgent.__init__()
      • SingleSensorAgent.get_spec()
      • SingleSensorAgent.initialize()
  • tbp.monty.simulators.habitat.environment
    • AgentConfig
      • AgentConfig.__init__()
      • AgentConfig.agent_args
      • AgentConfig.agent_type
    • HabitatEnvironment
      • HabitatEnvironment.agents
      • HabitatEnvironment.objects
      • HabitatEnvironment.scene_id
      • HabitatEnvironment.seed
      • HabitatEnvironment.data_path
      • HabitatEnvironment.__init__()
      • HabitatEnvironment.add_object()
      • HabitatEnvironment.close()
      • HabitatEnvironment.remove_all_objects()
      • HabitatEnvironment.reset()
      • HabitatEnvironment.step()
    • MultiSensorAgentArgs
      • MultiSensorAgentArgs.__init__()
      • MultiSensorAgentArgs.action_space_type
      • MultiSensorAgentArgs.agent_id
      • MultiSensorAgentArgs.height
      • MultiSensorAgentArgs.position
      • MultiSensorAgentArgs.positions
      • MultiSensorAgentArgs.resolutions
      • MultiSensorAgentArgs.rotation
      • MultiSensorAgentArgs.rotation_step
      • MultiSensorAgentArgs.rotations
      • MultiSensorAgentArgs.semantics
      • MultiSensorAgentArgs.sensor_ids
      • MultiSensorAgentArgs.translation_step
      • MultiSensorAgentArgs.zooms
    • ObjectConfig
      • ObjectConfig.__init__()
      • ObjectConfig.name
      • ObjectConfig.position
      • ObjectConfig.primary_target_object
      • ObjectConfig.rotation
      • ObjectConfig.scale
      • ObjectConfig.semantic_id
    • SingleSensorAgentArgs
      • SingleSensorAgentArgs.__init__()
      • SingleSensorAgentArgs.action_space_type
      • SingleSensorAgentArgs.agent_id
      • SingleSensorAgentArgs.agent_position
      • SingleSensorAgentArgs.height
      • SingleSensorAgentArgs.resolution
      • SingleSensorAgentArgs.rotation
      • SingleSensorAgentArgs.rotation_step
      • SingleSensorAgentArgs.semantic
      • SingleSensorAgentArgs.sensor_id
      • SingleSensorAgentArgs.sensor_position
      • SingleSensorAgentArgs.translation_step
      • SingleSensorAgentArgs.zoom
  • tbp.monty.simulators.habitat.sensors
    • RGBDSensorConfig
      • RGBDSensorConfig.sensor_id
      • RGBDSensorConfig.resolution
      • RGBDSensorConfig.position
      • RGBDSensorConfig.rotation
      • RGBDSensorConfig.zoom
      • RGBDSensorConfig.__init__()
      • RGBDSensorConfig.get_specs()
      • RGBDSensorConfig.resolution
      • RGBDSensorConfig.zoom
    • SemanticSensorConfig
      • SemanticSensorConfig.sensor_id
      • SemanticSensorConfig.resolution
      • SemanticSensorConfig.position
      • SemanticSensorConfig.rotation
      • SemanticSensorConfig.zoom
      • SemanticSensorConfig.__init__()
      • SemanticSensorConfig.get_specs()
      • SemanticSensorConfig.resolution
      • SemanticSensorConfig.zoom
    • SensorConfig
      • SensorConfig.sensor_id
      • SensorConfig.position
      • SensorConfig.rotation
      • SensorConfig.__init__()
      • SensorConfig.get_specs()
      • SensorConfig.process_observations()
      • SensorConfig.position
      • SensorConfig.rotation
      • SensorConfig.sensor_id
  • tbp.monty.simulators.habitat.simulator
    • HabitatSim
      • HabitatSim.agents
      • HabitatSim.data_path
      • HabitatSim.scene_id
      • HabitatSim.seed
      • HabitatSim.__init__()
      • HabitatSim.add_object()
      • HabitatSim.check_viewpoint_collision()
      • HabitatSim.close()
      • HabitatSim.find_non_colliding_positions()
      • HabitatSim.get_agent()
      • HabitatSim.initialize_agent()
      • HabitatSim.non_conflicting_vector()
      • HabitatSim.process_observations()
      • HabitatSim.remove_all_objects()
      • HabitatSim.reset()
      • HabitatSim.step()
      • HabitatSim.action_space
      • HabitatSim.num_objects
      • HabitatSim.observations
      • HabitatSim.states
    • PRIMITIVE_OBJECT_TYPES
• tbp.monty.simulators.mujoco
  • tbp.monty.simulators.mujoco.simulator
• tbp.monty.simulators.resources
  • tbp.monty.simulators.resources.tacto
• tbp.monty.simulators.tacto
  • tbp.monty.simulators.tacto.agents
    • TactoFingerAgent
      • TactoFingerAgent.agent_id
      • TactoFingerAgent.position
      • TactoFingerAgent.rotation
      • TactoFingerAgent.height
      • TactoFingerAgent.rotation_step
      • TactoFingerAgent.translation_step
      • TactoFingerAgent.config
      • TactoFingerAgent.__init__()
      • TactoFingerAgent.get_spec()
  • tbp.monty.simulators.tacto.config
    • TactoSensorSpec
      • TactoSensorSpec.name
      • TactoSensorSpec.camera
      • TactoSensorSpec.gel
      • TactoSensorSpec.lights
      • TactoSensorSpec.noise
      • TactoSensorSpec.force
      • TactoSensorSpec.__init__()
      • TactoSensorSpec.from_yaml()
      • TactoSensorSpec.camera
      • TactoSensorSpec.force
      • TactoSensorSpec.gel
      • TactoSensorSpec.lights
      • TactoSensorSpec.name
      • TactoSensorSpec.noise
  • tbp.monty.simulators.tacto.sensors
    • TactoSensor
      • TactoSensor.sensor_id
      • TactoSensor.resolution
      • TactoSensor.position
      • TactoSensor.rotation
      • TactoSensor.config
      • TactoSensor.__init__()
      • TactoSensor.get_specs()
      • TactoSensor.process_observations()
      • TactoSensor.config
      • TactoSensor.resolution

tbp.monty.simulators.simulator

class Simulator(*args, **kwargs)

Bases: Protocol

A Protocol defining a simulator for use in simulated environments.

A Simulator is responsible for a simulated environment that contains objects to interact with, agents to do the interacting, and for collecting observations and proprioceptive state to send to Monty.

__init__(*args, **kwargs)

add_object(name: str, position: VectorXYZ = (0.0, 0.0, 0.0), rotation: QuaternionWXYZ = (1.0, 0.0, 0.0, 0.0), scale: VectorXYZ = (1.0, 1.0, 1.0), semantic_id: SemanticID | None = None, primary_target_object: ObjectID | None = None) → ObjectInfo

Add new object to simulated environment.

Adds a new object based on the named object. This assumes that the set of available objects are preloaded and keyed by name.

Parameters:

• name (str) – Registered object name.

• position (VectorXYZ) – Initial absolute position of the object.

• rotation (QuaternionWXYZ) – Initial orientation of the object.

• scale (VectorXYZ) – Initial object scale.

• semantic_id (SemanticID | None) – Optional override for the object’s semantic ID.

• primary_target_object (ObjectID | None) – ID of the primary target object. If not None, the added object will be positioned so that it does not obscure the initial view of the primary target object (which avoiding collision alone cannot guarantee). Used when adding multiple objects. Defaults to None.

Return type:

ObjectInfo

Returns:

The added object’s information.

close() → None

Close any resources used by the simulator.

Return type:

None

remove_all_objects() → None

Remove all objects from the simulated environment.

Return type:

None

reset() → tuple[Observations, ProprioceptiveState]

Reset the simulator.

Returns:

The initial observations from the simulator and proprioceptive state.

step(actions: Sequence[Action]) → tuple[Observations, ProprioceptiveState]

Execute the given actions in the environment.

Parameters:

actions – The actions to execute.

Returns:

The observations from the simulator and proprioceptive state.

Note

If the actions are an empty sequence, the current observations are returned.