atomiq.components.optoelectronics.photodiode

Classes

Photodiode

Abstract class to represent a photodiode as a device to measure light power

AnalogPhotodiode

An analog photodiode that gives a voltage proportional to the incidend light power.

CalibratedPhotodiode

An analog photodiode with a power calibration

Module Contents

class atomiq.components.optoelectronics.photodiode.Photodiode(*args, **kwargs)[source]

Bases: atomiq.components.primitives.Component, atomiq.components.primitives.Measurable

Abstract class to represent a photodiode as a device to measure light power

measure()[source]
Return type:

artiq.language.types.TFloat

get_power()[source]
Return type:

artiq.language.types.TFloat

abstractmethod _measure()[source]
Return type:

artiq.language.types.TFloat

class atomiq.components.optoelectronics.photodiode.AnalogPhotodiode(adc_channel, *args, **kwargs)[source]

Bases: Photodiode

An analog photodiode that gives a voltage proportional to the incidend light power.

Parameters:

adc_channel (ADCChannel) -- The ADC channel that reads the analog voltage of the photodiode

kernel_invariants
adc_channel
get_power(samples=1, cached=False)[source]
Parameters:
  • samples (artiq.language.types.TInt32)

  • cached (artiq.language.types.TBool)

Return type:

artiq.language.types.TFloat

_measure(samples=1, cached=False)[source]
Parameters:
  • samples (artiq.language.types.TInt32)

  • cached (artiq.language.types.TBool)

Return type:

artiq.language.types.TFloat

class atomiq.components.optoelectronics.photodiode.CalibratedPhotodiode(calibration, *args, **kwargs)[source]

Bases: AnalogPhotodiode

An analog photodiode with a power calibration

Parameters:
  • adc_channel -- The ADC channel that reads the analog voltage of the photodiode

  • calibration (Calibration) -- calibration of the photodiode

kernel_invariants
calibration
_measure(samples=1, cached=False)[source]

Get the power incident to the photodiode.

Parameters:
  • samples (artiq.language.types.TInt32) -- number of samples to take and average before returning the result (default 1)

  • cached (artiq.language.types.TBool) -- If true, the result of the last measurement is returned, otherwise new measurements are taken (default False)

Returns:

Result of the measurement (possibly averaged over several samples)

Return type:

TFloat