olympus.event_generation.photon_source

Classes:

PhotonSource 

PhotonSource(position, n_photons, time, direction, type=PhotonSourceType.STANDARD_CHERENKOV)

Bases: object

Representation of a single point-like photon source.

Parameters:
  • position (ndarray) –

    Position vector (shape (3,)).

  • n_photons (int) –

    Number of photons emitted by the source.

  • time (float) –

    Emission time.

  • direction (ndarray) –

    Direction vector (shape (3,)).

  • type (PhotonSourceType, default: STANDARD_CHERENKOV ) –

    Source type (default is PhotonSourceType.STANDARD_CHERENKOV).

Parameters are stored as instance attributes.

Source code in olympus/event_generation/photon_source.py 
def __init__(
    self,
    position,
    n_photons,
    time,
    direction,
    type=PhotonSourceType.STANDARD_CHERENKOV,
):
    """Initialize the PhotonSource instance.

    Parameters are stored as instance attributes.
    """
    self.position = position
    self.n_photons = n_photons
    self.time = time
    self.direction = direction
    self.type = type

PhotonSourceType

Bases: Enum

Enum for photon source types.