aimbat._types
Custom types used in AIMBAT.
Type Aliases:
| Name | Description |
|---|---|
EventParameterBool |
|
EventParameterFloat |
|
EventParameterTimedelta |
|
Classes:
| Name | Description |
|---|---|
EventParameter |
|
SAPandasTimedelta |
SQLAlchemy TypeDecorator for pandas.Timedelta. |
SAPandasTimestamp |
SQLAlchemy TypeDecorator for pandas.Timestamp. |
SeismogramParameter |
|
EventParameterBool
EventParameterBool = Literal[COMPLETED, BANDPASS_APPLY]
TypeAlias for AimbatEvent attributes with bool values.
EventParameterFloat
EventParameterFloat = Literal[
MIN_CCNORM, BANDPASS_FMIN, BANDPASS_FMAX
]
TypeAlias for AimbatEvent attributes with float values.
EventParameterTimedelta
EventParameterTimedelta = Literal[WINDOW_PRE, WINDOW_POST]
TypeAlias for AimbatEvent attributes with [Timedelta][pandas.Timedelta] values.
EventParameter
Bases: StrEnum
AimbatEvent enum class for typing.
This enum class is used for typing, cli args etc. The attributes must be
the same as in the AimbatEvent model.
Source code in src/aimbat/_types/_event.py
SAPandasTimedelta
Bases: TypeDecorator
SQLAlchemy TypeDecorator for pandas.Timedelta. Stores duration as an integer of nanoseconds for maximum precision.
Source code in src/aimbat/_types/_sqlalchemy.py
SAPandasTimestamp
Bases: TypeDecorator
SQLAlchemy TypeDecorator for pandas.Timestamp. Ensures timezone-aware UTC storage in a DateTime column.
Source code in src/aimbat/_types/_sqlalchemy.py
SeismogramParameter
Bases: StrEnum
AimbatSeismograParameters enum class for typing.
This enum class is used for typing, cli args etc. The attributes must be
the same as in the [AimbatParameters][aimbat.models.AimbatParameters] model.