transition_map.py 20.5 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
11
from flatland.core.grid.rail_env_grid import RailEnvTransitions
u214892's avatar
u214892 committed
12
from flatland.core.transitions import Transitions
13
14
15
16
17
18
19
20
21
22
23
24
25


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
u214892's avatar
u214892 committed
26
        `cell_id` (e.g., a tuple of size of the maximum number of transitions,
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
        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):
        """
u214892's avatar
u214892 committed
46
47
        Replaces the available transitions in cell `cell_id` with the tuple
        `new_transitions'. `new_transitions` must have
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
        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):
        """
u214892's avatar
u214892 committed
63
        Return the status of whether an agent in cell `cell_id` can perform a
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
        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
79
        int or float (depending on Transitions used)
80
81
82
83
84
85
86
87
            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):
        """
u214892's avatar
u214892 committed
88
89
        Replaces the validity of transition to `transition_index` in cell
        `cell_id' with the new `new_transition`.
90
91
92
93
94
95
96
97
98
99
100


        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
101
        new_transition : int or float (depending on Transitions used)
102
103
104
105
106
107
108
109
110
111
112
113
114
115
            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
116
    def __init__(self, width, height, transitions: Transitions = Grid4Transitions([])):
117
118
119
120
121
122
123
124
125
        """
        Builder for GridTransitionMap object.

        Parameters
        ----------
        width : int
            Width of the grid.
        height : int
            Height of the grid.
126
        transitions : Transitions object
127
128
129
130
131
132
133
134
135
            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
136
        self.grid = np.zeros((height, width), dtype=self.transitions.get_type())
137

u214892's avatar
u214892 committed
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
    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):
157
158
        """
        Return a tuple of transitions available in a cell specified by
u214892's avatar
u214892 committed
159
        `cell_id` (e.g., a tuple of size of the maximum number of transitions,
160
161
162
163
164
165
166
167
168
169
170
171
172
173
        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
174
            List of the validity of transitions in the cell as given by the maps transitions.
175
176

        """
u214892's avatar
u214892 committed
177
        return self.transitions.get_transitions(self.grid[row][column], orientation)
178
179
180

    def set_transitions(self, cell_id, new_transitions):
        """
u214892's avatar
u214892 committed
181
182
        Replaces the available transitions in cell `cell_id` with the tuple
        `new_transitions'. `new_transitions` must have
183
184
185
186
187
188
189
190
191
192
193
194
195
        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
196
197
        assert len(cell_id) in (2, 3), \
            'GridTransitionMap.set_transitions() ERROR: cell_id tuple must have length 2 or 3.'
198
        if len(cell_id) == 3:
spiglerg's avatar
spiglerg committed
199
200
201
            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)
202
203
204
205
206
        elif len(cell_id) == 2:
            self.grid[cell_id[0]][cell_id[1]] = new_transitions

    def get_transition(self, cell_id, transition_index):
        """
u214892's avatar
u214892 committed
207
        Return the status of whether an agent in cell `cell_id` can perform a
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
        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
223
        int or float (depending on Transitions used in the )
224
225
226
227
            Validity of the requested transition (e.g.,
            0/1 allowed/not allowed, a probability in [0,1], etc...)

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

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

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


        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
248
        new_transition : int or float (depending on Transitions used in the map.)
249
250
251
252
            Validity of the requested transition (e.g.,
            0/1 allowed/not allowed, a probability in [0,1], etc...)

        """
u214892's avatar
u214892 committed
253
254
        assert len(cell_id) == 3, \
            'GridTransitionMap.set_transition() ERROR: cell_id tuple must have length 3.'
255
256
257
258
259
260
        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)
261

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

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

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

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

        Parameters
        ----------
282
283
284
285
        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.
286
287
        override_gridsize : bool
            If override_gridsize=True, the width and height of the GridTransitionMap object are replaced with the size
u214892's avatar
u214892 committed
288
            of the map loaded from `filename`. If override_gridsize=False, the transitions grid is either cropped (if
spiglerg's avatar
spiglerg committed
289
290
            the grid size is larger than (height,width) ) or padded with zeros (if the grid size is smaller than
            (height,width) )
291
292

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

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

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

303
    def is_dead_end(self, rcPos):
Egli Adrian (IT-SCI-API-PFI)'s avatar
Egli Adrian (IT-SCI-API-PFI) committed
304
        """
305
306
307
308
309
310
311
312
313
314
        Check if the cell is a dead-end.

        Parameters
        ----------
        rcPos: Tuple[int,int]
            tuple(row, column) with grid coordinate
        Returns
        -------
        boolean
            True if and only if the cell is a dead-end.
Egli Adrian (IT-SCI-API-PFI)'s avatar
Egli Adrian (IT-SCI-API-PFI) committed
315
316
317
318
319
320
        """
        nbits = 0
        tmp = self.get_full_transitions(rcPos[0], rcPos[1])
        while tmp > 0:
            nbits += (tmp & 1)
            tmp = tmp >> 1
321
322
        return nbits == 1

323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
    def is_simple_turn(self, rcPos):
        """
        Check if the cell is a left/right simple turn

        Parameters
        ----------
            rcPos: Tuple[int,int]
                tuple(row, column) with grid coordinate
        Returns
        -------
            boolean
                True if and only if the cell is a left/right simple turn.
        """
        tmp = self.get_full_transitions(rcPos[0], rcPos[1])

        def is_simple_turn(trans):
            all_simple_turns = set()
            for trans in [int('0100000000000010', 2),  # Case 1b (8)  - simple turn right
                          int('0001001000000000', 2)  # Case 1c (9)  - simple turn left]:
                          ]:
                for _ in range(3):
                    trans = self.transitions.rotate_transition(trans, rotation=90)
                    all_simple_turns.add(trans)
            return trans in all_simple_turns

        return is_simple_turn(tmp)

350
    def check_path_exists(self, start, direction, end):
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
        # 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
372

373
374
375
376
377
378
    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.
379

380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
        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
397
        binTrans = self.get_full_transitions(*rcPos)  # 16bit integer - all trans in/out
398
399
        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)
400
401
        gDirOut = g2binTrans.any(axis=0)  # outbound directions as boolean array (4)
        giDirOut = np.argwhere(gDirOut)[:, 0]  # valid outbound directions as array of int
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416

        # 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
417
            t4Trans2 = self.get_transitions(*gPos2, iDirOut)
418
419
420
421
422
423
424
            if any(t4Trans2):
                continue
            else:
                return False

        return True

425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
    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

478
479
480
481
482
483
484
485
    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

486
487
488
489
490
491
492
493
        # Transition elements
        transitions = RailEnvTransitions()
        cells = transitions.transition_list
        simple_switch_east_south = transitions.rotate_transition(cells[10], 90)
        simple_switch_west_south = transitions.rotate_transition(cells[2], 270)
        symmetrical = cells[6]
        double_slip = cells[5]
        three_way_transitions = [simple_switch_east_south, simple_switch_west_south, symmetrical]
494
        # loop over available outbound directions (indices) for rcPos
495
496
        self.set_transitions(rcPos, 0)

u214892's avatar
u214892 committed
497
        incoming_connections = np.zeros(4)
498
499
500
501
502
        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
503
            # if not, then ignore it for the count of incoming connections
504
            if np.any(gPos2 < 0):
u214892's avatar
u214892 committed
505
                continue
506
            if np.any(gPos2 >= grcMax):
u214892's avatar
u214892 committed
507
                continue
508
509
510
511
512
513
514

            # 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
515
                incoming_connections[iDirOut] = 1
516

u214892's avatar
u214892 committed
517
        number_of_incoming = np.sum(incoming_connections)
518
519
520
        # Only one incoming direction --> Straight line
        if number_of_incoming == 1:
            for direction in range(4):
u214892's avatar
u214892 committed
521
                if incoming_connections[direction] > 0:
522
523
524
                    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
525
            connect_directions = np.argwhere(incoming_connections > 0)
526
527
528
            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)

529
        # Find feasible connection for three entries
530
        if number_of_incoming == 3:
531
            transition = np.random.choice(three_way_transitions, 1)
u214892's avatar
u214892 committed
532
            hole = np.argwhere(incoming_connections < 1)[0][0]
533
534
535
536
            transition = transitions.rotate_transition(transition, int(hole * 90))
            self.set_transitions((rcPos[0], rcPos[1]), transition)

        # Make a double slip switch
537
        if number_of_incoming == 4:
538
539
540
            rotation = np.random.randint(2)
            transition = transitions.rotate_transition(double_slip, int(rotation * 90))
            self.set_transitions((rcPos[0], rcPos[1]), transition)
541
542
        return True

543
544
545

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