fdtdx.EnergyDetector

Bases: Detector

Detector for measuring electromagnetic energy distribution.

This detector computes and records the electromagnetic energy density at specified points in the simulation volume. It can operate in different modes to either record full 3D data, 2D slices, or reduced volume measurements.

Attributes:
  • as_slices (bool) –

    If True, returns energy measurements as 2D slices through the volume. Defaults to False.

  • reduce_volume (bool) –

    If True, reduces the volume data to a single energy value. Defaults to False.

  • x_slice (float | None) –

    real-world positions for slice extraction. Defaults to None.

  • y_slice (float | None) –

    real-world positions for slice extraction. Defaults to None.

  • z_slice (float | None) –

    real-world positions for slice extraction. Defaults to None.

  • aggregate (str | None) –

    If "mean", aggregates slices by averaging instead of using position. If None, mean is used. Defaults to None.