Skip to content

segmentation_map

SegmentationMap

Bases: BaseMap

Segmentation map for computing connectivity within the scene

Source code in omnigibson/maps/segmentation_map.py 
 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
class SegmentationMap(BaseMap):
    """
    Segmentation map for computing connectivity within the scene
    """

    def __init__(
        self,
        scene_dir,
        map_resolution=0.1,
        floor_heights=(0.0,),
    ):
        """
        Args:
            scene_dir (str): path to the scene directory from which segmentation info will be extracted
            map_resolution (float): map resolution
            floor_heights (list of float): heights of the floors for this segmentation map
        """
        # Store internal values
        self.scene_dir = scene_dir
        self.map_default_resolution = 0.01
        self.floor_heights = floor_heights

        # Other values that will be loaded at runtime
        self.room_sem_name_to_sem_id = None
        self.room_sem_id_to_sem_name = None
        self.room_ins_name_to_ins_id = None
        self.room_ins_id_to_ins_name = None
        self.room_sem_name_to_ins_name = None
        self.room_ins_map = None
        self.room_sem_map = None

        # Run super call
        super().__init__(map_resolution=map_resolution)

        # Load the map
        self.load_map()

    def _load_map(self):
        layout_dir = os.path.join(self.scene_dir, "layout")
        room_seg_imgs = os.path.join(layout_dir, "floor_insseg_0.png")
        img_ins = Image.open(room_seg_imgs)
        room_seg_imgs = os.path.join(layout_dir, "floor_semseg_0.png")
        img_sem = Image.open(room_seg_imgs)
        height, width = img_ins.size
        assert height == width, "room seg map is not a square"
        assert img_ins.size == img_sem.size, "semantic and instance seg maps have different sizes"
        map_size = int(height * self.map_default_resolution / self.map_resolution)
        img_ins = np.array(img_ins.resize((map_size, map_size), Image.NEAREST))
        img_sem = np.array(img_sem.resize((map_size, map_size), Image.NEAREST))

        room_categories = os.path.join(gm.DATASET_PATH, "metadata", "room_categories.txt")
        with open(room_categories, "r") as fp:
            room_cats = [line.rstrip() for line in fp.readlines()]

        sem_id_to_ins_id = {}
        unique_ins_ids = np.unique(img_ins)
        unique_ins_ids = np.delete(unique_ins_ids, 0)
        for ins_id in unique_ins_ids:
            # find one pixel for each ins id
            x, y = np.where(img_ins == ins_id)
            # retrieve the correspounding sem id
            sem_id = img_sem[x[0], y[0]]
            if sem_id not in sem_id_to_ins_id:
                sem_id_to_ins_id[sem_id] = []
            sem_id_to_ins_id[sem_id].append(ins_id)

        room_sem_name_to_sem_id = {}
        room_ins_name_to_ins_id = {}
        room_sem_name_to_ins_name = {}
        for sem_id, ins_ids in sem_id_to_ins_id.items():
            sem_name = room_cats[sem_id - 1]
            room_sem_name_to_sem_id[sem_name] = sem_id
            for i, ins_id in enumerate(ins_ids):
                # valid class start from 1
                ins_name = "{}_{}".format(sem_name, i)
                room_ins_name_to_ins_id[ins_name] = ins_id
                if sem_name not in room_sem_name_to_ins_name:
                    room_sem_name_to_ins_name[sem_name] = []
                room_sem_name_to_ins_name[sem_name].append(ins_name)

        self.room_sem_name_to_sem_id = room_sem_name_to_sem_id
        self.room_sem_id_to_sem_name = {value: key for key, value in room_sem_name_to_sem_id.items()}
        self.room_ins_name_to_ins_id = room_ins_name_to_ins_id
        self.room_ins_id_to_ins_name = {value: key for key, value in room_ins_name_to_ins_id.items()}
        self.room_sem_name_to_ins_name = room_sem_name_to_ins_name
        self.room_ins_map = img_ins
        self.room_sem_map = img_sem

        return map_size

    def get_random_point_by_room_type(self, room_type):
        """
        Sample a random point on the given a specific room type @room_type.

        Args:
            room_type (str): Room type to sample random point (e.g.: "bathroom")

        Returns:
            2-tuple:
                - int: floor number. This is always 0
                - 3-array: (x,y,z) randomly sampled point in a room of type @room_type
        """
        if room_type not in self.room_sem_name_to_sem_id:
            log.warning("room_type [{}] does not exist.".format(room_type))
            return None, None

        sem_id = self.room_sem_name_to_sem_id[room_type]
        valid_idx = np.array(np.where(self.room_sem_map == sem_id))
        random_point_map = valid_idx[:, np.random.randint(valid_idx.shape[1])]

        x, y = self.map_to_world(random_point_map)
        # assume only 1 floor
        floor = 0
        z = self.floor_heights[floor]
        return floor, np.array([x, y, z])

    def get_random_point_by_room_instance(self, room_instance):
        """
        Sample a random point on the given a specific room instance @room_instance.

        Args:
            room_instance (str): Room instance to sample random point (e.g.: "bathroom_1")

        Returns:
            2-tuple:
                - int: floor number. This is always 0
                - 3-array: (x,y,z) randomly sampled point in room @room_instance
        """
        if room_instance not in self.room_ins_name_to_ins_id:
            log.warning("room_instance [{}] does not exist.".format(room_instance))
            return None, None

        ins_id = self.room_ins_name_to_ins_id[room_instance]
        valid_idx = np.array(np.where(self.room_ins_map == ins_id))
        random_point_map = valid_idx[:, np.random.randint(valid_idx.shape[1])]

        x, y = self.map_to_world(random_point_map)
        # assume only 1 floor
        floor = 0
        z = self.floor_heights[floor]
        return floor, np.array([x, y, z])

    def get_room_type_by_point(self, xy):
        """
        Return the room type given a point

        Args:
            xy (2-array): 2D location in world reference frame (in metric space)

        Returns:
            None or str: room type that this point is in or None, if this point is not on the room segmentation map
        """
        x, y = self.world_to_map(xy)
        if x < 0 or x >= self.room_sem_map.shape[0] or y < 0 or y >= self.room_sem_map.shape[1]:
            return None
        sem_id = self.room_sem_map[x, y]
        # room boundary
        if sem_id == 0:
            return None
        else:
            return self.room_sem_id_to_sem_name[sem_id]

    def get_room_instance_by_point(self, xy):
        """
        Return the room type given a point

        Args:
            xy (2-array): 2D location in world reference frame (in metric space)

        Returns:
            None or str: room instance that this point is in or None, if this point is not on the room segmentation map
        """
        x, y = self.world_to_map(xy)
        if x < 0 or x >= self.room_ins_map.shape[0] or y < 0 or y >= self.room_ins_map.shape[1]:
            return None
        ins_id = self.room_ins_map[x, y]
        # room boundary
        if ins_id == 0:
            return None
        else:
            return self.room_ins_id_to_ins_name[ins_id]

__init__(scene_dir, map_resolution=0.1, floor_heights=(0.0))

Parameters:

Name Type Description Default
scene_dir str

path to the scene directory from which segmentation info will be extracted

 required
map_resolution float

map resolution

 0.1
floor_heights list of float

heights of the floors for this segmentation map

 (0.0)
Source code in omnigibson/maps/segmentation_map.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
def __init__(
    self,
    scene_dir,
    map_resolution=0.1,
    floor_heights=(0.0,),
):
    """
    Args:
        scene_dir (str): path to the scene directory from which segmentation info will be extracted
        map_resolution (float): map resolution
        floor_heights (list of float): heights of the floors for this segmentation map
    """
    # Store internal values
    self.scene_dir = scene_dir
    self.map_default_resolution = 0.01
    self.floor_heights = floor_heights

    # Other values that will be loaded at runtime
    self.room_sem_name_to_sem_id = None
    self.room_sem_id_to_sem_name = None
    self.room_ins_name_to_ins_id = None
    self.room_ins_id_to_ins_name = None
    self.room_sem_name_to_ins_name = None
    self.room_ins_map = None
    self.room_sem_map = None

    # Run super call
    super().__init__(map_resolution=map_resolution)

    # Load the map
    self.load_map()

get_random_point_by_room_instance(room_instance)

Sample a random point on the given a specific room instance @room_instance.

Parameters:

Name Type Description Default
room_instance str

Room instance to sample random point (e.g.: "bathroom_1")

 required

Returns:

Type Description

2-tuple: - int: floor number. This is always 0 - 3-array: (x,y,z) randomly sampled point in room @room_instance
Source code in omnigibson/maps/segmentation_map.py 
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
def get_random_point_by_room_instance(self, room_instance):
    """
    Sample a random point on the given a specific room instance @room_instance.

    Args:
        room_instance (str): Room instance to sample random point (e.g.: "bathroom_1")

    Returns:
        2-tuple:
            - int: floor number. This is always 0
            - 3-array: (x,y,z) randomly sampled point in room @room_instance
    """
    if room_instance not in self.room_ins_name_to_ins_id:
        log.warning("room_instance [{}] does not exist.".format(room_instance))
        return None, None

    ins_id = self.room_ins_name_to_ins_id[room_instance]
    valid_idx = np.array(np.where(self.room_ins_map == ins_id))
    random_point_map = valid_idx[:, np.random.randint(valid_idx.shape[1])]

    x, y = self.map_to_world(random_point_map)
    # assume only 1 floor
    floor = 0
    z = self.floor_heights[floor]
    return floor, np.array([x, y, z])

get_random_point_by_room_type(room_type)

Sample a random point on the given a specific room type @room_type.

Parameters:

Name Type Description Default
room_type str

Room type to sample random point (e.g.: "bathroom")

 required

Returns:

Type Description

2-tuple: - int: floor number. This is always 0 - 3-array: (x,y,z) randomly sampled point in a room of type @room_type
Source code in omnigibson/maps/segmentation_map.py 
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
def get_random_point_by_room_type(self, room_type):
    """
    Sample a random point on the given a specific room type @room_type.

    Args:
        room_type (str): Room type to sample random point (e.g.: "bathroom")

    Returns:
        2-tuple:
            - int: floor number. This is always 0
            - 3-array: (x,y,z) randomly sampled point in a room of type @room_type
    """
    if room_type not in self.room_sem_name_to_sem_id:
        log.warning("room_type [{}] does not exist.".format(room_type))
        return None, None

    sem_id = self.room_sem_name_to_sem_id[room_type]
    valid_idx = np.array(np.where(self.room_sem_map == sem_id))
    random_point_map = valid_idx[:, np.random.randint(valid_idx.shape[1])]

    x, y = self.map_to_world(random_point_map)
    # assume only 1 floor
    floor = 0
    z = self.floor_heights[floor]
    return floor, np.array([x, y, z])

get_room_instance_by_point(xy)

Return the room type given a point

Parameters:

Name Type Description Default
xy 2 - array

2D location in world reference frame (in metric space)

 required

Returns:

Type Description

None or str: room instance that this point is in or None, if this point is not on the room segmentation map
Source code in omnigibson/maps/segmentation_map.py 
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
def get_room_instance_by_point(self, xy):
    """
    Return the room type given a point

    Args:
        xy (2-array): 2D location in world reference frame (in metric space)

    Returns:
        None or str: room instance that this point is in or None, if this point is not on the room segmentation map
    """
    x, y = self.world_to_map(xy)
    if x < 0 or x >= self.room_ins_map.shape[0] or y < 0 or y >= self.room_ins_map.shape[1]:
        return None
    ins_id = self.room_ins_map[x, y]
    # room boundary
    if ins_id == 0:
        return None
    else:
        return self.room_ins_id_to_ins_name[ins_id]

get_room_type_by_point(xy)

Return the room type given a point

Parameters:

Name Type Description Default
xy 2 - array

2D location in world reference frame (in metric space)

 required

Returns:

Type Description

None or str: room type that this point is in or None, if this point is not on the room segmentation map
Source code in omnigibson/maps/segmentation_map.py 
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
def get_room_type_by_point(self, xy):
    """
    Return the room type given a point

    Args:
        xy (2-array): 2D location in world reference frame (in metric space)

    Returns:
        None or str: room type that this point is in or None, if this point is not on the room segmentation map
    """
    x, y = self.world_to_map(xy)
    if x < 0 or x >= self.room_sem_map.shape[0] or y < 0 or y >= self.room_sem_map.shape[1]:
        return None
    sem_id = self.room_sem_map[x, y]
    # room boundary
    if sem_id == 0:
        return None
    else:
        return self.room_sem_id_to_sem_name[sem_id]