Skip to content

sensors

create_sensor(sensor_type, relative_prim_path, name, modalities='all', enabled=True, sensor_kwargs=None, noise_type=None, noise_kwargs=None)

Create a sensor of type @sensor_type with optional keyword args @sensor_kwargs that should be passed to the constructor. Also, additionally send noise of type @noise_type with corresponding keyword args @noise_kwargs that should be passed to the noise constructor.

Parameters:

Name Type Description Default
sensor_type str

Type of sensor to create. Should be either one of SENSOR_PRIM_TO_SENSOR.keys() or one of REGISTERED_SENSORS (i.e.: the string name of the desired class to create)

 required
relative_prim_path str

Scene-local prim path of the Sensor to encapsulate or create.

 required
name str

Name for the sensor. Names need to be unique per scene.

 required
modalities str or list of str

Modality(s) supported by this sensor. Valid options are part of sensor.all_modalities. Default is "all", which corresponds to all modalities being used

 'all'
enabled bool

Whether this sensor should be enabled or not

 True
sensor_kwargs dict

Any keyword kwargs to pass to the constructor

 None
noise_type str

Type of sensor to create. Should be one of REGISTERED_SENSOR_NOISES (i.e.: the string name of the desired class to create)

 None
noise_kwargs dict

Any keyword kwargs to pass to the constructor

 None

Returns:

Type Description
BaseSensor

Created sensor with specified params
Source code in omnigibson/sensors/__init__.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
def create_sensor(
    sensor_type,
    relative_prim_path,
    name,
    modalities="all",
    enabled=True,
    sensor_kwargs=None,
    noise_type=None,
    noise_kwargs=None,
):
    """
    Create a sensor of type @sensor_type with optional keyword args @sensor_kwargs that should be passed to the
    constructor. Also, additionally send noise of type @noise_type with corresponding keyword args @noise_kwargs
    that should be passed to the noise constructor.

    Args:
        sensor_type (str): Type of sensor to create. Should be either one of SENSOR_PRIM_TO_SENSOR.keys() or
            one of REGISTERED_SENSORS (i.e.: the string name of the desired class to create)
        relative_prim_path (str): Scene-local prim path of the Sensor to encapsulate or create.
        name (str): Name for the sensor. Names need to be unique per scene.
        modalities (str or list of str): Modality(s) supported by this sensor. Valid options are part of
            sensor.all_modalities. Default is "all", which corresponds to all modalities being used
        enabled (bool): Whether this sensor should be enabled or not
        sensor_kwargs (dict): Any keyword kwargs to pass to the constructor
        noise_type (str): Type of sensor to create. Should be one of REGISTERED_SENSOR_NOISES
            (i.e.: the string name of the desired class to create)
        noise_kwargs (dict): Any keyword kwargs to pass to the constructor

    Returns:
        BaseSensor: Created sensor with specified params
    """
    # Run basic sanity check
    assert isinstance(sensor_type, str), "Inputted sensor_type must be a string!"

    # Grab the requested sensor class
    if sensor_type in SENSOR_PRIMS_TO_SENSOR_CLS:
        sensor_cls = SENSOR_PRIMS_TO_SENSOR_CLS[sensor_type]
    elif sensor_type in REGISTERED_SENSORS:
        sensor_cls = REGISTERED_SENSORS[sensor_type]
    else:
        # This is an error, we didn't find the requested sensor ):
        raise ValueError(f"No sensor found with corresponding sensor_type: {sensor_type}")

    # Create the noise, and sanity check to make sure it's a valid type
    noise = None
    if noise_type is not None:
        assert_valid_key(key=noise_type, valid_keys=REGISTERED_SENSOR_NOISES, name="sensor noise type")
        noise_kwargs = dict() if noise_kwargs is None else noise_kwargs
        noise = REGISTERED_SENSOR_NOISES[noise_type](**noise_kwargs)

    # Create the sensor
    sensor_kwargs = dict() if sensor_kwargs is None else sensor_kwargs
    sensor = sensor_cls(
        relative_prim_path=relative_prim_path,
        name=name,
        modalities=modalities,
        enabled=enabled,
        noise=noise,
        **sensor_kwargs,
    )

    return sensor