samgis_core.utilities package

Submodules

samgis_core.utilities.constants module

Project constants

samgis_core.utilities.fastapi_logger module

samgis_core.utilities.fastapi_logger.setup_logging(debug=False, formatter='{time} - {level} - {file} - {function} - ({extra[request_id]}) {message} ')[source]

Create a logging instance with log string formatter.

Parameters:

  • debug (bool, default: False) – logging debug argument

  • formatter (str, default: '{time} - {level} - {file} - {function} - ({extra[request_id]}) {message} ') – log string formatter

Return type:

Logger

Returns:

Logger

samgis_core.utilities.plot_images module

samgis_core.utilities.plot_images.helper_imshow_output_expected(img1, img2, title1, title2)[source]

samgis_core.utilities.serialize module

Serialize objects

samgis_core.utilities.serialize.serialize(obj, include_none=False)[source]

Return the input object into a serializable one

Parameters:

  • obj (any) – Object to serialize

  • include_none (bool, default: False) – bool to indicate if include also keys with None values during dict serialization

Returns:

serialized object

samgis_core.utilities.type_hints module

custom type hints

class samgis_core.utilities.type_hints.DictStr[source]

Bases: dict[str]

class samgis_core.utilities.type_hints.DictStrAny[source]

Bases: dict[str, any]

class samgis_core.utilities.type_hints.DictStrInt[source]

Bases: dict[str, int]

class samgis_core.utilities.type_hints.EmbeddingImage[source]

Bases: TypedDict

image_embedding: ndarray
original_size: TupleInt
transform_matrix: ndarray
class samgis_core.utilities.type_hints.EmbeddingPILImage[source]

Bases: TypedDict

image_embedding: ndarray
original_size: NewType(TupleInt, tuple[int, int])
resized_size: NewType(TupleInt, tuple[int, int])
class samgis_core.utilities.type_hints.ListDict(iterable=(), /)[source]

Bases: list[dict]

class samgis_core.utilities.type_hints.ListFloat(iterable=(), /)[source]

Bases: list[float]

class samgis_core.utilities.type_hints.ListInt(iterable=(), /)[source]

Bases: list[int]

class samgis_core.utilities.type_hints.LlistFloat(iterable=(), /)[source]

Bases: ListFloat

class samgis_core.utilities.type_hints.StrEnum(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

class samgis_core.utilities.type_hints.TupleFloat(iterable=(), /)[source]

Bases: tuple[float]

class samgis_core.utilities.type_hints.TupleFloatAny(iterable=(), /)[source]

Bases: tuple[float, any]

class samgis_core.utilities.type_hints.TupleInt(iterable=(), /)[source]

Bases: tuple[int]

class samgis_core.utilities.type_hints.TupleNdarrayFloat(iterable=(), /)[source]

Bases: tuple[ndarray, float]

class samgis_core.utilities.type_hints.TupleNdarrayInt(iterable=(), /)[source]

Bases: tuple[ndarray, int]

samgis_core.utilities.utilities module

Various utilities (logger, time benchmark, args dump, numerical and stats info)

samgis_core.utilities.utilities.apply_coords(coords, embedding)[source]

Expects a numpy np_array of length 2 in the final dimension. Requires the original image size in (H, W) format.

samgis_core.utilities.utilities.base64_decode(s)[source]

Decode base64 strings

Parameters:

s – input string

Returns:

decoded string

samgis_core.utilities.utilities.base64_encode(sb)[source]

Encode input strings or bytes as base64

Parameters:

sb (str | bytes) – input string or bytes

Return type:

bytes

Returns:

base64 encoded bytes

samgis_core.utilities.utilities.convert_ndarray_to_pil(pil_image)[source]
samgis_core.utilities.utilities.hash_calculate(arr)[source]

Return computed hash from input variable (typically a numpy array).

Parameters:

arr – input variable

Return type:

str | bytes

Returns:

computed hash from input variable

Module contents

various helpers functions