Skip to content

Patch Specs

Source

A module to contain patch specification structures.

PatchSpecs

Bases: TypedDict

A dictionary that specifies a single patch in a series of ImageStacks.

Attributes:

  • data_idx (int) –

    Determines which ImageStack a patch belongs to, within a series of ImageStacks.

  • sample_idx (int) –

    Determines which sample a patch belongs to, within an ImageStack.

  • coords (sequence of int) –

    The top-left (and first z-slice for 3D data) of a patch. The sequence will have length 2 or 3, for 2D and 3D data respectively.

  • patch_size (sequence of int) –

    The size of the patch. The sequence will have length 2 or 3, for 2D and 3D data respectively.

TileSpecs

Bases: PatchSpecs

A dictionary that specifies a single patch in a series of ImageStacks.

Attributes:

  • data_idx (int) –

    Determines which ImageStack a patch belongs to, within a series of ImageStacks.

  • sample_idx (int) –

    Determines which sample a patch belongs to, within an ImageStack.

  • coords (sequence of int) –

    The top-left (and first z-slice for 3D data) of a patch. The sequence will have length 2 or 3, for 2D and 3D data respectively.

  • patch_size (sequence of int) –

    The size of the patch. The sequence will have length 2 or 3, for 2D and 3D data respectively.

  • crop_coords (sequence of int) –

    The top-left side of where the tile will be cropped, in coordinates relative to the tile.

  • crop_size (sequence of int) –

    The size of the cropped tile.

  • stitch_coords (sequence of int) –

    Where the tile will be stitched back into an image, taking into account that the tile will be cropped, in coords relative to the image.

  • total_tiles (int) –

    Number of tiles belonging to the same data.

UncorrelatedPatchSpecs

Bases: PatchSpecs

Each channel comes from a different location in the dataset.

This kind of patch can be used in the MicroSplit training pipeline.

Attributes:

  • principal_channel (int) –

    An index that represents the channel that the main patch specs describe.

  • all_data_idx (Sequence[int]) –

    A sequence that contains the data index that each channel patch belongs to.

  • all_sample_idx (Sequence[int]) –

    A sequence that contains the sample index that each channel patch belongs to.

  • all_coords (Sequence[Sequence[int]]) –

    The coordinate of each channel patch.

is_tile_specs(specs)

Determine whether a given PatchSpecs is a TileSpecs.

Used for type checking.

Parameters:

Returns:

  • bool

    Whether the given specs is a TileSpecs.

is_uncorrelated_specs(specs)

Determine whether a given PatchSpecs is an UncorrelatedPatchSpecs.

Parameters:

  • specs (PatchSpecs) –

    Patch specification to test.

Returns:

  • bool

    Whether the patch specification contains uncorrelated patch metadata.