satellit_sam.main

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

Top-level orchestration for tiling and SAM mask prediction.

Back to API index

Functions

predict_masks

def predict_masks(
    image_path: Path,
    tile_size: int,
    overlap: int,
    output_path: Path,
    text_prompt: str | None,
    bbox_prompts: list[tuple[float, float, float, float]],
    weak_label_bboxes_by_tile: dict[str, list[tuple[float, float, float, float]]]
    | None = None,
) -> None:
Run tiled prediction using sync entrypoint.

Arguments

  • image_path: Path to the source image. tile_size: Tile width/height in pixels. overlap: Tile overlap in pixels. output_path: Directory where outputs are written. text_prompt: Optional text prompt for SAM. bbox_prompts: Image-space box prompts. weak_label_bboxes_by_tile: Optional tile-local boxes from weak labels.

predict_masks_async

async def predict_masks_async(
    image_path: Path,
    tile_size: int,
    overlap: int,
    output_path: Path,
    text_prompt: str | None,
    bbox_prompts: list[tuple[float, float, float, float]],
    weak_label_bboxes_by_tile: dict[str, list[tuple[float, float, float, float]]]
    | None = None,
) -> None:
Run tiled SAM prediction workflow asynchronously.

Arguments

  • image_path: Path to the source image. tile_size: Tile width/height in pixels. overlap: Tile overlap in pixels. output_path: Directory where outputs are written. text_prompt: Optional text prompt for SAM. bbox_prompts: Image-space box prompts. weak_label_bboxes_by_tile: Optional tile-local boxes from weak labels.

main

def main(argv: list[str] | None = None) -> None:
Run the CLI root command.

Arguments

  • argv: Optional argument list for programmatic invocation.

Classes

No public classes.