Skip to content

aimbat.aimbat_types

Custom types used in AIMBAT.

Type Aliases:

Name Description
EventParameterBool

TypeAlias for [AimbatEvent][aimbat.lib.models.AimbatEvent] attributes with bool values.

EventParameterFloat

TypeAlias for [AimbatEvent][aimbat.lib.models.AimbatEvent] attributes with float values.

EventParameterTimedelta

TypeAlias for [AimbatEvent][aimbat.lib.models.AimbatEvent] attributes with [Timedelta][pandas.Timedelta] values.

Classes:

Name Description
DataType

Valid AIMBAT data types.

EventParameter

[AimbatEvent][aimbat.lib.models.AimbatEvent] enum class for typing.

SeismogramParameter

[AimbatSeismograParameters][aimbat.lib.models.AimbatSeismogramParameters] enum class for typing.

EventParameterBool

EventParameterBool = Literal[COMPLETED, BANDPASS_APPLY]

TypeAlias for [AimbatEvent][aimbat.lib.models.AimbatEvent] attributes with bool values.

EventParameterFloat

EventParameterFloat = Literal[
    MIN_CCNORM, BANDPASS_FMIN, BANDPASS_FMAX
]

TypeAlias for [AimbatEvent][aimbat.lib.models.AimbatEvent] attributes with float values.

EventParameterTimedelta

EventParameterTimedelta = Literal[WINDOW_PRE, WINDOW_POST]

TypeAlias for [AimbatEvent][aimbat.lib.models.AimbatEvent] attributes with [Timedelta][pandas.Timedelta] values.

DataType

Bases: StrEnum

Valid AIMBAT data types.

Source code in src/aimbat/aimbat_types/_data.py
class DataType(StrEnum):
    """Valid AIMBAT data types."""

    SAC = auto()

EventParameter

Bases: StrEnum

[AimbatEvent][aimbat.lib.models.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][aimbat.lib.models.AimbatEvent] model.

Source code in src/aimbat/aimbat_types/_event.py
class EventParameter(StrEnum):
    """[`AimbatEvent`][aimbat.lib.models.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`][aimbat.lib.models.AimbatEvent] model.
    """

    COMPLETED = auto()
    MIN_CCNORM = auto()
    WINDOW_PRE = auto()
    WINDOW_POST = auto()
    BANDPASS_APPLY = auto()
    BANDPASS_FMIN = auto()
    BANDPASS_FMAX = auto()

SeismogramParameter

Bases: StrEnum

[AimbatSeismograParameters][aimbat.lib.models.AimbatSeismogramParameters] 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.lib.models.AimbatParameters] model.

Source code in src/aimbat/aimbat_types/_seismogram.py
class SeismogramParameter(StrEnum):
    """[`AimbatSeismograParameters`][aimbat.lib.models.AimbatSeismogramParameters] 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.lib.models.AimbatParameters] model.
    """

    SELECT = auto()
    FLIP = auto()
    T1 = auto()