aimbat.models
ORM classes mapping to AIMBAT database tables.
Each class in this module corresponds to a table in the SQLite project database and is built on SQLModel, which combines SQLAlchemy (for database access) with Pydantic (for validation).
The main classes and their relationships are:
AimbatEvent— a seismic event.AimbatStation— a seismic recording station.AimbatSeismogram— links anAimbatEventto anAimbatStationand holds the timing metadata (begin_time,delta,t0). Waveform data are accessed via the associatedAimbatDataSource.AimbatDataSource— identifies the logical source of the waveform data for a seismogram and its type (e.g. SAC).AimbatEventParameters— processing parameters shared across all seismograms of an event (window bounds, bandpass filter settings, MCCC settings, etc.).AimbatSeismogramParameters— per-seismogram processing parameters (flip,select, working pickt1).AimbatSnapshot— captures a point-in-time copy of event and seismogram parameters viaAimbatEventParametersSnapshotandAimbatSeismogramParametersSnapshot, enabling rollback and comparison.AimbatEventQuality/AimbatSeismogramQuality— live quality metrics updated during processing;AimbatSeismogramQualitystores the ICCS cross-correlation coefficienticcs_ccand MCCC per-seismogram metrics;AimbatEventQualitystores the MCCC global RMSE.AimbatEventQualitySnapshot/AimbatSeismogramQualitySnapshot— point-in-time copies of quality metrics captured alongside parameter snapshots.
Type Aliases:
| Name | Description |
|---|---|
AimbatTypes |
Union of all AIMBAT models that exist in the database. |
Classes:
| Name | Description |
|---|---|
AimbatDataSource |
Logical source identifier and format of the waveform data for a seismogram. |
AimbatEvent |
Seismic event with origin time, location, and depth. |
AimbatEventParameters |
Processing parameters common to all seismograms of a particular event. |
AimbatEventParametersBase |
Base class defining event-level processing parameters for AIMBAT. |
AimbatEventParametersSnapshot |
Snapshot of processing parameters for a particular event. |
AimbatEventQuality |
Live quality metrics for a seismic event. |
AimbatEventQualityBase |
Base class defining event-level quality metrics. |
AimbatEventQualitySnapshot |
Snapshot of quality metrics for a seismic event. |
AimbatEventRead |
Read model for AimbatEvent including computed counts. |
AimbatNote |
Free-text Markdown note attached to an event, station, seismogram, or snapshot. |
AimbatSeismogram |
Seismogram metadata linking a recording station to an event. |
AimbatSeismogramParameters |
Processing parameters for a single seismogram. |
AimbatSeismogramParametersBase |
Base class defining seismogram-level processing parameters for AIMBAT. |
AimbatSeismogramParametersSnapshot |
Snapshot of processing parameters for a single seismogram. |
AimbatSeismogramQuality |
Live quality metrics for a single seismogram. |
AimbatSeismogramQualityBase |
Base class defining seismogram-level quality metrics. |
AimbatSeismogramQualitySnapshot |
Snapshot of quality metrics for a single seismogram. |
AimbatSeismogramRead |
Read model for AimbatSeismogram including parameters. |
AimbatSnapshot |
Container for a point-in-time snapshot of event and seismogram parameters. |
AimbatSnapshotRead |
Read model for AimbatSnapshot with a seismogram count. |
AimbatStation |
Recording station with network, location, and channel metadata. |
AimbatStationRead |
Read model for AimbatStation including aggregated quality statistics. |
SeismogramQualityStats |
Aggregated seismogram quality statistics for an event or station. |
SnapshotResults |
Full results export for a snapshot. |
SnapshotSeismogramResult |
Per-seismogram result record from a snapshot. |
Functions:
| Name | Description |
|---|---|
undefer_counts |
Loader options that fetch |
AimbatTypes
AimbatTypes = (
AimbatDataSource
| AimbatNote
| AimbatStation
| AimbatEvent
| AimbatEventParameters
| AimbatEventQuality
| AimbatSeismogram
| AimbatSeismogramParameters
| AimbatSeismogramQuality
| AimbatSnapshot
| AimbatEventParametersSnapshot
| AimbatEventQualitySnapshot
| AimbatSeismogramParametersSnapshot
| AimbatSeismogramQualitySnapshot
)
Union of all AIMBAT models that exist in the database.
AimbatDataSource
Bases: SQLModel
Logical source identifier and format of the waveform data for a seismogram.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
UUID
|
Unique data source ID. |
UUID('b9c5d821-9f38-4667-9c81-44e6e6fab96f')
|
sourcename
|
str
|
Opaque logical source identifier for the waveform data. Uniqueness is enforced as plain string equality, not canonicalised, so a file-based source reachable under two different (but equivalent) path spellings is not recognised as the same source - callers are responsible for canonicalising before storing. |
required |
datatype
|
DataType
|
Data type of the data source. |
<DataType.SAC: 'sac'>
|
seismogram_id
|
UUID
|
Foreign key referencing the parent seismogram. |
None
|
Attributes:
| Name | Type | Description |
|---|---|---|
seismogram |
AimbatSeismogram
|
The seismogram this data source belongs to. |
Source code in src/aimbat/models/_models.py
seismogram
class-attribute
instance-attribute
seismogram: AimbatSeismogram = Relationship(
back_populates="datasource"
)
The seismogram this data source belongs to.
AimbatEvent
Bases: SQLModel
Seismic event with origin time, location, and depth.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
UUID
|
Unique event ID. |
UUID('47369ad6-b521-416c-8e67-b05e497a7438')
|
time
|
PydanticTimestamp
|
Event origin time (UTC). |
required |
latitude
|
float
|
Event latitude in degrees. |
required |
longitude
|
float
|
Event longitude in degrees. |
required |
depth
|
float | None
|
Event depth in metres. |
None
|
last_modified
|
PydanticTimestamp | None
|
Timestamp of the last parameter modification. |
None
|
stack_modified
|
PydanticTimestamp | None
|
Timestamp of the last change to a parameter that requires the ICCS instance to be rebuilt (event window, ramp, bandpass, corners; per-seismogram t1, flip, select). Drives |
None
|
Attributes:
| Name | Type | Description |
|---|---|---|
parameters |
AimbatEventParameters
|
Event parameters. |
quality |
AimbatEventQuality | None
|
Live quality metrics for this event. |
seismograms |
list[AimbatSeismogram]
|
List of seismograms of this event. |
snapshots |
list[AimbatSnapshot]
|
List of snapshots. |
Source code in src/aimbat/models/_models.py
parameters
class-attribute
instance-attribute
parameters: AimbatEventParameters = Relationship(
back_populates="event", cascade_delete=True
)
Event parameters.
quality
class-attribute
instance-attribute
quality: AimbatEventQuality | None = Relationship(
back_populates="event", cascade_delete=True
)
Live quality metrics for this event.
seismograms
class-attribute
instance-attribute
seismograms: list[AimbatSeismogram] = Relationship(
back_populates="event", cascade_delete=True
)
List of seismograms of this event.
snapshots
class-attribute
instance-attribute
snapshots: list[AimbatSnapshot] = Relationship(
back_populates="event", cascade_delete=True
)
List of snapshots.
AimbatEventParameters
Bases: AimbatEventParametersBase
Processing parameters common to all seismograms of a particular event.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
completed
|
bool
|
Mark an event as completed. |
False
|
ramp_width
|
PydanticNonNegativeFloat
|
Width of taper ramp as a multiple of the window length. Values greater than 1 are valid; the ramp extends outside the window. |
0.1
|
window_pre
|
PydanticNegativeTimedelta
|
Pre-pick window length in seconds. |
Timedelta('-1 days +23:59:45')
|
window_post
|
PydanticPositiveTimedelta
|
Post-pick window length in seconds. |
Timedelta('0 days 00:00:15')
|
bandpass_apply
|
bool
|
Whether to apply bandpass filter to seismograms. |
False
|
bandpass_fmin
|
float
|
Minimum frequency for bandpass filter in Hz (ignored if |
0.05
|
bandpass_fmax
|
float
|
Maximum frequency for bandpass filter in Hz (ignored if |
2.0
|
corners
|
int
|
Number of corners (poles) for the bandpass filter (ignored if |
2
|
min_cc
|
float
|
Minimum cross-correlation used when automatically de-selecting seismograms. |
0.5
|
mccc_damp
|
float
|
Damping factor for MCCC algorithm. |
0.1
|
mccc_min_cc
|
float
|
Minimum correlation coefficient required to include a pair in the MCCC inversion. |
0.5
|
id
|
UUID
|
Unique ID. |
UUID('b37d9557-66bd-4285-91c8-f2a6e542fcf9')
|
event_id
|
UUID
|
Foreign key referencing the parent event. |
None
|
Methods:
| Name | Description |
|---|---|
check_freq_range |
Validate that |
Attributes:
| Name | Type | Description |
|---|---|---|
event |
AimbatEvent
|
The event these parameters belong to. |
snapshots |
list[AimbatEventParametersSnapshot]
|
Parameter snapshots for this event. |
Source code in src/aimbat/models/_models.py
event
class-attribute
instance-attribute
event: AimbatEvent = Relationship(
back_populates="parameters"
)
The event these parameters belong to.
snapshots
class-attribute
instance-attribute
snapshots: list[AimbatEventParametersSnapshot] = (
Relationship(
back_populates="parameters", passive_deletes=True
)
)
Parameter snapshots for this event.
check_freq_range
check_freq_range() -> Self
Validate that bandpass_fmax is strictly greater than bandpass_fmin.
Source code in src/aimbat/models/_parameters.py
AimbatEventParametersBase
Bases: SQLModel
Base class defining event-level processing parameters for AIMBAT.
This class serves as a base that is inherited by the actual classes that create the database tables. It covers the settings applied uniformly to all seismograms of an event: window bounds, taper ramp width, bandpass filter settings, the CC threshold for automatic de-selection, and MCCC settings.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
completed
|
bool
|
Mark an event as completed. |
False
|
ramp_width
|
PydanticNonNegativeFloat
|
Width of taper ramp as a multiple of the window length. Values greater than 1 are valid; the ramp extends outside the window. |
0.1
|
window_pre
|
PydanticNegativeTimedelta
|
Pre-pick window length in seconds. |
Timedelta('-1 days +23:59:45')
|
window_post
|
PydanticPositiveTimedelta
|
Post-pick window length in seconds. |
Timedelta('0 days 00:00:15')
|
bandpass_apply
|
bool
|
Whether to apply bandpass filter to seismograms. |
False
|
bandpass_fmin
|
float
|
Minimum frequency for bandpass filter in Hz (ignored if |
0.05
|
bandpass_fmax
|
float
|
Maximum frequency for bandpass filter in Hz (ignored if |
2.0
|
corners
|
int
|
Number of corners (poles) for the bandpass filter (ignored if |
2
|
min_cc
|
float
|
Minimum cross-correlation used when automatically de-selecting seismograms. |
0.5
|
mccc_damp
|
float
|
Damping factor for MCCC algorithm. |
0.1
|
mccc_min_cc
|
float
|
Minimum correlation coefficient required to include a pair in the MCCC inversion. |
0.5
|
Methods:
| Name | Description |
|---|---|
check_freq_range |
Validate that |
Source code in src/aimbat/models/_parameters.py
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 | |
check_freq_range
check_freq_range() -> Self
Validate that bandpass_fmax is strictly greater than bandpass_fmin.
Source code in src/aimbat/models/_parameters.py
AimbatEventParametersSnapshot
Bases: AimbatEventParametersBase
Snapshot of processing parameters for a particular event.
Frozen history: the source event is still reachable via
snapshot.event_id, and parameters_id is set to NULL if the live
parameter row is deleted.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
completed
|
bool
|
Mark an event as completed. |
False
|
ramp_width
|
PydanticNonNegativeFloat
|
Width of taper ramp as a multiple of the window length. Values greater than 1 are valid; the ramp extends outside the window. |
0.1
|
window_pre
|
PydanticNegativeTimedelta
|
Pre-pick window length in seconds. |
Timedelta('-1 days +23:59:45')
|
window_post
|
PydanticPositiveTimedelta
|
Post-pick window length in seconds. |
Timedelta('0 days 00:00:15')
|
bandpass_apply
|
bool
|
Whether to apply bandpass filter to seismograms. |
False
|
bandpass_fmin
|
float
|
Minimum frequency for bandpass filter in Hz (ignored if |
0.05
|
bandpass_fmax
|
float
|
Maximum frequency for bandpass filter in Hz (ignored if |
2.0
|
corners
|
int
|
Number of corners (poles) for the bandpass filter (ignored if |
2
|
min_cc
|
float
|
Minimum cross-correlation used when automatically de-selecting seismograms. |
0.5
|
mccc_damp
|
float
|
Damping factor for MCCC algorithm. |
0.1
|
mccc_min_cc
|
float
|
Minimum correlation coefficient required to include a pair in the MCCC inversion. |
0.5
|
id
|
UUID
|
Unique ID. |
UUID('24f32a5c-bde6-47e0-bbdd-b783b9a27d44')
|
snapshot_id
|
UUID
|
Foreign key referencing the parent snapshot. |
None
|
parameters_id
|
UUID | None
|
Foreign key referencing the source event parameters, or NULL if it has been deleted. |
None
|
Methods:
| Name | Description |
|---|---|
check_freq_range |
Validate that |
Attributes:
| Name | Type | Description |
|---|---|---|
parameters |
AimbatEventParameters | None
|
The event parameters this snapshot was taken from, if still present. |
snapshot |
AimbatSnapshot
|
The snapshot this record belongs to. |
Source code in src/aimbat/models/_models.py
parameters
class-attribute
instance-attribute
parameters: AimbatEventParameters | None = Relationship(
back_populates="snapshots"
)
The event parameters this snapshot was taken from, if still present.
snapshot
class-attribute
instance-attribute
snapshot: AimbatSnapshot = Relationship(
back_populates="event_parameters_snapshot"
)
The snapshot this record belongs to.
check_freq_range
check_freq_range() -> Self
Validate that bandpass_fmax is strictly greater than bandpass_fmin.
Source code in src/aimbat/models/_parameters.py
AimbatEventQuality
Bases: AimbatEventQualityBase
Live quality metrics for a seismic event.
One row per event. Updated in place whenever MCCC runs.
Fields are None until MCCC has been executed.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
mccc_rmse
|
PydanticNonNegativeTimedelta | None
|
Root-mean-square error of the MCCC inversion fit across the whole array. |
None
|
id
|
UUID
|
Unique ID. |
UUID('525bca9d-377b-4c0f-a154-ca647d9ee21f')
|
event_id
|
UUID
|
Foreign key referencing the parent event. |
None
|
Attributes:
| Name | Type | Description |
|---|---|---|
event |
AimbatEvent
|
The event these quality metrics belong to. |
snapshots |
list[AimbatEventQualitySnapshot]
|
Quality snapshots taken from this live record. |
Source code in src/aimbat/models/_models.py
event
class-attribute
instance-attribute
event: AimbatEvent = Relationship(back_populates='quality')
The event these quality metrics belong to.
snapshots
class-attribute
instance-attribute
snapshots: list[AimbatEventQualitySnapshot] = Relationship(
back_populates="quality", passive_deletes=True
)
Quality snapshots taken from this live record.
AimbatEventQualityBase
Bases: SQLModel
Base class defining event-level quality metrics.
Fields are None when the corresponding algorithm has not been run yet.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
mccc_rmse
|
PydanticNonNegativeTimedelta | None
|
Root-mean-square error of the MCCC inversion fit across the whole array. |
None
|
Source code in src/aimbat/models/_quality.py
AimbatEventQualitySnapshot
Bases: AimbatEventQualityBase
Snapshot of quality metrics for a seismic event.
Frozen history: the source event is still reachable via
snapshot.event_id, and event_quality_id is set to NULL if the live
quality row is deleted.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
mccc_rmse
|
PydanticNonNegativeTimedelta | None
|
Root-mean-square error of the MCCC inversion fit across the whole array. |
None
|
id
|
UUID
|
Unique ID. |
UUID('9f6e381a-bf6e-44c6-ba04-fc4513de7a94')
|
event_quality_id
|
UUID | None
|
Foreign key referencing the source event quality, or NULL if it has been deleted. |
None
|
snapshot_id
|
UUID
|
Foreign key referencing the parent snapshot. |
None
|
Attributes:
| Name | Type | Description |
|---|---|---|
quality |
AimbatEventQuality | None
|
The event quality this snapshot was taken from, if still present. |
snapshot |
AimbatSnapshot
|
The snapshot this record belongs to. |
Source code in src/aimbat/models/_models.py
quality
class-attribute
instance-attribute
quality: AimbatEventQuality | None = Relationship(
back_populates="snapshots"
)
The event quality this snapshot was taken from, if still present.
snapshot
class-attribute
instance-attribute
snapshot: AimbatSnapshot = Relationship(
back_populates="event_quality_snapshot"
)
The snapshot this record belongs to.
AimbatEventRead
Bases: BaseModel
Read model for AimbatEvent including computed counts.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
UUID
|
Unique identifier for the event |
required |
short_id
|
str | None
|
Shortened unique identifier |
None
|
completed
|
bool
|
Indicates if the event's parameters are marked as completed |
required |
time
|
PydanticTimestamp
|
Origin time of the event |
required |
latitude
|
float
|
Latitude of the event |
required |
longitude
|
float
|
Longitude of the event |
required |
depth
|
float | None
|
Depth of the event |
required |
seismogram_count
|
int
|
Number of seismograms associated with this event |
required |
station_count
|
int
|
Number of stations associated with this event |
required |
snapshot_count
|
int
|
Number of snapshots associated with this event |
required |
last_modified
|
PydanticTimestamp | None
|
Timestamp of the last modification of this event's parameters |
None
|
Methods:
| Name | Description |
|---|---|
from_event |
Create an AimbatEventRead from an AimbatEvent ORM instance. |
Source code in src/aimbat/models/_readers.py
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 | |
from_event
classmethod
from_event(
event: AimbatEvent, session: Session | None = None
) -> Self
Create an AimbatEventRead from an AimbatEvent ORM instance.
Source code in src/aimbat/models/_readers.py
AimbatNote
Bases: SQLModel
Free-text Markdown note attached to an event, station, seismogram, or snapshot.
Exactly one of the four FK fields is set per row, and at most one note exists per parent record (enforced by the per-FK partial unique indexes). Deletion of the parent record cascades to delete the note via the DB-level foreign key constraint.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
UUID
|
Unique note ID. |
UUID('e48021bc-3b21-4340-af43-feb371626aab')
|
content
|
str
|
Note content in Markdown format. |
''
|
event_id
|
UUID | None
|
Foreign key referencing the parent event. |
None
|
station_id
|
UUID | None
|
Foreign key referencing the parent station. |
None
|
seismogram_id
|
UUID | None
|
Foreign key referencing the parent seismogram. |
None
|
snapshot_id
|
UUID | None
|
Foreign key referencing the parent snapshot. |
None
|
Source code in src/aimbat/models/_models.py
899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 | |
AimbatSeismogram
Bases: SQLModel
Seismogram metadata linking a recording station to an event.
Holds timing information (begin_time, delta, t0) and a reference to
the waveform data source; the waveform samples themselves are not stored
on this model but are read from that data source on demand.
Reading data returns a read-only array. Assigning data stages the
write in a per-session buffer and flushes it to the data source when the
owning session commits (and discards it on rollback), mirroring how ORM
column changes persist. Reads through the same session see the staged
value before the commit; other sessions do not. In-place mutation
(seis.data[:] = ...) is not supported. Assigning data on an instance
attached to no session falls back to an immediate write.
Exposes the pysmo Seismogram interface directly
(begin_time, delta, data, end_time). ICCS working state (t1,
flip, select) is not on this model - it lives on the linked
AimbatSeismogramParameters and is reached via seismogram.parameters.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
UUID
|
Unique seismogram ID. |
UUID('21575704-1bdc-4af7-8ebc-f3f21c61111d')
|
begin_time
|
PydanticTimestamp
|
Start time of the seismogram. |
required |
delta
|
PydanticPositiveTimedelta
|
Sampling interval. |
required |
t0
|
PydanticTimestamp
|
Initial phase arrival pick. |
required |
station_id
|
UUID
|
Foreign key referencing the recording station. |
None
|
event_id
|
UUID
|
Foreign key referencing the parent event. |
None
|
Attributes:
| Name | Type | Description |
|---|---|---|
data |
NDArray[floating]
|
Seismogram waveform data as a read-only array. |
datasource |
AimbatDataSource
|
Data source for the seismogram waveform. |
end_time |
Timestamp
|
End time of the seismogram, derived from begin_time, delta, and data length. |
event |
AimbatEvent
|
The event this seismogram belongs to. |
parameters |
AimbatSeismogramParameters
|
Processing parameters for this seismogram. |
quality |
AimbatSeismogramQuality | None
|
Live quality metrics for this seismogram. |
station |
AimbatStation
|
The station that recorded this seismogram. |
Source code in src/aimbat/models/_models.py
522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 | |
data
property
writable
Seismogram waveform data as a read-only array.
Assigning to this attribute stages the write; it reaches the data source when the owning session commits (see the class docstring).
In-place mutation (seis.data[:] = ...) is not supported - the
setter has no way to intercept a slice assignment on the array it
already returned, so NumPy raises its own ValueError:
assignment destination is read-only rather than a message
specific to this class. Assign a new array to seis.data instead.
datasource
class-attribute
instance-attribute
datasource: AimbatDataSource = Relationship(
back_populates="seismogram", cascade_delete=True
)
Data source for the seismogram waveform.
end_time
property
End time of the seismogram, derived from begin_time, delta, and data length.
A plain property rather than a computed_field: evaluating it reads
the full waveform to count samples, so it must not be pulled into
model_dump() / serialisation. Matches pysmo.Seismogram.end_time.
event
class-attribute
instance-attribute
event: AimbatEvent = Relationship(
back_populates="seismograms"
)
The event this seismogram belongs to.
parameters
class-attribute
instance-attribute
parameters: AimbatSeismogramParameters = Relationship(
back_populates="seismogram", cascade_delete=True
)
Processing parameters for this seismogram.
quality
class-attribute
instance-attribute
quality: AimbatSeismogramQuality | None = Relationship(
back_populates="seismogram", cascade_delete=True
)
Live quality metrics for this seismogram.
station
class-attribute
instance-attribute
station: AimbatStation = Relationship(
back_populates="seismograms"
)
The station that recorded this seismogram.
AimbatSeismogramParameters
Bases: AimbatSeismogramParametersBase
Processing parameters for a single seismogram.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
flip
|
bool
|
Whether or not the seismogram should be flipped. |
False
|
select
|
bool
|
Whether or not this seismogram should be used for processing. |
True
|
t1
|
PydanticTimestamp | None
|
Working pick. This pick serves as working as well as output pick. It is changed by: 1. Picking the phase arrival in the stack, 2. Running ICCS, 3. Running MCCC. |
None
|
id
|
UUID
|
Unique ID. |
UUID('4462e0a1-bc14-4077-81f1-ea4bfc65125b')
|
seismogram_id
|
UUID
|
Foreign key referencing the parent seismogram. |
None
|
Attributes:
| Name | Type | Description |
|---|---|---|
seismogram |
AimbatSeismogram
|
The seismogram these parameters belong to. |
snapshots |
list[AimbatSeismogramParametersSnapshot]
|
Parameter snapshots for this seismogram. |
Source code in src/aimbat/models/_models.py
seismogram
class-attribute
instance-attribute
seismogram: AimbatSeismogram = Relationship(
back_populates="parameters"
)
The seismogram these parameters belong to.
snapshots
class-attribute
instance-attribute
snapshots: list[AimbatSeismogramParametersSnapshot] = (
Relationship(
back_populates="parameters", passive_deletes=True
)
)
Parameter snapshots for this seismogram.
AimbatSeismogramParametersBase
Bases: SQLModel
Base class defining seismogram-level processing parameters for AIMBAT.
This class serves as a base that is inherited by the actual classes that
create the database tables. It covers the per-seismogram flip and
select flags and the working arrival-time pick t1.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
flip
|
bool
|
Whether or not the seismogram should be flipped. |
False
|
select
|
bool
|
Whether or not this seismogram should be used for processing. |
True
|
t1
|
PydanticTimestamp | None
|
Working pick. This pick serves as working as well as output pick. It is changed by: 1. Picking the phase arrival in the stack, 2. Running ICCS, 3. Running MCCC. |
None
|
Source code in src/aimbat/models/_parameters.py
AimbatSeismogramParametersSnapshot
Bases: AimbatSeismogramParametersBase
Snapshot of processing parameters for a single seismogram.
Frozen history: the record keeps its own seismogram_id and outlives the
seismogram it was taken from. seismogram_parameters_id is set to NULL
if that live parameter row is deleted.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
flip
|
bool
|
Whether or not the seismogram should be flipped. |
False
|
select
|
bool
|
Whether or not this seismogram should be used for processing. |
True
|
t1
|
PydanticTimestamp | None
|
Working pick. This pick serves as working as well as output pick. It is changed by: 1. Picking the phase arrival in the stack, 2. Running ICCS, 3. Running MCCC. |
None
|
id
|
UUID
|
Unique ID. |
UUID('528f9664-6c8c-49f5-a25e-ab46458e51bb')
|
seismogram_id
|
UUID | None
|
ID of the seismogram this snapshot was taken from. |
None
|
seismogram_parameters_id
|
UUID | None
|
Foreign key referencing the source seismogram parameters, or NULL if it has been deleted. |
None
|
snapshot_id
|
UUID
|
Foreign key referencing the parent snapshot. |
None
|
Attributes:
| Name | Type | Description |
|---|---|---|
parameters |
AimbatSeismogramParameters | None
|
The seismogram parameters this snapshot was taken from, if still present. |
snapshot |
AimbatSnapshot
|
The snapshot this record belongs to. |
Source code in src/aimbat/models/_models.py
parameters
class-attribute
instance-attribute
parameters: AimbatSeismogramParameters | None = (
Relationship(back_populates="snapshots")
)
The seismogram parameters this snapshot was taken from, if still present.
snapshot
class-attribute
instance-attribute
snapshot: AimbatSnapshot = Relationship(
back_populates="seismogram_parameters_snapshots"
)
The snapshot this record belongs to.
AimbatSeismogramQuality
Bases: AimbatSeismogramQualityBase
Live quality metrics for a single seismogram.
One row per seismogram. Updated in place whenever ICCS or MCCC runs.
Fields are None until the corresponding algorithm has been executed.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
iccs_cc
|
float | None
|
Pearson cross-correlation coefficient of this seismogram with the ICCS stack. |
None
|
mccc_cc_mean
|
float | None
|
Mean cross-correlation coefficient from the MCCC run (waveform quality). |
None
|
mccc_cc_std
|
float | None
|
Standard deviation of cross-correlation coefficients from the MCCC run (waveform consistency). |
None
|
mccc_error
|
PydanticNonNegativeTimedelta | None
|
Timing precision (standard error from covariance matrix) from the MCCC run. |
None
|
id
|
UUID
|
Unique ID. |
UUID('1df8746d-dce5-4030-b289-6dfa949b4e8f')
|
seismogram_id
|
UUID
|
Foreign key referencing the parent seismogram. |
None
|
Attributes:
| Name | Type | Description |
|---|---|---|
seismogram |
AimbatSeismogram
|
The seismogram these quality metrics belong to. |
snapshots |
list[AimbatSeismogramQualitySnapshot]
|
Quality snapshots taken from this live record. |
Source code in src/aimbat/models/_models.py
seismogram
class-attribute
instance-attribute
seismogram: AimbatSeismogram = Relationship(
back_populates="quality"
)
The seismogram these quality metrics belong to.
snapshots
class-attribute
instance-attribute
snapshots: list[AimbatSeismogramQualitySnapshot] = (
Relationship(
back_populates="quality", passive_deletes=True
)
)
Quality snapshots taken from this live record.
AimbatSeismogramQualityBase
Bases: SQLModel
Base class defining seismogram-level quality metrics.
Fields are None when the corresponding algorithm has not been run for
this seismogram.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
iccs_cc
|
float | None
|
Pearson cross-correlation coefficient of this seismogram with the ICCS stack. |
None
|
mccc_cc_mean
|
float | None
|
Mean cross-correlation coefficient from the MCCC run (waveform quality). |
None
|
mccc_cc_std
|
float | None
|
Standard deviation of cross-correlation coefficients from the MCCC run (waveform consistency). |
None
|
mccc_error
|
PydanticNonNegativeTimedelta | None
|
Timing precision (standard error from covariance matrix) from the MCCC run. |
None
|
Source code in src/aimbat/models/_quality.py
AimbatSeismogramQualitySnapshot
Bases: AimbatSeismogramQualityBase
Snapshot of quality metrics for a single seismogram.
Frozen history: the record keeps its own seismogram_id and outlives the
seismogram it was taken from. seismogram_quality_id is set to NULL if
that live quality row is deleted.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
iccs_cc
|
float | None
|
Pearson cross-correlation coefficient of this seismogram with the ICCS stack. |
None
|
mccc_cc_mean
|
float | None
|
Mean cross-correlation coefficient from the MCCC run (waveform quality). |
None
|
mccc_cc_std
|
float | None
|
Standard deviation of cross-correlation coefficients from the MCCC run (waveform consistency). |
None
|
mccc_error
|
PydanticNonNegativeTimedelta | None
|
Timing precision (standard error from covariance matrix) from the MCCC run. |
None
|
id
|
UUID
|
Unique ID. |
UUID('fde6cc3f-26f8-476d-bbaf-915a40cad4eb')
|
seismogram_id
|
UUID | None
|
ID of the seismogram this snapshot was taken from. |
None
|
seismogram_quality_id
|
UUID | None
|
Foreign key referencing the source seismogram quality, or NULL if it has been deleted. |
None
|
snapshot_id
|
UUID
|
Foreign key referencing the parent snapshot. |
None
|
Attributes:
| Name | Type | Description |
|---|---|---|
quality |
AimbatSeismogramQuality | None
|
The seismogram quality this snapshot was taken from, if still present. |
snapshot |
AimbatSnapshot
|
The snapshot this record belongs to. |
Source code in src/aimbat/models/_models.py
quality
class-attribute
instance-attribute
quality: AimbatSeismogramQuality | None = Relationship(
back_populates="snapshots"
)
The seismogram quality this snapshot was taken from, if still present.
snapshot
class-attribute
instance-attribute
snapshot: AimbatSnapshot = Relationship(
back_populates="seismogram_quality_snapshots"
)
The snapshot this record belongs to.
AimbatSeismogramRead
Bases: BaseModel
Read model for AimbatSeismogram including parameters.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
UUID
|
Unique identifier for the seismogram |
required |
short_id
|
str | None
|
Shortened unique identifier |
None
|
name
|
str
|
Name of the seismogram. |
required |
channel
|
str
|
Seismogram channel. |
required |
select
|
bool
|
Whether the seismogram is selected for processing. |
required |
flip
|
bool
|
Whether the seismogram is flipped for processing. |
required |
delta_t
|
PydanticTimedelta | None
|
Arrival time residual (observed - predicted) in seconds. |
required |
mccc_error
|
PydanticTimedelta | None
|
Uncertainty in the MCCC arrival time residual (observed - predicted) in seconds. |
required |
iccs_cc
|
float | None
|
Cross-correlation coefficient with ICCS stack. |
required |
mccc_cc_mean
|
float | None
|
Mean cross-correlation coefficient of MCCC cluster. |
required |
mccc_cc_std
|
float | None
|
Standard deviation of cross-correlation coefficients in MCCC cluster. |
required |
event_id
|
UUID
|
ID of the associated event. |
required |
short_event_id
|
str | None
|
Shortened unique identifier for the associated event. |
required |
Methods:
| Name | Description |
|---|---|
from_seismogram |
Create an AimbatSeismogramRead from an AimbatSeismogram ORM instance. |
Source code in src/aimbat/models/_readers.py
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 | |
from_seismogram
classmethod
from_seismogram(
seismogram: AimbatSeismogram,
session: Session | None = None,
) -> Self
Create an AimbatSeismogramRead from an AimbatSeismogram ORM instance.
Source code in src/aimbat/models/_readers.py
AimbatSnapshot
Bases: SQLModel
Container for a point-in-time snapshot of event and seismogram parameters.
An AimbatSnapshot does not store any parameter data itself. It is used
to group and keep track of the associated AimbatEventParametersSnapshot
and AimbatSeismogramParametersSnapshot instances.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
UUID
|
Unique ID. |
UUID('c6d92d1b-0fe3-4bc7-8752-fb5c428ee56e')
|
sequence
|
int
|
Monotonic per-event counter; the definitive snapshot order. |
required |
time
|
PydanticTimestamp
|
Timestamp when the snapshot was created. |
Timestamp('2026-09-25 00:15:30.067907+0000', tz='UTC')
|
comment
|
str | None
|
Optional comment for the snapshot. |
None
|
automatic
|
bool
|
Whether this snapshot was created automatically, e.g. by |
False
|
mccc_hash
|
str | None
|
SHA-256 hash of the parameters affecting MCCC output at creation time. |
None
|
iccs_hash
|
str | None
|
SHA-256 hash of the parameters affecting ICCS output at creation time. |
None
|
event_id
|
UUID
|
Foreign key referencing the parent event. |
None
|
Attributes:
| Name | Type | Description |
|---|---|---|
event |
AimbatEvent
|
The event this snapshot belongs to. |
event_parameters_snapshot |
AimbatEventParametersSnapshot
|
Event parameter snapshot associated with this snapshot. |
event_quality_snapshot |
AimbatEventQualitySnapshot | None
|
Event quality metric snapshot associated with this snapshot. |
seismogram_parameters_snapshots |
list[AimbatSeismogramParametersSnapshot]
|
Seismogram parameter snapshots associated with this snapshot. |
seismogram_quality_snapshots |
list[AimbatSeismogramQualitySnapshot]
|
Seismogram quality metric snapshots associated with this snapshot. |
Source code in src/aimbat/models/_models.py
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 | |
event
class-attribute
instance-attribute
event: AimbatEvent = Relationship(
back_populates="snapshots"
)
The event this snapshot belongs to.
event_parameters_snapshot
class-attribute
instance-attribute
event_parameters_snapshot: AimbatEventParametersSnapshot = (
Relationship(
back_populates="snapshot", cascade_delete=True
)
)
Event parameter snapshot associated with this snapshot.
event_quality_snapshot
class-attribute
instance-attribute
event_quality_snapshot: (
AimbatEventQualitySnapshot | None
) = Relationship(
back_populates="snapshot", cascade_delete=True
)
Event quality metric snapshot associated with this snapshot.
seismogram_parameters_snapshots
class-attribute
instance-attribute
seismogram_parameters_snapshots: list[
AimbatSeismogramParametersSnapshot
] = Relationship(
back_populates="snapshot", cascade_delete=True
)
Seismogram parameter snapshots associated with this snapshot.
seismogram_quality_snapshots
class-attribute
instance-attribute
seismogram_quality_snapshots: list[
AimbatSeismogramQualitySnapshot
] = Relationship(
back_populates="snapshot", cascade_delete=True
)
Seismogram quality metric snapshots associated with this snapshot.
AimbatSnapshotRead
Bases: BaseModel
Read model for AimbatSnapshot with a seismogram count.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
UUID
|
Unique identifier for the snapshot |
required |
short_id
|
str | None
|
Shortened unique identifier |
None
|
sequence
|
int
|
Monotonic per-event snapshot counter |
required |
automatic
|
bool
|
Whether this snapshot was created automatically |
required |
time
|
PydanticTimestamp
|
Timestamp of the snapshot |
required |
comment
|
str | None
|
Optional comment for the snapshot |
required |
seismogram_count
|
int
|
Total number of seismograms in the snapshot |
required |
selected_seismogram_count
|
int
|
Number of selected seismograms in the snapshot |
required |
flipped_seismogram_count
|
int
|
Number of flipped seismograms in the snapshot |
required |
cc_mean
|
float | None
|
Mean cross-correlation coefficient for this snapshot |
None
|
cc_sem
|
float | None
|
Standard error of the mean of cross-correlation coefficients for this snapshot |
None
|
mccc
|
bool | None
|
Whether MCCC parameters are included in this snapshot |
None
|
event_id
|
UUID
|
ID of the associated event |
required |
short_event_id
|
str | None
|
Shortened unique identifier for the associated event |
required |
Methods:
| Name | Description |
|---|---|
from_snapshot |
Create an AimbatSnapshotRead from an AimbatSnapshot ORM instance. |
Source code in src/aimbat/models/_readers.py
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 | |
from_snapshot
classmethod
from_snapshot(
snapshot: AimbatSnapshot, session: Session | None = None
) -> Self
Create an AimbatSnapshotRead from an AimbatSnapshot ORM instance.
Source code in src/aimbat/models/_readers.py
AimbatStation
Bases: SQLModel
Recording station with network, location, and channel metadata.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
UUID
|
Unique station ID. |
UUID('acda2f2d-7164-4fea-8157-912f24c253bb')
|
name
|
str
|
Station name (SEED station code). |
required |
network
|
str
|
Network code. |
required |
location
|
str
|
Location code. |
required |
channel
|
str
|
Channel code (e.g. BHZ). |
required |
latitude
|
float
|
Station latitude in degrees. |
required |
longitude
|
float
|
Station longitude in degrees. |
required |
elevation
|
float | None
|
Station elevation in metres. |
None
|
Attributes:
| Name | Type | Description |
|---|---|---|
seismograms |
list[AimbatSeismogram]
|
Seismograms recorded at this station. |
Source code in src/aimbat/models/_models.py
seismograms
class-attribute
instance-attribute
seismograms: list[AimbatSeismogram] = Relationship(
back_populates="station", cascade_delete=True
)
Seismograms recorded at this station.
AimbatStationRead
Bases: BaseModel
Read model for AimbatStation including aggregated quality statistics.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
UUID
|
Unique identifier for the station |
required |
short_id
|
str | None
|
Shortened unique identifier |
None
|
network
|
str
|
Station network code |
required |
name
|
str
|
Station name |
required |
location
|
str
|
Station location code |
required |
channel
|
str
|
Station channel code |
required |
latitude
|
float
|
Station latitude |
required |
longitude
|
float
|
Station longitude |
required |
elevation
|
float | None
|
Station elevation |
None
|
cc_mean
|
float | None
|
Mean cross-correlation coefficient at this station |
None
|
cc_sem
|
float | None
|
Standard error of the mean of cross-correlation coefficients at this station |
None
|
seismogram_count
|
int
|
Number of seismograms associated with this station |
required |
event_count
|
int
|
Number of unique events recorded at this station |
required |
Methods:
| Name | Description |
|---|---|
from_station |
Create an AimbatStationRead from an AimbatStation ORM instance. |
Source code in src/aimbat/models/_readers.py
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 | |
from_station
classmethod
from_station(
station: AimbatStation, session: Session | None = None
) -> Self
Create an AimbatStationRead from an AimbatStation ORM instance.
Source code in src/aimbat/models/_readers.py
SeismogramQualityStats
Bases: BaseModel
Aggregated seismogram quality statistics for an event or station.
Built from persisted AimbatSeismogramQuality rows, covering both ICCS
CC and MCCC diagnostics. All mean fields are None when no seismograms
in the group have quality data. SEM fields are None when fewer than
two values are available. mccc_rmse is only populated by from_event
and from_snapshot; it is always None for from_station. event_id
is populated by from_event and from_snapshot; it is always None
for from_station.
For the live, DB-independent CC-only equivalent (computed straight from
an ICCS instance), see aimbat.core.CcStats.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
event_id
|
UUID | None
|
|
None
|
snapshot_id
|
UUID | None
|
|
None
|
station_id
|
UUID | None
|
|
None
|
count
|
int
|
Number of seismograms in the group (regardless of whether they have quality data). |
required |
cc_mean
|
float | None
|
|
None
|
cc_mean_sem
|
float | None
|
|
None
|
mccc_cc_mean
|
float | None
|
|
None
|
mccc_cc_mean_sem
|
float | None
|
|
None
|
mccc_cc_std
|
float | None
|
|
None
|
mccc_cc_std_sem
|
float | None
|
|
None
|
mccc_error
|
PydanticTimedelta | None
|
|
None
|
mccc_error_sem
|
PydanticTimedelta | None
|
|
None
|
mccc_rmse
|
PydanticTimedelta | None
|
|
None
|
Methods:
| Name | Description |
|---|---|
from_event |
Build quality stats from live quality records for an event. |
from_snapshot |
Build quality stats from the frozen quality records in a snapshot. |
from_station |
Build quality stats from live quality records for a station. |
Attributes:
| Name | Type | Description |
|---|---|---|
cc_display |
str
|
ICCS CC mean ± SEM, formatted for display. |
mccc_cc_mean_display |
str
|
MCCC CC mean ± SEM, formatted for display. |
mccc_cc_std_display |
str
|
MCCC CC std ± SEM, formatted for display. |
mccc_error_display |
str
|
MCCC arrival-time error mean ± SEM in seconds, formatted for display. |
mccc_rmse_display |
str
|
MCCC RMSE in seconds, formatted for display. |
Source code in src/aimbat/models/_readers.py
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 | |
mccc_error_display
property
mccc_error_display: str
MCCC arrival-time error mean ± SEM in seconds, formatted for display.
from_event
classmethod
from_event(event: AimbatEvent) -> Self
Build quality stats from live quality records for an event.
Aggregates iccs_cc and MCCC metrics across all seismograms that
have live quality records. mccc_rmse is taken from the event-level
quality record.
Warning
This method may trigger lazy-loading of event.seismograms and
each seis.quality relationship. For performance, query event
with selectinload for seismograms and their nested quality
relationships before calling.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
event
|
AimbatEvent
|
The event whose seismograms' live quality to aggregate. |
required |
Returns:
| Type | Description |
|---|---|
Self
|
Aggregated quality statistics. |
Source code in src/aimbat/models/_readers.py
from_snapshot
classmethod
from_snapshot(snapshot: AimbatSnapshot) -> Self
Build quality stats from the frozen quality records in a snapshot.
Aggregates from AimbatSeismogramQualitySnapshot records rather than
live quality, so the result reflects the state at snapshot time.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
snapshot
|
AimbatSnapshot
|
The snapshot to aggregate quality from. |
required |
Returns:
| Type | Description |
|---|---|
Self
|
Aggregated quality statistics. |
Source code in src/aimbat/models/_readers.py
from_station
classmethod
from_station(station: AimbatStation) -> Self
Build quality stats from live quality records for a station.
Aggregates iccs_cc and MCCC metrics across all seismograms at the
station that have live quality records.
Warning
This method may trigger lazy-loading of station.seismograms and
each seis.quality relationship. For performance, query station
with selectinload for seismograms and their nested quality
relationships before calling.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
station
|
AimbatStation
|
The station whose seismograms' live quality to aggregate. |
required |
Returns:
| Type | Description |
|---|---|
Self
|
Aggregated quality statistics. |
Source code in src/aimbat/models/_readers.py
SnapshotResults
Bases: BaseModel
Full results export for a snapshot.
Contains event- and snapshot-level header information followed by per-seismogram result records. All repeated scalars (UUIDs, event details, MCCC RMSE) appear once in the envelope rather than being duplicated across every row.
Depth is exposed in metres, matching the database column.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
snapshot_id
|
UUID
|
|
required |
snapshot_time
|
PydanticTimestamp
|
|
required |
snapshot_comment
|
str | None
|
|
None
|
event_id
|
UUID
|
|
required |
event_time
|
PydanticTimestamp
|
|
required |
event_latitude
|
float
|
|
required |
event_longitude
|
float
|
|
required |
event_depth
|
float | None
|
Event depth in metres. |
None
|
mccc_rmse
|
PydanticTimedelta | None
|
Global MCCC root-mean-square error for the event. |
None
|
seismograms
|
list[SnapshotSeismogramResult]
|
Per-seismogram result records. |
required |
Source code in src/aimbat/models/_readers.py
SnapshotSeismogramResult
Bases: BaseModel
Per-seismogram result record from a snapshot.
Joins the frozen parameter and quality records from a snapshot to produce
one row per seismogram. Only snapshots with MCCC data will have meaningful
MCCC columns; iccs_cc is populated whenever ICCS was run before the
snapshot was taken.
Event- and snapshot-level scalars (snapshot_id, event_id, mccc_rmse)
are not repeated here; they live in the enclosing SnapshotResults envelope.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
seismogram_id
|
UUID | None
|
|
None
|
name
|
str
|
Station network and name. |
required |
channel
|
str
|
Station channel code. |
required |
select
|
bool
|
Whether this seismogram was selected at snapshot time. |
required |
flip
|
bool
|
Whether this seismogram was flipped at snapshot time. |
required |
t1
|
PydanticTimestamp | None
|
Frozen pick time (absolute timestamp) at snapshot time. |
None
|
iccs_cc
|
float | None
|
Cross-correlation coefficient with ICCS stack at snapshot time. |
None
|
mccc_cc_mean
|
float | None
|
Mean cross-correlation coefficient of MCCC cluster. |
None
|
mccc_cc_std
|
float | None
|
Standard deviation of cross-correlation coefficients in MCCC cluster. |
None
|
mccc_error
|
PydanticTimedelta | None
|
Uncertainty in the MCCC arrival time residual in seconds. |
None
|
Methods:
| Name | Description |
|---|---|
from_snapshot_records |
Build a result record from pre-loaded snapshot records. |
Source code in src/aimbat/models/_readers.py
755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 | |
from_snapshot_records
classmethod
from_snapshot_records(
param_snap: AimbatSeismogramParametersSnapshot,
quality_snap: AimbatSeismogramQualitySnapshot | None,
live_seismogram: AimbatSeismogram | None,
) -> SnapshotSeismogramResult
Build a result record from pre-loaded snapshot records.
Warning
live_seismogram.station must be loaded before calling (e.g. via
selectinload) when live_seismogram is not None.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
param_snap
|
AimbatSeismogramParametersSnapshot
|
Seismogram parameters snapshot record. |
required |
quality_snap
|
AimbatSeismogramQualitySnapshot | None
|
Matching seismogram quality snapshot, or |
required |
live_seismogram
|
AimbatSeismogram | None
|
The live seismogram the snapshot was taken from,
or |
required |
Returns:
| Type | Description |
|---|---|
SnapshotSeismogramResult
|
Assembled result record. |
Source code in src/aimbat/models/_readers.py
undefer_counts
Loader options that fetch model_class's count columns in the main query.
Pass these to select(...).options(...) in a path that renders counts for
many rows; without them each count is a query of its own, per row.
The options are read off the mapper rather than listed here, so a count added later reaches every table-rendering path without any of them being touched.