satellit_sam.predict

Auto-generated from satellit_sam/src/satellit_sam/predict.py by satellit_sam/scripts/generate_api_docs.py.

Tile-based prediction helpers for running SAM inference over large images.

Back to API index

Functions

process_tiles

async def process_tiles(
    image,
    output_dir="tiles_output",
    initial_offset=[0, 0],
    max_tiles=None,
    tile_size=1024,
    overlap=256,
    use_cache=True,
    prompt: str | None = None,
) -> AsyncIterable[TileInfo | ProcessInfo]:
Process large image in tiles with SAM and persist per-tile outputs.

Arguments

  • image: Input image as a numpy RGB array. output_dir: Directory where processed tiles are written. initial_offset: Starting offset ``[x, y]`` in tile units. max_tiles: Optional maximum number of tiles to process. tile_size: Size of each square tile in pixels. overlap: Overlap between adjacent tiles in pixels. use_cache: Whether to skip existing tile outputs in ``output_dir``. prompt: Optional text prompt passed to SAM.

Returns

  • ```TileInfoentries during processing, followed by oneProcessInfo``.`

Classes

ProcessInfo

Summary metrics emitted after tile processing completes.

Attributes

  • original_shape: tuple[int, int, int]
  • output_dir: str
  • tile_overlap: int
  • tile_size: int
  • tiles_processed: int
  • tiles_skipped: int
  • total_prediction_time: float

Methods

No public methods detected.

TileFile

Metadata and naming helpers for tile artifacts on disk.

Attributes

  • FILE_TYPES
  • output_dir: str
  • overlap: int
  • position: tuple[int, int]
  • tile_idx: int
  • tile_size: int

Methods

filename
def filename(self, file_type: Literal["png"] | Literal["npz"]) -> str:
Return the output filename for the tile artifact.

Arguments

  • file_type: Artifact extension, either ``png`` or ``npz``.

Returns

  • Absolute or relative artifact path under ``output_dir``.
parse_filename
def parse_filename(filepath: str) -> "TileFile | None":
Parse a tile artifact filename into a ``TileFile`` instance.

Arguments

  • filepath: Tile artifact path following the naming convention.

Returns

  • Parsed tile metadata, or ``None`` when the path does not match.

TileInfo

Progress payload emitted after each processed tile.

Attributes

  • number_of_masks: int
  • prediction_time: float
  • tiles_processed: int
  • tiles_skipped: int
  • total_prediction_time: float
  • total_tiles: int

Methods

No public methods detected.

Previoussatellit_sam.plot Nextsatellit_sam.prompts