AdjustedMatrix.py

from obspy import UTCDateTime
from pydantic import BaseModel
from typing import Optional, Any, List

from .. import pydantic_utcdatetime


class AdjustedMatrix(BaseModel):
    """Attributes pertaining to adjusted(affine) matrices, applied by the AdjustedAlgorithm

    Attributes
    ----------
    matrix: affine matrix generated by Affine's calculate method
    pier_correction: pier correction generated by Affine's calculate method
    starttime: beginning of interval that matrix is valid for
    endtime: end of interval that matrix is valid for
    NOTE: valid intervals are only generated when bad data is encountered.
    Matrix is non-constrained otherwise
    """

    matrix: Any
    pier_correction: float
    metrics: List[float] = [0.0, 0.0]
    starttime: Optional[UTCDateTime] = None
    endtime: Optional[UTCDateTime] = None