Interfaces

siapy.entities.images.interfaces

ImageBase

Bases: ABC

filepath abstractmethod property

filepath: Path

metadata abstractmethod property

metadata: dict[str, Any]

shape abstractmethod property

shape: tuple[int, int, int]

bands abstractmethod property

bands: int

default_bands abstractmethod property

default_bands: list[int]

wavelengths abstractmethod property

wavelengths: list[float]

camera_id abstractmethod property

camera_id: str

open abstractmethod classmethod

open(*args: Any, **kwargs: Any) -> ImageBase

Source code in siapy/entities/images/interfaces.py

@classmethod
@abstractmethod
def open(cls: type["ImageBase"], *args: Any, **kwargs: Any) -> "ImageBase":
    pass

to_display abstractmethod

to_display(equalize: bool = True) -> Image

Source code in siapy/entities/images/interfaces.py

@abstractmethod
def to_display(self, equalize: bool = True) -> Image.Image:
    pass

to_numpy abstractmethod

to_numpy(
    nan_value: float | None = None,
) -> NDArray[floating[Any]]

Source code in siapy/entities/images/interfaces.py

@abstractmethod
def to_numpy(self, nan_value: float | None = None) -> NDArray[np.floating[Any]]:
    pass

to_xarray abstractmethod

to_xarray() -> XarrayType

Source code in siapy/entities/images/interfaces.py

@abstractmethod
def to_xarray(self) -> "XarrayType":
    pass