Class in Zendir.Classes | Inherits from Sensor

Declaration

class ChargeCoupledDevice;

Description

A CCD (Charge-Coupled Device) is a sensor that captures light by converting photons into electrical charges at each pixel, which are then transferred sequentially to produce a digital image. Known for high image quality, CCDs excel in applications requiring low noise and precise light detection, such as astronomy and professional photography. This sensor is useful for determining the noise at a particular location in the simulation, due to atmospheric and light effects.


Properties

DeclaredDescription
AreaThe total area of the CCD sensor. This is the area of the sensorcovered by the pixels in square millimeters.
AtmosphereAbsorptionA constant that represents the atmospheric absorption of thelight that is captured by the CCD sensor. This is a value between0 and 1, where 0 is no absorption and 1 is full absorption.
BiasRepresents the constant bias signal added to the sensor data.This accounts for any inherent offset in the sensor electronics,such as dark current, readout noise, or electronic biases.Bias is applied even when no light is detected, and should be subtractedduring calibration to improve measurement accuracy.
CaptureOnTickA flag whether the sensor should capture an image each frame.
DarkCurrentNoiseDark current noise, which is caused by the small current that flows through the sensoreven in the absence of light. This current is related to the sensor’s temperature and isresponsible for generating a constant noise level in the absence of photons.
DataThe data that is captured by the CCD sensor. This is the rawdata that is captured by the sensor and is used to create an image.It is an array of integers, corresponding to the top-left pixelto the bottom-right pixel.
EfficiencyThe quantum efficiency of the CCD sensor. This is the fractionof photons that are converted into electrons at each pixel.
ExposureTimeThe exposure time of the CCD sensor. This is the time in secondsthat the sensor is exposed to light.
FOVThe field of view of the CCD sensor. This is the angle in degreesand represents the angle of the sensor’s view.
In_PlanetStateMsgA reference to the planet state, which comes fromthe planet in the simulation that this object exists on.This is optional.
In_SunPlanetStateMsgA reference to the sun planet state, used for calculating thedistance to the sun.
MaximumADUThis is the maximum ADU (Analog-to-Digital Unit) value that eachpixel can have. This is the maximum value that the sensor canrecord for each pixel.
MeanNoiseThe average noise of the CCD sensor. This is the average noise acrossall of the pixels in the sensor from the most recent capture.
MeanSignalThe average signal and noise of the CCD sensor. This is the averageacross all of the pixels in the sensor from the most recent capture.
NumTargetsThe number of targets that the CCD sensor can see, includingany light sources or stars.
Out_CCDDataMsgThe output message that contains the raw data from the CCD sensor, oncean image has been taken.
PointSpreadFactorA constant that represents the point spread function of thepixels on the CCD sensor. This is a value between 0 and 1, where0 corresponds to a perfect point and 1 corresponds to a spreadacross the entire pixel.
QuantizationNoiseQuantization noise, which results from the discrete nature of digital signal processing.It occurs because the continuous signal is sampled and rounded to a finite precision(e.g., limited bit-depth of the sensor).
ReadoutNoiseReadout noise, which is introduced by the sensor’s electronics when reading the signal fromthe sensor pixels. This noise is caused by imperfections in the sensor’s analog-to-digitalconversion process and is typically fixed for a given sensor.
ResolutionThe resolution of the CCD sensor. This is the number of pixelsalong each axis.
SignalToNoiseThe signal-to-noise ratio of the CCD sensor. This is the ratioof the average signal to the average noise in the sensor.
SpectralWavelengthThe spectral wavelength of the CCD sensor. This is the wavelengthin nanometers that the sensor is sensitive to.
ThermalNoiseThermal noise, which arises from the random motion of charge carriers (electrons, for example)in the sensor material due to its temperature. This type of noise is present even when nolight is detected and increases with the sensor’s temperature.
TotalSignalThe total signal of the CCD sensor. This is the sum of all thepixel values in the sensor from the most recent capture.
InheritedDescription
BehavioursA collection of behaviours attached to this object.
CenterOfMassB_BThe center of mass of the component in respect to the bodyframe (B) of the component. This is isolated from any childrenand exists in isolation.
CenterOfMassDot_LB_BThe center of mass time-derivative of the component within itsown local coordinates. This does not include any of the sub-componentsand exists in isolation.
CenterOfMassDotB_BThe center of mass time-derivative of the component relative tothe body frame (B). This does not include any of the sub-componentsand exists in isolation.
CenterOfMassL_LThe center of mass of the component within its own localcoordinates. This does not include any of the sub-components andexists in isolation.
CenterOfMassPrime_LB_BThe center of mass general-derivative of the component within itsown local coordinates. This does not include any of the sub-componentsand exists in isolation.
CenterOfMassPrimeB_B[m/s] The center of mass general-derivative of the component relativeto the body frame (B). This does not include any of the sub-componentsand exists in isolation.
ChildrenA collection of children attached to this object.
DCM_BNThe rotational DCM matrix between the body frame (B) at the topof this component chain and the inertial frame (N).
DCM_LBThe rotational DCM matrix between the component frame of thisobject (L) relative to the body frame (B).
DCM_LNThe DCM rotational matrix of the component relative to theinertial origin (N) of the world.
DCM_LPThe DCM matrix of the component in the parent’s frame (P), takenfrom the Component Transform (PL).
FaultStateSpecification used if state is set to a fault state for the sensor.This will be able to define how the output data is set for this particularsensor.
In_TransformMsgThe transform message associated with the root object ofthis particular sensor. This is required for the base levelposition and rotation of the object.
IsEnabledIs true if the object is currently enabled.
LocalForwardThe direction of the transform frame’s forward vector, which is along the Y axis.
LocalRightThe direction of the transform frame’s right vector, which is along the X axis.
LocalUpThe direction of the transform frame’s up vector, which is along the Z axis.
MassThe component mass defined in the object. This is independentof any parent or children objects and exists in isolation.
MassDotThe component mass time-derivative defined in the object. Thisis independent of any parent or children objects and exists in isolation.
ModelsA collection of models attached to this object.
MomentOfInertia_LBThe moment of inertia of the component, measured at thelocal center of mass, represented with its own local coordinates.This does not include any of the sub-components and exists inisolation.
MomentOfInertiaB_BThe moment of inertia of this component, measured inthe body frame relative to the parented body. This is independentof any children and exists in isolation.
MomentOfInertiaPrime_LBThe derivative of the moment of inertia of the component,measured at the local center of mass, represented with its own localcoordinates. This does not include any of the sub-components andexists in isolation.
MomentOfInertiaPrimeB_BThe derivative of the moment of inertia of the component,represented in the body frame (B). This is independent and exists inisolation.
NameThe display name or tag of this object.
Out_ComponentMassMsgThe component mass message defines the set of mass properties andstates of the system within this component locally. This is independentof any parent or children properties or objects.
Out_TransformMsgThis defines the base transform message that stores the state of the transform of this object.
ParentThe currently attached parent object (if any).
Position[m] The position of the object relative to the parent or to world origin, if no parent exists.
Position_BN_NThe position of the body (the root parent B) in theinertial frame relative to the inertial point (N).
Position_LB_BThe position of the component relative to the rootobject of this hierarchy. This is in the inertial frameand if the component is the root object, then there willbe no position.
Position_LN_NThe position of the inertial world space. This position isderived from the world’s transform (N).
Position_LP_PThe position of the object relative to the parented object (P).If there is no parent object, then this will be in the inertialframe.
RootThe root object in the parent chain.
Rotation[-] The rotation of the object relative to the parent or to the world origin, if no parent exists.
ThermalA reference to the thermal model that is attached to this object.This will allow the object to have thermal properties and be ableto be used in thermal simulations.

Methods

DeclaredDescription
AddTargetAdds a target to the list of targets that the CCD sensor can see. Thiswill create a new target with the specified parameters.
CaptureA method that will capture the data of the payload and store it insome form of byte array.
ClearBufferClears the cache of the CCD sensor, which will reset the data bufferto an empty state.
RemoveTargetRemoves a target from the list of targets that the CCD sensor can see.
ShutDownDisables this device and zeroes out the data.
InheritedDescription
AddObjectReturns a new simulation object with the specified type.
AttachAttempts to attach this object to a new parent. This will only work if the current object is no parented to anyother object.
ContainsModelWithIDReturns true if an attached model satisfies the specified ID.
ContainsModelWithTypeReturns true if an attached model satisfies the specified type.
DestroyRemoves the current object from the simulation.
DetachThis is an action to detach the current object from its parent, if it exists and move it to another object or tojust exist within the simulation.
FindBehavioursWithTypeReturns all attached behaviours that satisfies the specified type.
FindBehaviourWithIDReturns an attached behaviour that satisfies the specified ID.
FindBehaviourWithTypeReturns an attached behaviour that satisfies the specified type.
FindChildrenWithTypeReturns all attached children that satisfies the specified type.
FindChildWithIDReturns an attached child that satisfies the specified ID.
FindChildWithTypeReturns an attached child that satisfies the specified type.
FindModelsWithTypeReturns all attached models that satisfies the specified type.
FindModelWithIDReturns an attached model that satisfies the specified ID.
FindModelWithTypeReturns an attached model that satisfies the specified type.
FindParentWithIDReturns an attached parent that satisfies the specified ID.
FindParentWithTypeReturns an attached parent that satisfies the specified type.
FindRootWithIDReturns a root object that satisfies the specified ID.
FindRootWithTypeReturns a root object that satisfies the specified type.
GetModelReturns a valid assigned model with the specified type.
GetWorldTransformReturns the world transform of the object which is relative to the parent. If no parent exists, this will be thetransform of the object in world space.
ReadBodyTransformThis method will reset the dirty flag on the mass so thatit has been read successfully and is valid.
UpdateMassPropertiesUpdates the mass properties of the current physical object ata particular time.