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
| Declared | Description |
|---|---|
| Area | The total area of the CCD sensor. This is the area of the sensorcovered by the pixels in square millimeters. |
| AtmosphereAbsorption | A 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. |
| Bias | Represents 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. |
| CaptureOnTick | A flag whether the sensor should capture an image each frame. |
| DarkCurrentNoise | Dark 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. |
| Data | The 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. |
| Efficiency | The quantum efficiency of the CCD sensor. This is the fractionof photons that are converted into electrons at each pixel. |
| ExposureTime | The exposure time of the CCD sensor. This is the time in secondsthat the sensor is exposed to light. |
| FOV | The field of view of the CCD sensor. This is the angle in degreesand represents the angle of the sensor’s view. |
| In_PlanetStateMsg | A reference to the planet state, which comes fromthe planet in the simulation that this object exists on.This is optional. |
| In_SunPlanetStateMsg | A reference to the sun planet state, used for calculating thedistance to the sun. |
| MaximumADU | This 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. |
| MeanNoise | The average noise of the CCD sensor. This is the average noise acrossall of the pixels in the sensor from the most recent capture. |
| MeanSignal | The average signal and noise of the CCD sensor. This is the averageacross all of the pixels in the sensor from the most recent capture. |
| NumTargets | The number of targets that the CCD sensor can see, includingany light sources or stars. |
| Out_CCDDataMsg | The output message that contains the raw data from the CCD sensor, oncean image has been taken. |
| PointSpreadFactor | A 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. |
| QuantizationNoise | Quantization 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). |
| ReadoutNoise | Readout 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. |
| Resolution | The resolution of the CCD sensor. This is the number of pixelsalong each axis. |
| SignalToNoise | The signal-to-noise ratio of the CCD sensor. This is the ratioof the average signal to the average noise in the sensor. |
| SpectralWavelength | The spectral wavelength of the CCD sensor. This is the wavelengthin nanometers that the sensor is sensitive to. |
| ThermalNoise | Thermal 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. |
| TotalSignal | The total signal of the CCD sensor. This is the sum of all thepixel values in the sensor from the most recent capture. |
| Inherited | Description |
|---|---|
| Behaviours | A collection of behaviours attached to this object. |
| CenterOfMassB_B | The center of mass of the component in respect to the body frame (B) of the component. This is isolated from anychildren and exists in isolation. |
| CenterOfMassDot_LB_B | The center of mass time-derivative of the component within its own local coordinates. This does not include anyof the sub-components and exists in isolation. |
| CenterOfMassDotB_B | The center of mass time-derivative of the component relative to the body frame (B). This does not include any ofthe sub-components and exists in isolation. |
| CenterOfMassL_L | The center of mass of the component within its own local coordinates. This does not include any of thesub-components and exists in isolation. |
| CenterOfMassPrime_LB_B | The center of mass general-derivative of the component within its own local coordinates. This does not includeany of the sub-components and exists in isolation. |
| CenterOfMassPrimeB_B | [m/s] The center of mass general-derivative of the component relative to the body frame (B). This does notinclude any of the sub-components and exists in isolation. |
| Children | A collection of children attached to this object. |
| DCM_BN | The rotational DCM matrix between the body frame (B) at the top of this component chain and the inertial frame (N). |
| DCM_LB | The rotational DCM matrix between the component frame of this object (L) relative to the body frame (B). |
| DCM_LN | The DCM rotational matrix of the component relative to the inertial origin (N) of the world. |
| DCM_LP | The DCM matrix of the component in the parent’s frame (P), taken from the Component Transform (PL). |
| FaultState | Specification 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_DeviceStatusMsg | The Device status message for the physical component whetherthe device is available. |
| In_TransformMsg | The transform message associated with the root object ofthis particular sensor. This is required for the base levelposition and rotation of the object. |
| IsEnabled | Is true if the object is currently enabled. |
| LocalForward | The direction of the transform frame’s forward vector, which is along the Y axis. |
| LocalRight | The direction of the transform frame’s right vector, which is along the X axis. |
| LocalUp | The direction of the transform frame’s up vector, which is along the Z axis. |
| Mass | The component mass defined in the object. This is independent of any parent or children objects and exists inisolation. |
| MassDot | The component mass time-derivative defined in the object. This is independent of any parent or children objectsand exists in isolation. |
| Models | A collection of models attached to this object. |
| MomentOfInertia_LB | 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 and exists in isolation. |
| MomentOfInertiaB_B | The moment of inertia of this component, measured in the body frame relative to the parented body. This isindependent of any children and exists in isolation. |
| MomentOfInertiaPrime_LB | The derivative of the moment of inertia of the component, measured at the local center of mass, represented withits own local coordinates. This does not include any of the sub-components and exists in isolation. |
| MomentOfInertiaPrimeB_B | The derivative of the moment of inertia of the component, represented in the body frame (B). This is independentand exists in isolation. |
| Name | The display name or tag of this object. |
| OperationState | Current operational state of the sensor. |
| Out_ComponentMassMsg | The component mass message defines the set of mass properties and states of the system within this componentlocally. This is independent of any parent or children properties or objects. |
| Out_TransformMsg | This defines the base transform message that stores the state of the transform of this object. |
| Parent | The 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_N | The position of the body (the root parent B) in the inertial frame relative to the inertial point (N). |
| Position_LB_B | The position of the component relative to the root object of this hierarchy. This is in the inertial frame and ifthe component is the root object, then there will be no position. |
| Position_LN_N | The position of the inertial world space. This position is derived from the world’s transform (N). |
| Position_LP_P | The position of the object relative to the parented object (P). If there is no parent object, then this will bein the inertial frame. |
| Root | The 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. |
| Thermal | [TEMPORARY] A reference to the thermal model that is attached to this object. This will allow the object to havethermal properties and be able to be used in thermal simulations. |
Methods
| Declared | Description |
|---|---|
| AddTarget | Adds a target to the list of targets that the CCD sensor can see. Thiswill create a new target with the specified parameters. |
| Capture | A method that will capture the data of the payload and store it insome form of byte array. |
| ClearBuffer | Clears the cache of the CCD sensor, which will reset the data bufferto an empty state. |
| RemoveTarget | Removes a target from the list of targets that the CCD sensor can see. |
| ShutDown | Disables this device and zeroes out the data. |
| Inherited | Description |
|---|---|
| AddObject | Returns a new simulation object with the specified type. |
| Attach | Attempts to attach this object to a new parent. This will only work if the current object is no parented to anyother object. |
| ContainsModelWithID | Returns true if an attached model satisfies the specified ID. |
| ContainsModelWithType | Returns true if an attached model satisfies the specified type. |
| Detach | This 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. |
| FindBehavioursWithType | Returns all attached behaviours that satisfies the specified type. |
| FindBehaviourWithID | Returns an attached behaviour that satisfies the specified ID. |
| FindBehaviourWithType | Returns an attached behaviour that satisfies the specified type. |
| FindChildrenWithType | Returns all attached children that satisfies the specified type. |
| FindChildWithID | Returns an attached child that satisfies the specified ID. |
| FindChildWithType | Returns an attached child that satisfies the specified type. |
| FindModelsWithType | Returns all attached models that satisfies the specified type. |
| FindModelWithID | Returns an attached model that satisfies the specified ID. |
| FindModelWithType | Returns an attached model that satisfies the specified type. |
| FindParentWithID | Returns an attached parent that satisfies the specified ID. |
| FindParentWithType | Returns an attached parent that satisfies the specified type. |
| FindRootWithID | Returns a root object that satisfies the specified ID. |
| FindRootWithType | Returns a root object that satisfies the specified type. |
| GetModel | Returns a valid assigned model with the specified type. |
| GetWorldForward | [DEPRECATED] THIS FUNCTION WILL BE REMOVED AND SHOULD NOT BE USED. |
| GetWorldRight | [DEPRECATED] THIS FUNCTION WILL BE REMOVED AND SHOULD NOT BE USED. |
| GetWorldTransform | Returns 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. |
| GetWorldUp | [DEPRECATED] THIS FUNCTION WILL BE REMOVED AND SHOULD NOT BE USED. |
| ReadBodyTransform | This method will reset the dirty flag on the mass so that it has been read successfully and is valid. |
| SetWorldTransform | [DEPRECATED] THIS FUNCTION WILL BE REMOVED AND SHOULD NOT BE USED. |
| UpdateMassProperties | Updates the mass properties of the current physical object at a particular time. |