2.6.1.3. pycsamt.emtf.estimates#

Statistical estimate objects used by the format-neutral EMTF core.

Classes

StatisticalEstimate(name, data, kind[, ...])

Represent a frequency-indexed statistical estimate.
class pycsamt.emtf.estimates.StatisticalEstimate(name, data, kind, units=None, attrs=<factory>)[source]

Bases: PyCSAMTObject

Represent a frequency-indexed statistical estimate.

The object deliberately stores the estimate as supplied instead of coercing all uncertainty information into the legacy z_err model. This is essential for later support of full covariance matrices.

Parameters:

  • name (str) – Short code, e.g. "VAR" or "RESIDCOV".

  • data (array-like) – Numerical estimate. Real and complex arrays are supported.

  • kind (str) – Semantic name such as "variance" or "inverse_signal_covariance".

  • units (str or None) – Units when defined.

  • attrs (dict) – Additional non-serialization-specific metadata.

name: str
data: Any
kind: str
units: str | None = None
attrs: dict[str, Any]
validate()[source]

Normalize and validate the estimate in place.

Return type:

None

property shape: tuple[int, ...][source]

Return the stored array shape.

property is_complex: bool[source]

Return whether the stored estimate has a complex dtype.

copy()[source]

Return a detached copy of the estimate.

Return type:

StatisticalEstimate