Skip to content

field_results

Lazy complex plane fields and actual sample coordinates.

Classes:

  • ComplexFieldResult –

    One complex component/frequency, with unmodified solver metadata.

  • FieldCoordinates –

    Actual colocated sample coordinates, expressed in micrometers.

ComplexFieldResult dataclass

ComplexFieldResult(
    component: str,
    wavelength_um: float,
    frequency_hz: float,
    shape: tuple[int, int],
    real_file: Path,
    imag_file: Path,
    coordinates: FieldCoordinates,
    metadata: dict[str, Any],
)

One complex component/frequency, with unmodified solver metadata.

Loading combines the paired arrays without source normalization, phase correction or a noise mask. Inspect metadata before quantitative analysis.

Methods:

  • load –

    Load finite real/imaginary arrays and return their complex values.

load

load() -> ndarray

Load finite real/imaginary arrays and return their complex values.

FieldCoordinates dataclass

FieldCoordinates(
    u_um: ndarray,
    v_um: ndarray,
    normal_position_um: float,
    axis_order: tuple[str, str],
    grid_location: str | None = None,
)

Actual colocated sample coordinates, expressed in micrometers.

parse_complex_fields

parse_complex_fields(
    data: Mapping[str, Any],
    output_dir: Path,
    files: Mapping[str, Path],
    plane_shape: tuple[int, int],
) -> tuple[list[ComplexFieldResult], FieldCoordinates | None]

Parse optional complex-field metadata without opening NumPy sidecars.