AbstractDetector#

class esis.optics.abc.AbstractDetector#

Bases: Printable, Rollable, Yawable, Pitchable, Translatable, CylindricallyTransformable

Attributes

azimuth

angle of rotation about the axis of symmetry

bits_adc

the number of bits supported by the analog-to-digital converter

channel_trigger

the channel that strobes the sychronization trigger

charge_diffusion

standard deviation of the charge diffusion kernel

clearance

minimum distance between this component and other components

dark_current

dark current value for this detector

distance_focus

the distance the detector can be moved along the optic axis to focus it

distance_radial

distance from the axis of symmetry

gain

gain value of the analog to digital converter

manufacturer

the name of the company that manufactured this device

name_channel

human-readable name of each channel of this detector array

num_columns_blank

number of black columns captured by this detector

num_columns_overscan

number of overscan columns captured by this detector

pitch

pitch angle of this object

position_image

nominal position of the center of the field of view

readout_noise

standard deviation of the readout noise

roll

roll angle of this object

serial_number

the serial number of this device

shape_pixels

number of pixels along each axis of the detector

shape_pixels_all

surface

temperature

temperature of this device

time_exposure

the current exposure length

time_exposure_max

the maximum exposure length supported by this detector

time_exposure_min

the minimum exposure length supported by this detector

time_readout

time required to perform a readout operation

time_transfer

time required to perform a frame transfer operation

timedelta_exposure_min

the smalled amount the exposure length can be incremented by

timedelta_synchronization

the synchronization error between the different channels

transformation

the coordinate transformation between the global coordinate system and this object's local coordinate system

translation

translate the coordinate system

width_border

size of the border around the light-sensitive area

width_clear

width_mechanical

width_pixels

the physical size of a pixel

yaw

yaw angle of this object

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 esis.optics.abc.AbstractDetector
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 azimuth: Quantity | AbstractScalar#

angle of rotation about the axis of symmetry

abstract property bits_adc: int#

the number of bits supported by the analog-to-digital converter

abstract property channel_trigger: int#

the channel that strobes the sychronization trigger

abstract property charge_diffusion: Quantity | AbstractScalar#

standard deviation of the charge diffusion kernel

abstract property clearance: Quantity | AbstractScalar#

minimum distance between this component and other components

abstract property dark_current: Quantity | AbstractScalar#

dark current value for this detector

abstract property distance_focus: Quantity | AbstractScalar#

the distance the detector can be moved along the optic axis to focus it

abstract property distance_radial: Quantity | AbstractScalar#

distance from the axis of symmetry

abstract property gain: Quantity | AbstractScalar#

gain value of the analog to digital converter

abstract property manufacturer: str#

the name of the company that manufactured this device

abstract property name_channel: str | AbstractScalar#

human-readable name of each channel of this detector array

abstract property num_columns_blank: int#

number of black columns captured by this detector

abstract property num_columns_overscan: int#

number of overscan columns captured by this detector

abstract property pitch: Quantity | int | float | complex | ndarray | AbstractScalar#

pitch angle of this object

abstract property position_image: Quantity | AbstractCartesian2dVectorArray#

nominal position of the center of the field of view

abstract property readout_noise: Quantity | AbstractScalar#

standard deviation of the readout noise

abstract property roll: Quantity | int | float | complex | ndarray | AbstractScalar#

roll angle of this object

abstract property serial_number: str#

the serial number of this device

abstract property shape_pixels: int | AbstractCartesian2dVectorArray#

number of pixels along each axis of the detector

property shape_pixels_all: Cartesian2dVectorArray#
property surface: ImagingSensor#
abstract property temperature: Quantity | AbstractScalar#

temperature of this device

abstract property time_exposure: Quantity | AbstractScalar#

the current exposure length

abstract property time_exposure_max: Quantity#

the maximum exposure length supported by this detector

abstract property time_exposure_min: Quantity#

the minimum exposure length supported by this detector

abstract property time_readout: Quantity | AbstractScalar#

time required to perform a readout operation

abstract property time_transfer: Quantity | AbstractScalar#

time required to perform a frame transfer operation

abstract property timedelta_exposure_min: Quantity#

the smalled amount the exposure length can be incremented by

abstract property timedelta_synchronization: Quantity#

the synchronization error between the different channels

property transformation: AbstractTransformation#

the coordinate transformation between the global coordinate system and this object’s local coordinate system

abstract property translation: Quantity | AbstractScalar | AbstractVectorArray#

translate the coordinate system

abstract property width_border: Quantity | AbstractScalar#

size of the border around the light-sensitive area

property width_clear: Quantity | Cartesian2dVectorArray#
property width_mechanical: Quantity | AbstractScalar#
abstract property width_pixels: Quantity | AbstractCartesian2dVectorArray#

the physical size of a pixel

abstract property yaw: Quantity | int | float | complex | ndarray | AbstractScalar#

yaw angle of this object