Far field effects

The larndsim.far_field subpackage contains routines for calculating the far field / long-range induction effects from deposited charge using the method of images and a dipole series approximation.

Far-field routines

Data class and definitions

class larndsim.far_field.PixelCategory(value)[source][source]

Bases: IntEnum

INACTIVE = 0[source]
CHARGE_COLLECTION = 1[source]
CHARGE_NEIGHBOR = 2[source]
INDUCTION_ONLY = 3[source]
class larndsim.far_field.PixelClassificationResult(charge_pixels, neighbor_pixels, induction_pixels, induction_pixels_x=None, induction_pixels_y=None)[source][source]

Bases: object

Classification output with pixel IDs for each category.

Variables:

  • charge_pixels (Any | None) – Pixel IDs for CHARGE_COLLECTION pixels

  • neighbor_pixels (Any | None) – Pixel IDs for CHARGE_NEIGHBOR pixels

  • induction_pixels (Any | None) – Pixel IDs for INDUCTION_ONLY pixels

  • induction_pixels_x (Any | None) – X coordinates (cm) for INDUCTION_ONLY pixels

  • induction_pixels_y (Any | None) – Y coordinates (cm) for INDUCTION_ONLY pixels

Note

  • “charge_pixels” means pixels in the CHARGE_COLLECTION category

  • The *_pixels fields contain global pixel IDs (not indices)

  • Types are Optional[Any] to avoid hard dependency on CuPy at import time.

charge_pixels: Any | None[source]
neighbor_pixels: Any | None[source]
induction_pixels: Any | None[source]
induction_pixels_x: Any | None = None[source]
induction_pixels_y: Any | None = None[source]
summary(n_total_pixels)[source][source]
__init__(charge_pixels, neighbor_pixels, induction_pixels, induction_pixels_x=None, induction_pixels_y=None)[source]