HASEonGPU.PumpProperties

class HASEonGPU.PumpProperties(*, intensity, pumpSubsteps=100, wavelength=None, customProperties=None, **properties)

Bases: object

Pump-beam settings used to raise the excited-state fraction beta.

intensity is pump intensity \(I\) in W / cm^2. wavelength is the pump wavelength \(\lambda\). Built-in Gaussian pumping also uses radiusX, radiusY, and exponent from customProperties. A custom solver may store its own knobs in the same dictionary.

Parameters:

  • intensity (float)

  • pumpSubsteps (int)

  • wavelength (float | None)

  • customProperties (dict)

intensity: float

Pump intensity \(I\) in W / cm^2.

wavelength: float | None

Pump wavelength \(\lambda\); required for monochromatic data.

pumpSubsteps: int

Number of time samples used by the built-in pump integrator.

customProperties: dict

Extensible store for beam shape, reflection, spectra, and solver handles.

classmethod superGaussian(*, intensity, wavelength, radiusX, pumpDuration=None, duration=None, pumpSubsteps=100, temporaryFluorescence=None, solver=None, crossSections=None, spectralProperties=None, gainMedium=None, crossSectionAbsorption=None, crossSectionEmission=None, absorption=None, emission=None, radiusY=None, exponent=40.0, backReflection=True, reflectivity=1.0, customProperties=None, **extraProperties)

Create settings for the built-in super-Gaussian pump profile.

The transverse profile is intensity * exp(-r ** exponent) with radii radiusX and radiusY. backReflection and reflectivity control the backward pump pass.

withProperty(name, value)

Set one custom pump property and return self.

withProperties(**properties)

Set several custom pump properties and return self.

getProperty(name, default=None)

Read a custom pump property without raising AttributeError.

activeDuration(timeFrame)

Return the pump duration used for one integration frame.

intensityAt(points)

Evaluate the super-Gaussian intensity profile at (x, y) points.

toDict(timeFrame=None)

Return the low-level pump dictionary consumed by pumping.py.

modeDict()

Return low-level flags for extraction and backward reflection.