AbstractDepletionModel#

class optika.sensors.materials.depletion.AbstractDepletionModel[source]#

Bases: Printable, Shaped

An arbitrary model of the depletion region of a semiconducting imaging sensor.

Attributes

shape

The array shape of this object.

thickness

The thickness of the depletion region.

Methods

__init__()

to_string([prefix])

Public-facing version of the __repr__ method that allows for defining a prefix string, which can be used to calculate how much whitespace to add to the beginning of each line of the result.

Inheritance Diagram

Inheritance diagram of optika.sensors.materials.depletion.AbstractDepletionModel
to_string(prefix=None)#

Public-facing version of the __repr__ method that allows for defining a prefix string, which can be used to calculate how much whitespace to add to the beginning of each line of the result.

Parameters:

prefix (None | str) – an optional string, the length of which is used to calculate how much whitespace to add to the result.

Return type:

str

abstract property shape: dict[str, int]#

The array shape of this object.

abstract property thickness: Quantity#

The thickness of the depletion region.