Skip to content

interactive_traversable_scene

InteractiveTraversableScene

Bases: TraversableScene

Create an interactive scene defined from a scene json file. In general, this supports curated, pre-defined scene layouts with annotated objects. This adds semantic support via a segmentation map generated for this specific scene.

Source code in omnigibson/scenes/interactive_traversable_scene.py 
 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
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
class InteractiveTraversableScene(TraversableScene):
    """
    Create an interactive scene defined from a scene json file.
    In general, this supports curated, pre-defined scene layouts with annotated objects.
    This adds semantic support via a segmentation map generated for this specific scene.
    """

    def __init__(
        self,
        scene_model,
        scene_instance=None,
        scene_file=None,
        trav_map_resolution=0.1,
        default_erosion_radius=0.0,
        trav_map_with_objects=True,
        num_waypoints=10,
        waypoint_resolution=0.2,
        load_object_categories=None,
        not_load_object_categories=None,
        load_room_types=None,
        load_room_instances=None,
        load_task_relevant_only=False,
        seg_map_resolution=0.1,
        include_robots=True,
    ):
        """
        Args:
            scene_model (str): Scene model name, e.g.: Rs_int
            scene_instance (None or str): name of json file to load (without .json); if None,
                defaults to og_dataset/scenes/<scene_model>/json/<scene_instance>.urdf
            scene_file (None or str): If specified, full path of JSON file to load (with .json).
                This will override scene_instance and scene_model!
            trav_map_resolution (float): traversability map resolution
            default_erosion_radius (float): default map erosion radius in meters
            trav_map_with_objects (bool): whether to use objects or not when constructing graph
            num_waypoints (int): number of way points returned
            waypoint_resolution (float): resolution of adjacent way points
            load_object_categories (None or list): if specified, only load these object categories into the scene
            not_load_object_categories (None or list): if specified, do not load these object categories into the scene
            load_room_types (None or list): only load objects in these room types into the scene
            load_room_instances (None or list): if specified, only load objects in these room instances into the scene
            load_task_relevant_only (bool): Whether only task relevant objects (and building structure) should be loaded
            seg_map_resolution (float): room segmentation map resolution
            include_robots (bool): whether to also include the robot(s) defined in the scene
        """

        # Store attributes from inputs
        self.include_robots = include_robots

        # Infer scene directory
        self.scene_dir = get_og_scene_path(scene_model)

        # Other values that will be loaded at runtime
        self.load_object_categories = None
        self.not_load_object_categories = None
        self.load_room_instances = None
        self.load_task_relevant_only = load_task_relevant_only

        # Get scene information
        if scene_file is None:
            scene_file = self.get_scene_loading_info(
                scene_model=scene_model,
                scene_instance=scene_instance,
            )

        # Load room semantic and instance segmentation map (must occur AFTER inferring scene directory)
        self._seg_map = SegmentationMap(scene_dir=self.scene_dir, map_resolution=seg_map_resolution)

        # Decide which room(s) and object categories to load
        self.filter_rooms_and_object_categories(
            load_object_categories, not_load_object_categories, load_room_types, load_room_instances
        )

        # Assert that the floor plane is not enabled
        assert not og.sim.floor_plane, "Floor plane should not be enabled for interactive scenes!"

        # Run super init first
        super().__init__(
            scene_model=scene_model,
            scene_file=scene_file,
            trav_map_resolution=trav_map_resolution,
            default_erosion_radius=default_erosion_radius,
            trav_map_with_objects=trav_map_with_objects,
            num_waypoints=num_waypoints,
            waypoint_resolution=waypoint_resolution,
            use_floor_plane=False,
        )

    def get_scene_loading_info(self, scene_model, scene_instance=None):
        """
        Gets scene loading info to know what single USD file to load, specified indirectly via @scene_instance if it
        is specified, otherwise, will grab the "best" scene file to load.

        Args:
            scene_model (str): Name of the scene to load, e.g, Rs_int, etc.
            scene_instance (None or str): If specified, should be name of json file to load. (without .json), default to
                og_dataset/scenes/<scene_model>/json/<scene_instance>.json

        Returns:
            str: Absolute path to the desired scene file (.json) to load
        """
        # Infer scene file from model and directory
        fname = "{}_best".format(scene_model) if scene_instance is None else scene_instance
        return os.path.join(self.scene_dir, "json", "{}.json".format(fname))

    def filter_rooms_and_object_categories(
        self, load_object_categories, not_load_object_categories, load_room_types, load_room_instances
    ):
        """
        Handle partial scene loading based on object categories, room types or room instances

        Args:
            load_object_categories (None or list): if specified, only load these object categories into the scene
            not_load_object_categories (None or list): if specified, do not load these object categories into the scene
            load_room_types (None or list): only load objects in these room types into the scene
            load_room_instances (None or list): if specified, only load objects in these room instances into the scene
        """
        self.load_object_categories = (
            [load_object_categories] if isinstance(load_object_categories, str) else load_object_categories
        )

        self.not_load_object_categories = (
            [not_load_object_categories] if isinstance(not_load_object_categories, str) else not_load_object_categories
        )

        if load_room_instances is not None:
            if isinstance(load_room_instances, str):
                load_room_instances = [load_room_instances]
            load_room_instances_filtered = []
            for room_instance in load_room_instances:
                if room_instance not in self._seg_map.room_ins_name_to_ins_id:
                    log.warning("room_instance [{}] does not exist.".format(room_instance))
                load_room_instances_filtered.append(room_instance)
            self.load_room_instances = load_room_instances_filtered
        elif load_room_types is not None:
            if isinstance(load_room_types, str):
                load_room_types = [load_room_types]
            load_room_instances_filtered = []
            for room_type in load_room_types:
                if room_type in self._seg_map.room_sem_name_to_ins_name:
                    load_room_instances_filtered.extend(self._seg_map.room_sem_name_to_ins_name[room_type])
                else:
                    log.warning("room_type [{}] does not exist.".format(room_type))
            self.load_room_instances = load_room_instances_filtered
        else:
            self.load_room_instances = None

    def _load(self):
        # Load the traversability map if we have the connectivity graph
        maps_path = os.path.join(self.scene_dir, "layout")
        self._trav_map.load_map(maps_path)

    def _should_load_object(self, obj_info, task_metadata):
        name = obj_info["args"]["name"]
        category = obj_info["args"].get("category", "object")
        in_rooms = obj_info["args"].get("in_rooms", None)

        if isinstance(in_rooms, str):
            assert "," not in in_rooms
        in_rooms = [in_rooms] if isinstance(in_rooms, str) else in_rooms

        # Do not load these object categories (can blacklist building structures as well)
        not_blacklisted = self.not_load_object_categories is None or category not in self.not_load_object_categories

        # Only load these object categories (no need to white list building structures)
        task_relevant_names = set(task_metadata["inst_to_name"].values()) if "inst_to_name" in task_metadata else set()
        is_task_relevant = name in task_relevant_names or category in STRUCTURE_CATEGORIES
        whitelisted = (
            # Either no whitelisting-only mode is on
            (self.load_object_categories is None and not self.load_task_relevant_only)
            or
            # Or the object is in the whitelist
            (self.load_object_categories is not None and category in self.load_object_categories)
            or
            # Or it's in the task relevant list
            (self.load_task_relevant_only and is_task_relevant)
        )

        # This object is not located in one of the selected rooms, skip
        valid_room = self.load_room_instances is None or len(set(self.load_room_instances) & set(in_rooms)) > 0

        # Check whether this is an agent and we allow agents
        agent_ok = self.include_robots or obj_info["class_name"] not in REGISTERED_ROBOTS

        # We only load this model if all the above conditions are met
        return not_blacklisted and whitelisted and valid_room and agent_ok

    @property
    def seg_map(self):
        """
        Returns:
            SegmentationMap: Map for segmenting this scene
        """
        return self._seg_map

    @classmethod
    def modify_init_info_for_restoring(cls, init_info):
        # Run super first
        super().modify_init_info_for_restoring(init_info=init_info)

        # We also make sure we load in any robots, and also pop any filters that were stored
        init_info["args"]["include_robots"] = True
        init_info["args"]["load_object_categories"] = None
        init_info["args"]["not_load_object_categories"] = None
        init_info["args"]["load_room_types"] = None
        init_info["args"]["load_room_instances"] = None

seg_map property

Returns:

Type Description
SegmentationMap

Map for segmenting this scene

__init__(scene_model, scene_instance=None, scene_file=None, trav_map_resolution=0.1, default_erosion_radius=0.0, trav_map_with_objects=True, num_waypoints=10, waypoint_resolution=0.2, load_object_categories=None, not_load_object_categories=None, load_room_types=None, load_room_instances=None, load_task_relevant_only=False, seg_map_resolution=0.1, include_robots=True)

Parameters:

Name Type Description Default
scene_model str

Scene model name, e.g.: Rs_int

 required
scene_instance None or str

name of json file to load (without .json); if None, defaults to og_dataset/scenes//json/.urdf

 None
scene_file None or str

If specified, full path of JSON file to load (with .json). This will override scene_instance and scene_model!

 None
trav_map_resolution float

traversability map resolution

 0.1
default_erosion_radius float

default map erosion radius in meters

 0.0
trav_map_with_objects bool

whether to use objects or not when constructing graph

 True
num_waypoints int

number of way points returned

 10
waypoint_resolution float

resolution of adjacent way points

 0.2
load_object_categories None or list

if specified, only load these object categories into the scene

 None
not_load_object_categories None or list

if specified, do not load these object categories into the scene

 None
load_room_types None or list

only load objects in these room types into the scene

 None
load_room_instances None or list

if specified, only load objects in these room instances into the scene

 None
load_task_relevant_only bool

Whether only task relevant objects (and building structure) should be loaded

 False
seg_map_resolution float

room segmentation map resolution

 0.1
include_robots bool

whether to also include the robot(s) defined in the scene

 True
Source code in omnigibson/scenes/interactive_traversable_scene.py 
 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
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
def __init__(
    self,
    scene_model,
    scene_instance=None,
    scene_file=None,
    trav_map_resolution=0.1,
    default_erosion_radius=0.0,
    trav_map_with_objects=True,
    num_waypoints=10,
    waypoint_resolution=0.2,
    load_object_categories=None,
    not_load_object_categories=None,
    load_room_types=None,
    load_room_instances=None,
    load_task_relevant_only=False,
    seg_map_resolution=0.1,
    include_robots=True,
):
    """
    Args:
        scene_model (str): Scene model name, e.g.: Rs_int
        scene_instance (None or str): name of json file to load (without .json); if None,
            defaults to og_dataset/scenes/<scene_model>/json/<scene_instance>.urdf
        scene_file (None or str): If specified, full path of JSON file to load (with .json).
            This will override scene_instance and scene_model!
        trav_map_resolution (float): traversability map resolution
        default_erosion_radius (float): default map erosion radius in meters
        trav_map_with_objects (bool): whether to use objects or not when constructing graph
        num_waypoints (int): number of way points returned
        waypoint_resolution (float): resolution of adjacent way points
        load_object_categories (None or list): if specified, only load these object categories into the scene
        not_load_object_categories (None or list): if specified, do not load these object categories into the scene
        load_room_types (None or list): only load objects in these room types into the scene
        load_room_instances (None or list): if specified, only load objects in these room instances into the scene
        load_task_relevant_only (bool): Whether only task relevant objects (and building structure) should be loaded
        seg_map_resolution (float): room segmentation map resolution
        include_robots (bool): whether to also include the robot(s) defined in the scene
    """

    # Store attributes from inputs
    self.include_robots = include_robots

    # Infer scene directory
    self.scene_dir = get_og_scene_path(scene_model)

    # Other values that will be loaded at runtime
    self.load_object_categories = None
    self.not_load_object_categories = None
    self.load_room_instances = None
    self.load_task_relevant_only = load_task_relevant_only

    # Get scene information
    if scene_file is None:
        scene_file = self.get_scene_loading_info(
            scene_model=scene_model,
            scene_instance=scene_instance,
        )

    # Load room semantic and instance segmentation map (must occur AFTER inferring scene directory)
    self._seg_map = SegmentationMap(scene_dir=self.scene_dir, map_resolution=seg_map_resolution)

    # Decide which room(s) and object categories to load
    self.filter_rooms_and_object_categories(
        load_object_categories, not_load_object_categories, load_room_types, load_room_instances
    )

    # Assert that the floor plane is not enabled
    assert not og.sim.floor_plane, "Floor plane should not be enabled for interactive scenes!"

    # Run super init first
    super().__init__(
        scene_model=scene_model,
        scene_file=scene_file,
        trav_map_resolution=trav_map_resolution,
        default_erosion_radius=default_erosion_radius,
        trav_map_with_objects=trav_map_with_objects,
        num_waypoints=num_waypoints,
        waypoint_resolution=waypoint_resolution,
        use_floor_plane=False,
    )

filter_rooms_and_object_categories(load_object_categories, not_load_object_categories, load_room_types, load_room_instances)

Handle partial scene loading based on object categories, room types or room instances

Parameters:

Name Type Description Default
load_object_categories None or list

if specified, only load these object categories into the scene

 required
not_load_object_categories None or list

if specified, do not load these object categories into the scene

 required
load_room_types None or list

only load objects in these room types into the scene

 required
load_room_instances None or list

if specified, only load objects in these room instances into the scene

 required
Source code in omnigibson/scenes/interactive_traversable_scene.py 
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
def filter_rooms_and_object_categories(
    self, load_object_categories, not_load_object_categories, load_room_types, load_room_instances
):
    """
    Handle partial scene loading based on object categories, room types or room instances

    Args:
        load_object_categories (None or list): if specified, only load these object categories into the scene
        not_load_object_categories (None or list): if specified, do not load these object categories into the scene
        load_room_types (None or list): only load objects in these room types into the scene
        load_room_instances (None or list): if specified, only load objects in these room instances into the scene
    """
    self.load_object_categories = (
        [load_object_categories] if isinstance(load_object_categories, str) else load_object_categories
    )

    self.not_load_object_categories = (
        [not_load_object_categories] if isinstance(not_load_object_categories, str) else not_load_object_categories
    )

    if load_room_instances is not None:
        if isinstance(load_room_instances, str):
            load_room_instances = [load_room_instances]
        load_room_instances_filtered = []
        for room_instance in load_room_instances:
            if room_instance not in self._seg_map.room_ins_name_to_ins_id:
                log.warning("room_instance [{}] does not exist.".format(room_instance))
            load_room_instances_filtered.append(room_instance)
        self.load_room_instances = load_room_instances_filtered
    elif load_room_types is not None:
        if isinstance(load_room_types, str):
            load_room_types = [load_room_types]
        load_room_instances_filtered = []
        for room_type in load_room_types:
            if room_type in self._seg_map.room_sem_name_to_ins_name:
                load_room_instances_filtered.extend(self._seg_map.room_sem_name_to_ins_name[room_type])
            else:
                log.warning("room_type [{}] does not exist.".format(room_type))
        self.load_room_instances = load_room_instances_filtered
    else:
        self.load_room_instances = None

get_scene_loading_info(scene_model, scene_instance=None)

Gets scene loading info to know what single USD file to load, specified indirectly via @scene_instance if it is specified, otherwise, will grab the "best" scene file to load.

Parameters:

Name Type Description Default
scene_model str

Name of the scene to load, e.g, Rs_int, etc.

 required
scene_instance None or str

If specified, should be name of json file to load. (without .json), default to og_dataset/scenes//json/.json

 None

Returns:

Type Description
str

Absolute path to the desired scene file (.json) to load
Source code in omnigibson/scenes/interactive_traversable_scene.py 
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
def get_scene_loading_info(self, scene_model, scene_instance=None):
    """
    Gets scene loading info to know what single USD file to load, specified indirectly via @scene_instance if it
    is specified, otherwise, will grab the "best" scene file to load.

    Args:
        scene_model (str): Name of the scene to load, e.g, Rs_int, etc.
        scene_instance (None or str): If specified, should be name of json file to load. (without .json), default to
            og_dataset/scenes/<scene_model>/json/<scene_instance>.json

    Returns:
        str: Absolute path to the desired scene file (.json) to load
    """
    # Infer scene file from model and directory
    fname = "{}_best".format(scene_model) if scene_instance is None else scene_instance
    return os.path.join(self.scene_dir, "json", "{}.json".format(fname))