transition_map.py 19.9 KB
Newer Older
1
2
3
4
5
"""
TransitionMap and derived classes.
"""

import numpy as np
6
from importlib_resources import path
7
from numpy import array
8

u214892's avatar
u214892 committed
9
from flatland.core.grid.grid4 import Grid4Transitions
10
from flatland.core.grid.grid4_utils import get_new_position
u214892's avatar
u214892 committed
11
from flatland.core.transitions import Transitions
12
13
14
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
77


class TransitionMap:
    """
    Base TransitionMap class.

    Generic class that implements a collection of transitions over a set of
    cells.
    """

    def get_transitions(self, cell_id):
        """
        Return a tuple of transitions available in a cell specified by
        `cell_id' (e.g., a tuple of size of the maximum number of transitions,
        with values 0 or 1, or potentially in between,
        for stochastic transitions).

        Parameters
        ----------
        cell_id : [cell identifier]
            The cell_id object depends on the specific implementation.
            It generally is an int (e.g., an index) or a tuple of indices.

        Returns
        -------
        tuple
            List of the validity of transitions in the cell.

        """
        raise NotImplementedError()

    def set_transitions(self, cell_id, new_transitions):
        """
        Replaces the available transitions in cell `cell_id' with the tuple
        `new_transitions'. `new_transitions' must have
        one element for each possible transition.

        Parameters
        ----------
        cell_id : [cell identifier]
            The cell_id object depends on the specific implementation.
            It generally is an int (e.g., an index) or a tuple of indices.
        new_transitions : tuple
            Tuple of new transitions validitiy for the cell.

        """
        raise NotImplementedError()

    def get_transition(self, cell_id, transition_index):
        """
        Return the status of whether an agent in cell `cell_id' can perform a
        movement along transition `transition_index (e.g., the NESW direction
        of movement, for agents on a grid).

        Parameters
        ----------
        cell_id : [cell identifier]
            The cell_id object depends on the specific implementation.
            It generally is an int (e.g., an index) or a tuple of indices.
        transition_index : int
            Index of the transition to probe, as index in the tuple returned by
            get_transitions(). e.g., the NESW direction of movement, for agents
            on a grid.

        Returns
        -------
u214892's avatar
u214892 committed
78
        int or float (depending on Transitions used)
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
            Validity of the requested transition (e.g.,
            0/1 allowed/not allowed, a probability in [0,1], etc...)

        """
        raise NotImplementedError()

    def set_transition(self, cell_id, transition_index, new_transition):
        """
        Replaces the validity of transition to `transition_index' in cell
        `cell_id' with the new `new_transition'.


        Parameters
        ----------
        cell_id : [cell identifier]
            The cell_id object depends on the specific implementation.
            It generally is an int (e.g., an index) or a tuple of indices.
        transition_index : int
            Index of the transition to probe, as index in the tuple returned by
            get_transitions(). e.g., the NESW direction of movement, for agents
            on a grid.
u214892's avatar
u214892 committed
100
        new_transition : int or float (depending on Transitions used)
101
102
103
104
105
106
107
108
109
110
111
112
113
114
            Validity of the requested transition (e.g.,
            0/1 allowed/not allowed, a probability in [0,1], etc...)

        """
        raise NotImplementedError()


class GridTransitionMap(TransitionMap):
    """
    Implements a TransitionMap over a 2D grid.

    GridTransitionMap implements utility functions.
    """

u214892's avatar
u214892 committed
115
    def __init__(self, width, height, transitions: Transitions = Grid4Transitions([])):
116
117
118
119
120
121
122
123
124
        """
        Builder for GridTransitionMap object.

        Parameters
        ----------
        width : int
            Width of the grid.
        height : int
            Height of the grid.
125
        transitions : Transitions object
126
127
128
129
130
131
132
133
134
            The Transitions object to use to encode/decode transitions over the
            grid.

        """

        self.width = width
        self.height = height
        self.transitions = transitions

u214892's avatar
u214892 committed
135
        self.grid = np.zeros((height, width), dtype=self.transitions.get_type())
136

u214892's avatar
u214892 committed
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
    def get_full_transitions(self, row, column):
        """
        Returns the full transitions for the cell at (row, column) in the format transition_map's transitions.

        Parameters
        ----------
        row: int
        column: int
            (row,column) specifies the cell in this transition map.

        Returns
        -------
        self.transitions.get_type()
            The cell content int the format of this map's Transitions.

        """
        return self.grid[row][column]

    def get_transitions(self, row, column, orientation):
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
        """
        Return a tuple of transitions available in a cell specified by
        `cell_id' (e.g., a tuple of size of the maximum number of transitions,
        with values 0 or 1, or potentially in between,
        for stochastic transitions).

        Parameters
        ----------
        cell_id : tuple
            The cell_id indices a cell as (column, row, orientation),
            where orientation is the direction an agent is facing within a cell.
            Alternatively, it can be accessed as (column, row) to return the
            full cell content.

        Returns
        -------
        tuple
u214892's avatar
u214892 committed
173
            List of the validity of transitions in the cell as given by the maps transitions.
174
175

        """
u214892's avatar
u214892 committed
176
        return self.transitions.get_transitions(self.grid[row][column], orientation)
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194

    def set_transitions(self, cell_id, new_transitions):
        """
        Replaces the available transitions in cell `cell_id' with the tuple
        `new_transitions'. `new_transitions' must have
        one element for each possible transition.

        Parameters
        ----------
        cell_id : tuple
            The cell_id indices a cell as (column, row, orientation),
            where orientation is the direction an agent is facing within a cell.
            Alternatively, it can be accessed as (column, row) to replace the
            full cell content.
        new_transitions : tuple
            Tuple of new transitions validitiy for the cell.

        """
u214892's avatar
u214892 committed
195
196
        assert len(cell_id) in (2, 3), \
            'GridTransitionMap.set_transitions() ERROR: cell_id tuple must have length 2 or 3.'
197
        if len(cell_id) == 3:
spiglerg's avatar
spiglerg committed
198
199
200
            self.grid[cell_id[0]][cell_id[1]] = self.transitions.set_transitions(self.grid[cell_id[0]][cell_id[1]],
                                                                                 cell_id[2],
                                                                                 new_transitions)
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
        elif len(cell_id) == 2:
            self.grid[cell_id[0]][cell_id[1]] = new_transitions

    def get_transition(self, cell_id, transition_index):
        """
        Return the status of whether an agent in cell `cell_id' can perform a
        movement along transition `transition_index (e.g., the NESW direction
        of movement, for agents on a grid).

        Parameters
        ----------
        cell_id : tuple
            The cell_id indices a cell as (column, row, orientation),
            where orientation is the direction an agent is facing within a cell.
        transition_index : int
            Index of the transition to probe, as index in the tuple returned by
            get_transitions(). e.g., the NESW direction of movement, for agents
            on a grid.

        Returns
        -------
u214892's avatar
u214892 committed
222
        int or float (depending on Transitions used in the )
223
224
225
226
            Validity of the requested transition (e.g.,
            0/1 allowed/not allowed, a probability in [0,1], etc...)

        """
u214892's avatar
u214892 committed
227
228
229

        assert len(cell_id) == 3, \
            'GridTransitionMap.get_transition() ERROR: cell_id tuple must have length 2 or 3.'
230
231
        return self.transitions.get_transition(self.grid[cell_id[0]][cell_id[1]], cell_id[2], transition_index)

232
    def set_transition(self, cell_id, transition_index, new_transition, remove_deadends=False):
233
234
235
236
237
238
239
240
241
242
243
244
245
246
        """
        Replaces the validity of transition to `transition_index' in cell
        `cell_id' with the new `new_transition'.


        Parameters
        ----------
        cell_id : tuple
            The cell_id indices a cell as (column, row, orientation),
            where orientation is the direction an agent is facing within a cell.
        transition_index : int
            Index of the transition to probe, as index in the tuple returned by
            get_transitions(). e.g., the NESW direction of movement, for agents
            on a grid.
u214892's avatar
u214892 committed
247
        new_transition : int or float (depending on Transitions used in the map.)
248
249
250
251
            Validity of the requested transition (e.g.,
            0/1 allowed/not allowed, a probability in [0,1], etc...)

        """
u214892's avatar
u214892 committed
252
253
        assert len(cell_id) == 3, \
            'GridTransitionMap.set_transition() ERROR: cell_id tuple must have length 3.'
254
255
256
257
258
259
        self.grid[cell_id[0]][cell_id[1]] = self.transitions.set_transition(
            self.grid[cell_id[0]][cell_id[1]],
            cell_id[2],
            transition_index,
            new_transition,
            remove_deadends)
260

261
262
263
264
265
266
267
268
269
270
271
272
    def save_transition_map(self, filename):
        """
        Save the transitions grid as `filename', in npy format.

        Parameters
        ----------
        filename : string
            Name of the file to which to save the transitions grid.

        """
        np.save(filename, self.grid)

u214892's avatar
u214892 committed
273
    def load_transition_map(self, package, resource):
274
275
276
277
278
279
280
        """
        Load the transitions grid from `filename' (npy format).
        The load function only updates the transitions grid, and possibly width and height, but the object has to be
        initialized with the correct `transitions' object anyway.

        Parameters
        ----------
281
282
283
284
        package : string
            Name of the package from which to load the transitions grid.
        resource : string
            Name of the file from which to load the transitions grid within the package.
285
286
287
        override_gridsize : bool
            If override_gridsize=True, the width and height of the GridTransitionMap object are replaced with the size
            of the map loaded from `filename'. If override_gridsize=False, the transitions grid is either cropped (if
spiglerg's avatar
spiglerg committed
288
289
            the grid size is larger than (height,width) ) or padded with zeros (if the grid size is smaller than
            (height,width) )
290
291

        """
292
293
        with path(package, resource) as file_in:
            new_grid = np.load(file_in)
294
295
296
297

        new_height = new_grid.shape[0]
        new_width = new_grid.shape[1]

u214892's avatar
u214892 committed
298
299
300
        self.width = new_width
        self.height = new_height
        self.grid = new_grid
301

302
    def is_dead_end(self, rcPos):
Egli Adrian (IT-SCI-API-PFI)'s avatar
Egli Adrian (IT-SCI-API-PFI) committed
303
304
305
306
307
308
309
310
311
312
        """
        Check if the cell is a dead-end
        :param rcPos: tuple(row, column) with grid coordinate
        :return: False : if not a dead-end else True
        """
        nbits = 0
        tmp = self.get_full_transitions(rcPos[0], rcPos[1])
        while tmp > 0:
            nbits += (tmp & 1)
            tmp = tmp >> 1
313
314
        return nbits == 1

315
    def check_path_exists(self, start, direction, end):
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
        # print("_path_exists({},{},{}".format(start, direction, end))
        # BFS - Check if a path exists between the 2 nodes

        visited = set()
        stack = [(start, direction)]
        while stack:
            node = stack.pop()
            node_position = node[0]
            node_direction = node[1]
            if node_position[0] == end[0] and node_position[1] == end[1]:
                return True
            if node not in visited:
                visited.add(node)

                moves = self.get_transitions(node_position[0], node_position[1], node_direction)
                for move_index in range(4):
                    if moves[move_index]:
                        stack.append((get_new_position(node_position, move_index),
                                      move_index))

        return False
Egli Adrian (IT-SCI-API-PFI)'s avatar
Egli Adrian (IT-SCI-API-PFI) committed
337

338
339
340
341
342
343
    def cell_neighbours_valid(self, rcPos, check_this_cell=False):
        """
        Check validity of cell at rcPos = tuple(row, column)
        Checks that:
        - surrounding cells have inbound transitions for all the
            outbound transitions of this cell.
344

345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
        These are NOT checked - see transition.is_valid:
        - all transitions have the mirror transitions (N->E <=> W->S)
        - Reverse transitions (N -> S) only exist for a dead-end
        - a cell contains either no dead-ends or exactly one

        Returns: True (valid) or False (invalid)
        """
        cell_transition = self.grid[tuple(rcPos)]

        if check_this_cell:
            if not self.transitions.is_valid(cell_transition):
                return False

        gDir2dRC = self.transitions.gDir2dRC  # [[-1,0] = N, [0,1]=E, etc]
        grcPos = array(rcPos)
        grcMax = self.grid.shape

u214892's avatar
u214892 committed
362
        binTrans = self.get_full_transitions(*rcPos)  # 16bit integer - all trans in/out
363
364
        lnBinTrans = array([binTrans >> 8, binTrans & 0xff], dtype=np.uint8)  # 2 x uint8
        g2binTrans = np.unpackbits(lnBinTrans).reshape(4, 4)  # 4x4 x uint8 binary(0,1)
365
366
        gDirOut = g2binTrans.any(axis=0)  # outbound directions as boolean array (4)
        giDirOut = np.argwhere(gDirOut)[:, 0]  # valid outbound directions as array of int
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381

        # loop over available outbound directions (indices) for rcPos
        for iDirOut in giDirOut:
            gdRC = gDir2dRC[iDirOut]  # row,col increment
            gPos2 = grcPos + gdRC  # next cell in that direction

            # Check the adjacent cell is within bounds
            # if not, then this transition is invalid!
            if np.any(gPos2 < 0):
                return False
            if np.any(gPos2 >= grcMax):
                return False

            # Get the transitions out of gPos2, using iDirOut as the inbound direction
            # if there are no available transitions, ie (0,0,0,0), then rcPos is invalid
u214892's avatar
u214892 committed
382
            t4Trans2 = self.get_transitions(*gPos2, iDirOut)
383
384
385
386
387
388
389
            if any(t4Trans2):
                continue
            else:
                return False

        return True

390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
    def fix_neighbours(self, rcPos, check_this_cell=False):
        """
        Check validity of cell at rcPos = tuple(row, column)
        Checks that:
        - surrounding cells have inbound transitions for all the
            outbound transitions of this cell.

        These are NOT checked - see transition.is_valid:
        - all transitions have the mirror transitions (N->E <=> W->S)
        - Reverse transitions (N -> S) only exist for a dead-end
        - a cell contains either no dead-ends or exactly one

        Returns: True (valid) or False (invalid)
        """
        cell_transition = self.grid[tuple(rcPos)]

        if check_this_cell:
            if not self.transitions.is_valid(cell_transition):
                return False

        gDir2dRC = self.transitions.gDir2dRC  # [[-1,0] = N, [0,1]=E, etc]
        grcPos = array(rcPos)
        grcMax = self.grid.shape

        binTrans = self.get_full_transitions(*rcPos)  # 16bit integer - all trans in/out
        lnBinTrans = array([binTrans >> 8, binTrans & 0xff], dtype=np.uint8)  # 2 x uint8
        g2binTrans = np.unpackbits(lnBinTrans).reshape(4, 4)  # 4x4 x uint8 binary(0,1)
        gDirOut = g2binTrans.any(axis=0)  # outbound directions as boolean array (4)
        giDirOut = np.argwhere(gDirOut)[:, 0]  # valid outbound directions as array of int

        # loop over available outbound directions (indices) for rcPos
        for iDirOut in giDirOut:
            gdRC = gDir2dRC[iDirOut]  # row,col increment
            gPos2 = grcPos + gdRC  # next cell in that direction

            # Check the adjacent cell is within bounds
            # if not, then this transition is invalid!
            if np.any(gPos2 < 0):
                return False
            if np.any(gPos2 >= grcMax):
                return False

            # Get the transitions out of gPos2, using iDirOut as the inbound direction
            # if there are no available transitions, ie (0,0,0,0), then rcPos is invalid
            t4Trans2 = self.get_transitions(*gPos2, iDirOut)
            if any(t4Trans2):
                continue
            else:
                self.set_transition((gPos2[0], gPos2[1], iDirOut), mirror(iDirOut), 1)
                return False

        return True

443
444
445
446
447
448
449
450
451
    def fix_transitions(self, rcPos):
        """
        Fixes broken transitions
        """
        gDir2dRC = self.transitions.gDir2dRC  # [[-1,0] = N, [0,1]=E, etc]
        grcPos = array(rcPos)
        grcMax = self.grid.shape

        # loop over available outbound directions (indices) for rcPos
452
453
        self.set_transitions(rcPos, 0)

u214892's avatar
u214892 committed
454
        incoming_connections = np.zeros(4)
455
456
457
458
459
        for iDirOut in np.arange(4):
            gdRC = gDir2dRC[iDirOut]  # row,col increment
            gPos2 = grcPos + gdRC  # next cell in that direction

            # Check the adjacent cell is within bounds
u214892's avatar
u214892 committed
460
            # if not, then ignore it for the count of incoming connections
461
            if np.any(gPos2 < 0):
u214892's avatar
u214892 committed
462
                continue
463
            if np.any(gPos2 >= grcMax):
u214892's avatar
u214892 committed
464
                continue
465
466
467
468
469
470
471

            # Get the transitions out of gPos2, using iDirOut as the inbound direction
            # if there are no available transitions, ie (0,0,0,0), then rcPos is invalid
            connected = 0
            for orientation in range(4):
                connected += self.get_transition((gPos2[0], gPos2[1], orientation), mirror(iDirOut))
            if connected > 0:
u214892's avatar
u214892 committed
472
                incoming_connections[iDirOut] = 1
473

u214892's avatar
u214892 committed
474
        number_of_incoming = np.sum(incoming_connections)
475
476
477
        # Only one incoming direction --> Straight line
        if number_of_incoming == 1:
            for direction in range(4):
u214892's avatar
u214892 committed
478
                if incoming_connections[direction] > 0:
479
480
481
                    self.set_transition((rcPos[0], rcPos[1], mirror(direction)), direction, 1)
        # Connect all incoming connections
        if number_of_incoming == 2:
u214892's avatar
u214892 committed
482
            connect_directions = np.argwhere(incoming_connections > 0)
483
484
485
486
487
            self.set_transition((rcPos[0], rcPos[1], mirror(connect_directions[0])), connect_directions[1], 1)
            self.set_transition((rcPos[0], rcPos[1], mirror(connect_directions[1])), connect_directions[0], 1)

        # Find feasible connection fro three entries
        if number_of_incoming == 3:
u214892's avatar
u214892 committed
488
            hole = np.argwhere(incoming_connections < 1)[0][0]
489
490
491
492
493
494
495
            connect_directions = [(hole + 1) % 4, (hole + 2) % 4, (hole + 3) % 4]
            self.set_transition((rcPos[0], rcPos[1], mirror(connect_directions[0])), connect_directions[1], 1)
            self.set_transition((rcPos[0], rcPos[1], mirror(connect_directions[0])), connect_directions[2], 1)
            self.set_transition((rcPos[0], rcPos[1], mirror(connect_directions[1])), connect_directions[0], 1)
            self.set_transition((rcPos[0], rcPos[1], mirror(connect_directions[2])), connect_directions[0], 1)
        # Make a cross
        if number_of_incoming == 4:
496
497
498
499
500
501
502
503
504
            connect_directions = np.arange(4)
            self.set_transition((rcPos[0], rcPos[1], connect_directions[0]), connect_directions[0], 1)
            self.set_transition((rcPos[0], rcPos[1], connect_directions[0]), connect_directions[1], 1)
            self.set_transition((rcPos[0], rcPos[1], connect_directions[1]), connect_directions[0], 1)
            self.set_transition((rcPos[0], rcPos[1], connect_directions[1]), connect_directions[1], 1)
            self.set_transition((rcPos[0], rcPos[1], connect_directions[2]), connect_directions[2], 1)
            self.set_transition((rcPos[0], rcPos[1], connect_directions[2]), connect_directions[3], 1)
            self.set_transition((rcPos[0], rcPos[1], connect_directions[3]), connect_directions[2], 1)
            self.set_transition((rcPos[0], rcPos[1], connect_directions[3]), connect_directions[3], 1)
505
506
        return True

507
508
509

def mirror(dir):
    return (dir + 2) % 4
u214892's avatar
u214892 committed
510
# TODO: improvement override __getitem__ and __setitem__ (cell contents, not transitions?)