Module: sarpyx.cli.utils

File: sarpyx/cli/utils.py

Utility functions for SARPyX CLI tools. This module provides common utility functions used across multiple CLI commands.

Exported Symbols (__all__)

No explicit __all__ list. Public symbols inferred from implementation.

Public Functions (8)

validate_path(path: Union[str, Path], must_exist: bool=True) -> Path

from sarpyx.cli.utils import validate_path

result = validate_path(path=<path>)

create_output_directory(output_dir: Union[str, Path]) -> Path

from sarpyx.cli.utils import create_output_directory

result = create_output_directory(output_dir=<output_dir>)

check_snap_installation(gpt_path: Optional[str]=None) -> bool

from sarpyx.cli.utils import check_snap_installation

result = check_snap_installation()

print_processing_summary(product_path: str, output_path: str, parameters: Dict[str, Union[str, float, bool, List[str]]]) -> None

from sarpyx.cli.utils import print_processing_summary

result = print_processing_summary(product_path=<product_path>, output_path=<output_path>, parameters=<parameters>)

format_file_size(size_bytes: int) -> str

from sarpyx.cli.utils import format_file_size

result = format_file_size(size_bytes=<size_bytes>)

get_product_info(product_path: Union[str, Path]) -> Dict[str, str]

from sarpyx.cli.utils import get_product_info

result = get_product_info(product_path=<product_path>)

validate_window_sizes(target_window: float, guard_window: float, background_window: float) -> None

from sarpyx.cli.utils import validate_window_sizes

result = validate_window_sizes(target_window=<target_window>, guard_window=<guard_window>, background_window=<background_window>)

estimate_processing_time(product_path: Union[str, Path]) -> str

from sarpyx.cli.utils import estimate_processing_time

result = estimate_processing_time(product_path=<product_path>)

Public Classes (0)

No public classes detected.