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 argumentformatter (
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.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 serializeinclude_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.EmbeddingImage[source]¶
Bases:
TypedDict
-
image_embedding:
ndarray
¶
-
transform_matrix:
ndarray
¶
-
image_embedding:
- 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
])¶
-
image_embedding:
- 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.TupleFloatAny(iterable=(), /)[source]¶
Bases:
tuple
[float
,any
]
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
Module contents¶
various helpers functions