satellit_sam.core.tiling
satellit_sam.core.tiling
Auto-generated from
satellit_sam/src/satellit_sam/core/tiling.pybysatellit_sam/scripts/generate_api_docs.py.
Utilities for tiling images and reconstructing stitched outputs.
Functions
iter_tile_geometries
def iter_tile_geometries(
image_shape: tuple[int, int], tile_size: tuple[int, int], overlap: tuple[int, int]
) -> Iterator[TileGeometry]:
Yield tile windows for an image.
Arguments
image_shape: Full image size as ``(width, height)``. tile_size: Tile size as ``(width, height)``. overlap: Neighbor overlap as ``(x_overlap, y_overlap)``.
Returns
Tile windows covering the input image in scanline order.
tile_image
def tile_image(
image: Image,
tile_size: int | tuple[int, int],
overlap: int | tuple[int, int],
output_path: str,
) -> "TilesDir":
Tile an image and persist tiles under ``output_path``.
Arguments
image: Source image to split. tile_size: Square tile size or ``(width, height)``. overlap: Scalar overlap or ``(x_overlap, y_overlap)``. output_path: Directory that receives tile outputs.
Returns
Tile directory descriptor for reading/writing metadata and tiles.
Classes
Tile
One image tile and the source file path on disk.
Attributes
image: Imagepath: str
Methods
No public methods detected.
TileGeometry
Pixel bounds for a tile in the original image.
Attributes
end: tuple[int, int]start: tuple[int, int]
Methods
No public methods detected.
TilesDir
Directory abstraction for tiled images and reconstruction metadata.
Tile directory structure:
- tiles_rgb/
- metadata.json
{
"original_shape": [height, width, channels],
"tile_size": [1024, 1024],
"overlap": [256, 256],
}
Attributes
original_shape: tuple[int, int, int]output_path: stroverlap: tuple[int, int]tile_size: tuple[int, int]
Methods
load_from_dir
def load_from_dir(output_path: str) -> "TilesDir":
Load tile metadata from an existing output directory.
Arguments
output_path: Directory containing ``metadata.json``.
Returns
Loaded tile directory descriptor.
save_to_dir
def save_to_dir(self) -> None:
Write tile metadata to metadata.json in output_path.
save_annotated_tile
def save_annotated_tile(self, tile: Tile, annotated_image: Image) -> None:
Save an annotated tile image with the same tile filename.
Arguments
tile: Tile containing path metadata for naming. annotated_image: Tile-sized annotated image to persist.
reconstruct_image
def reconstruct_image(self) -> Image:
Reconstruct a blended image from saved RGB tile files.
Returns
Reconstructed RGBA image composed from all available tiles.
tiles_rgb_path
def tiles_rgb_path(self) -> str:
Get path to RGB tiles directory.
tiles_annotated_path
def tiles_annotated_path(self) -> str:
Get path to annotated tiles directory.
get_tile_positions
def get_tile_positions(self) -> set[tuple[int, int]]:
Get set of (x, y) positions for processed tile files.