Skip to content

Stitch

stitch(config, nbp_basic, spot_details)

This gets the origin of each tile such that a global coordinate system can be built.

See 'stitch' section of notebook_comments.json file for description of the variables in the page.

Parameters:

Name Type Description Default
config dict

Dictionary obtained from 'stitch' section of config file.

required
nbp_basic NotebookPage

basic_info notebook page

required
spot_details np.ndarray

int [n_spots x 7]. spot_details[s] is [tile, round, channel, isolated, y, x, z] of spot s. This is saved in the find_spots notebook page i.e. nb.find_spots.spot_details.

required

Returns:

Type Description
NotebookPage

NotebookPage[stitch] - Page contains information about how tiles were stitched together to give global coordinates.

Source code in coppafish/pipeline/stitch.py
  9
 10
 11
 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
 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
def stitch(config: dict, nbp_basic: NotebookPage, spot_details: np.ndarray) -> NotebookPage:
    """
    This gets the origin of each tile such that a global coordinate system can be built.

    See `'stitch'` section of `notebook_comments.json` file
    for description of the variables in the page.

    Args:
        config: Dictionary obtained from `'stitch'` section of config file.
        nbp_basic: `basic_info` notebook page
        spot_details: `int [n_spots x 7]`.
            `spot_details[s]` is `[tile, round, channel, isolated, y, x, z]` of spot `s`.
            This is saved in the find_spots notebook page i.e. `nb.find_spots.spot_details`.

    Returns:
        `NotebookPage[stitch]` - Page contains information about how tiles were stitched together to give
            global coordinates.
    """
    nbp_debug = NotebookPage("stitch")
    # NOTE that directions should actually be 'north' and 'east'
    directions = ['south', 'west']
    coords = ['y', 'x', 'z']
    shifts = get_shifts_to_search(config, nbp_basic, nbp_debug)

    if not nbp_basic.is_3d:
        config['nz_collapse'] = None
        config['shift_widen'][2] = 0  # so don't look for shifts in z direction
        config['shift_max_range'][2] = 0

    # initialise variables to store shift info
    shift_info = {'south': {}, 'west': {}}
    for j in directions:
        shift_info[j]['pairs'] = np.zeros((0, 2), dtype=int)
        shift_info[j]['shifts'] = np.zeros((0, 3), dtype=int)
        shift_info[j]['score'] = np.zeros((0, 1), dtype=float)
        shift_info[j]['score_thresh'] = np.zeros((0, 1), dtype=float)

    # find shifts between overlapping tiles
    c = nbp_basic.ref_channel
    r = nbp_basic.ref_round
    t_neighb = {'south': [], 'west': []}
    # to convert z coordinate units to xy pixels when calculating distance to nearest neighbours
    z_scale = nbp_basic.pixel_size_z / nbp_basic.pixel_size_xy
    with tqdm(total=2 * len(nbp_basic.use_tiles)) as pbar:
        pbar.set_description(f"Finding overlap between tiles in round {r} (ref_round)")
        for t in nbp_basic.use_tiles:
            # align to south neighbour followed by west neighbour
            t_neighb['south'] = np.where(np.sum(nbp_basic.tilepos_yx == nbp_basic.tilepos_yx[t, :] + [1, 0],
                                                axis=1) == 2)[0]
            t_neighb['west'] = np.where(np.sum(nbp_basic.tilepos_yx == nbp_basic.tilepos_yx[t, :] + [0, 1],
                                               axis=1) == 2)[0]
            for j in directions:
                pbar.set_postfix({'tile': t, 'direction': j})
                if t_neighb[j] in nbp_basic.use_tiles:
                    shift, score, score_thresh = compute_shift(spot_yxz(spot_details, t, r, c),
                                                               spot_yxz(spot_details, t_neighb[j][0], r, c),
                                                               config['shift_score_thresh'],
                                                               config['shift_score_thresh_multiplier'],
                                                               config['shift_score_thresh_min_dist'],
                                                               config['shift_score_thresh_max_dist'],
                                                               config['neighb_dist_thresh'], shifts[j]['y'],
                                                               shifts[j]['x'], shifts[j]['z'],
                                                               config['shift_widen'], config['shift_max_range'],
                                                               z_scale, config['nz_collapse'],
                                                               config['shift_step'][2])[:3]
                    shift_info[j]['pairs'] = np.append(shift_info[j]['pairs'],
                                                       np.array([t, t_neighb[j][0]]).reshape(1, 2), axis=0)
                    shift_info[j]['shifts'] = np.append(shift_info[j]['shifts'], np.array(shift).reshape(1, 3), axis=0)
                    shift_info[j]['score'] = np.append(shift_info[j]['score'], np.array(score).reshape(1, 1), axis=0)
                    shift_info[j]['score_thresh'] = np.append(shift_info[j]['score_thresh'],
                                                              np.array(score_thresh).reshape(1, 1), axis=0)
                    good_shifts = (shift_info[j]['score'] > shift_info[j]['score_thresh']).flatten()
                    if np.sum(good_shifts) >= 3:
                        # once found shifts, refine shifts to be searched around these
                        for i in range(len(coords)):
                            shifts[j][coords[i]] = update_shifts(shifts[j][coords[i]],
                                                                 shift_info[j]['shifts'][good_shifts, i])
                pbar.update(1)
    pbar.close()

    # amend shifts for which score fell below score_thresh
    for j in directions:
        good_shifts = (shift_info[j]['score'] > shift_info[j]['score_thresh']).flatten()
        for i in range(len(coords)):
            # change shift search to be near good shifts found
            # this will only do something if 3>sum(good_shifts)>0, otherwise will have been done in previous loop.
            if np.sum(good_shifts) > 0:
                shifts[j][coords[i]] = update_shifts(shifts[j][coords[i]], shift_info[j]['shifts'][good_shifts, i])
            elif good_shifts.size > 0:
                shifts[j][coords[i]] = update_shifts(shifts[j][coords[i]], shift_info[j]['shifts'][:, i])
        # add outlier variable to shift_info to keep track of those shifts which are changed.
        shift_info[j]['outlier_shifts'] = shift_info[j]['shifts'].copy()
        shift_info[j]['outlier_score'] = shift_info[j]['score'].copy()
        shift_info[j]['outlier_shifts'][good_shifts, :] = 0
        shift_info[j]['outlier_score'][good_shifts, :] = 0
        if (np.sum(good_shifts) < 2 and len(good_shifts) > 4) or (np.sum(good_shifts) == 0 and len(good_shifts) > 0):
            warnings.warn(f"{len(good_shifts) - np.sum(good_shifts)}/{len(good_shifts)}"
                          f" of shifts fell below score threshold")
        for i in np.where(good_shifts == False)[0]:
            t = shift_info[j]['pairs'][i, 0]
            t_neighb = shift_info[j]['pairs'][i, 1]
            # re-find shifts that fell below threshold by only looking at shifts near to others found
            # Don't allow any widening so shift found must be in this range.
            # score_thresh given is 0, so it is not re-computed.
            shift_info[j]['shifts'][i], shift_info[j]['score'][i] = \
                compute_shift(spot_yxz(spot_details, t, r, c), spot_yxz(spot_details, t_neighb, r, c), 0, None, None,
                              None, config['neighb_dist_thresh'], shifts[j]['y'], shifts[j]['x'], shifts[j]['z'],
                              None, None, z_scale, config['nz_collapse'], config['shift_step'][2])[:2]
            warnings.warn(f"\nShift from tile {t} to tile {t_neighb} changed from\n"
                          f"{shift_info[j]['outlier_shifts'][i]} to {shift_info[j]['shifts'][i]}.")

    # get tile origins in global coordinates.
    # global coordinates are built about central tile so found this first
    tile_dist_to_centre = np.linalg.norm(nbp_basic.tilepos_yx[nbp_basic.use_tiles] -
                                         np.mean(nbp_basic.tilepos_yx, axis=0), axis=1)
    centre_tile = nbp_basic.use_tiles[tile_dist_to_centre.argmin()]
    tile_origin = get_tile_origin(shift_info['south']['pairs'], shift_info['south']['shifts'],
                                  shift_info['west']['pairs'], shift_info['west']['shifts'],
                                  nbp_basic.n_tiles, centre_tile)
    if nbp_basic.is_3d is False:
        tile_origin[:, 2] = 0  # set z coordinate to 0 for all tiles if 2d

    # add tile origin to debugging notebook so don't have whole page for one variable,
    # and need to add other rounds to it in registration stage anyway.
    nbp_debug.tile_origin = tile_origin
    # save all shift info to debugging page
    for j in directions:
        nbp_debug.__setattr__(j + '_' + 'final_shift_search', np.zeros((3, 3), dtype=int))
        nbp_debug.__getattribute__(j + '_' + 'final_shift_search')[:, 0] = \
            [np.min(shifts[j][key]) for key in shifts[j].keys()]
        nbp_debug.__getattribute__(j + '_' + 'final_shift_search')[:, 1] = [np.max(shifts[j][key]) for key in
                                                                            shifts[j].keys()]
        nbp_debug.__getattribute__(j + '_' + 'final_shift_search')[:, 2] = \
            nbp_debug.__getattribute__(j + '_' + 'start_shift_search')[:, 2]
        for var in shift_info[j].keys():
            nbp_debug.__setattr__(j + '_' + var, shift_info[j][var])
    return nbp_debug