agi.foundation.communications.signalprocessing

(agi.foundation.communications-2024r3.jar)

Class Photodiode

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.communications.signalprocessing.SignalProcessor

agi.foundation.communications.signalprocessing.Photodetector

agi.foundation.communications.signalprocessing.Photodiode

All Implemented Interfaces:

ISignalSource, ISignalOutputService, ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable, IServiceProvider

Direct Known Subclasses:

AvalanchePhotodiode, PinPhotodiode

public abstract class Photodiode
extends Photodetector

Base class for a photodiode photodetector.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Photodiode() Initializes a new instance.
protected	Photodiode(Photodiode existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
protected	Photodiode(SignalProcessor input, IServiceProvider parentReceiver, double fieldOfView, double wavelength, double bandwidth, double noiseTemperature, double efficiency, double darkCurrent, double loadImpedance, SignalComputation skySpectralRadiance, SignalComputation sunSpectralRadiantEmittance, double opticalBandpassFilterBandwidth) Initializes a new instance with given input signal processor, parent receiver, field-of-view, bandwidth, sky spectral radiance model, sun spectral radiant emittance model, optical bandpass filter bandwidth, noise temperature, efficiency, dark current, and load impedance.
protected	Photodiode(SignalProcessor input, IServiceProvider parentReceiver, double fieldOfView, double wavelength, double bandwidth, double noiseTemperature, double efficiency, double darkCurrent, double loadImpedance, SignalComputation skySpectralRadiance, SignalComputation sunSpectralRadiantEmittance, double opticalBandpassFilterBandwidth, CentralBody centralBody) Initializes a new instance with given input signal processor, parent receiver, field-of-view, bandwidth, sky spectral radiance model, sun spectral radiant emittance model, optical bandpass filter bandwidth, noise temperature, efficiency, dark current, load impedance, and central body.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(Photodetector other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected abstract boolean	checkForSameDefinition(Photodiode other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
double	getDarkCurrent() Gets the photodetector dark current in amps.
double	getEfficiency() Gets the photodetector quantum efficiency.
double	getLoadImpedance() Gets the photodetector load impedance in ohms.
double	getNoiseTemperature() Gets the photodetector noise temperature, in kelvin.
void	setDarkCurrent(double value) Sets the photodetector dark current in amps.
void	setEfficiency(double value) Sets the photodetector quantum efficiency.
void	setLoadImpedance(double value) Sets the photodetector load impedance in ohms.
void	setNoiseTemperature(double value) Sets the photodetector noise temperature, in kelvin.
protected void	validateProperties(EvaluatorGroup group, SignalPropagationGraph graph) Validates that required properties and parameters are configured correctly in order to get an evaluator for this instance.

Methods inherited from class agi.foundation.communications.signalprocessing.Photodetector

checkForSameDefinition, enumerateDependencies, getBandwidth, getCentralBody, getFieldOfView, getInputSignalProcessor, getOpticalBandpassFilterBandwidth, getParentReceiver, getSkySpectralRadiance, getSunSpectralRadiantEmittance, getWavelength, setBandwidth, setCentralBody, setFieldOfView, setInputSignalProcessor, setOpticalBandpassFilterBandwidth, setParentReceiver, setSkySpectralRadiance, setSunSpectralRadiantEmittance, setWavelength

Methods inherited from class agi.foundation.communications.signalprocessing.SignalProcessor

checkForSameDefinition, getProcessingDelay, getService, getSignalEvaluator, getSignalEvaluator, getSignalOutput

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, clone, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Photodiode

protected Photodiode()

Initializes a new instance.

Photodiode

protected Photodiode(SignalProcessor input,
                     IServiceProvider parentReceiver,
                     double fieldOfView,
                     double wavelength,
                     double bandwidth,
                     double noiseTemperature,
                     double efficiency,
                     double darkCurrent,
                     double loadImpedance,
                     SignalComputation skySpectralRadiance,
                     SignalComputation sunSpectralRadiantEmittance,
                     double opticalBandpassFilterBandwidth)

Initializes a new instance with given input signal processor, parent receiver, field-of-view, bandwidth, sky spectral radiance model, sun spectral radiant emittance model, optical bandpass filter bandwidth, noise temperature, efficiency, dark current, and load impedance.

Parameters:

input - The signal processor from which the signals to process are obtained.

parentReceiver - The parent receiver whose axis is used in order to determine if the sun is within the field-of-view of the detector.

fieldOfView - The field-of-view angle of the photodetector used to compute detector background light noise.

wavelength - The design wavelength of the photodetector.

bandwidth - The bandwidth for the photodetector electronics. Used in order to compute the detector thermal noise.

skySpectralRadiance - The sky spectral radiance model used to compute the sky background light noise.

sunSpectralRadiantEmittance - The sun spectral radiant emittance model used to compute the sun background light noise if it is determined that the sun is within the detector field-of-view.

opticalBandpassFilterBandwidth - The bandwidth of the detector optics bandpass filter.

noiseTemperature - The detector circuit noise temperature.

efficiency - The quantum efficiency of the detector.

darkCurrent - The current present when no light is impinging on the detector.

loadImpedance - The detector circuit equivalent resistance.

Photodiode

protected Photodiode(SignalProcessor input,
                     IServiceProvider parentReceiver,
                     double fieldOfView,
                     double wavelength,
                     double bandwidth,
                     double noiseTemperature,
                     double efficiency,
                     double darkCurrent,
                     double loadImpedance,
                     SignalComputation skySpectralRadiance,
                     SignalComputation sunSpectralRadiantEmittance,
                     double opticalBandpassFilterBandwidth,
                     CentralBody centralBody)

Initializes a new instance with given input signal processor, parent receiver, field-of-view, bandwidth, sky spectral radiance model, sun spectral radiant emittance model, optical bandpass filter bandwidth, noise temperature, efficiency, dark current, load impedance, and central body.

Parameters:

input - The signal processor from which the signals to process are obtained.

parentReceiver - The parent receiver whose axis is used in order to determine if the sun is within the field-of-view of the detector.

fieldOfView - The field-of-view angle of the photodetector used to compute detector background light noise.

wavelength - The design wavelength of the photodetector.

bandwidth - The bandwidth for the photodetector electronics. Used in order to compute the detector thermal noise.

skySpectralRadiance - The sky spectral radiance model used to compute the sky background light noise.

sunSpectralRadiantEmittance - The sun spectral radiant emittance model used to compute the sun background light noise if it is determined that the sun is within the detector field-of-view.

opticalBandpassFilterBandwidth - The bandwidth of the detector optics bandpass filter.

noiseTemperature - The detector circuit noise temperature.

efficiency - The quantum efficiency of the detector.

darkCurrent - The current present when no light is impinging on the detector.

loadImpedance - The detector circuit equivalent resistance.

centralBody - The central body.

Photodiode

protected Photodiode(@Nonnull
                     Photodiode existingInstance,
                     @Nonnull
                     CopyContext context)

Initializes a new instance as a copy of an existing instance.

See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor in a derived class.

Parameters:

existingInstance - The existing instance to copy.

context - A CopyContext that controls the depth of the copy.

Throws:

ArgumentNullException - Thrown when existingInstance or context is null.

Method Detail

checkForSameDefinition

protected final boolean checkForSameDefinition(Photodetector other)

Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Specified by:

checkForSameDefinition in class Photodetector

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

checkForSameDefinition

protected abstract boolean checkForSameDefinition(Photodiode other)

Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

computeCurrentDefinitionHashCode

protected int computeCurrentDefinitionHashCode()

Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the Photodiode.checkForSameDefinition(agi.foundation.communications.signalprocessing.Photodetector) method.

Overrides:

computeCurrentDefinitionHashCode in class Photodetector

Returns:

The computed hash code.

getNoiseTemperature

public final double getNoiseTemperature()

Gets the photodetector noise temperature, in kelvin.

setNoiseTemperature

public final void setNoiseTemperature(double value)

Sets the photodetector noise temperature, in kelvin.

getEfficiency

public final double getEfficiency()

Gets the photodetector quantum efficiency.

setEfficiency

public final void setEfficiency(double value)

Sets the photodetector quantum efficiency.

getDarkCurrent

public final double getDarkCurrent()

Gets the photodetector dark current in amps.

setDarkCurrent

public final void setDarkCurrent(double value)

Sets the photodetector dark current in amps.

getLoadImpedance

public final double getLoadImpedance()

Gets the photodetector load impedance in ohms.

setLoadImpedance

public final void setLoadImpedance(double value)

Sets the photodetector load impedance in ohms.

validateProperties

protected void validateProperties(@Nonnull
                                  EvaluatorGroup group,
                                  @Nonnull
                                  SignalPropagationGraph graph)

Validates that required properties and parameters are configured correctly in order to get an evaluator for this instance.

Parameters:

group - The evaluator group in which to create the evaluator.

graph - The graph of the communication links used to propagate signals.

Throws:

ArgumentNullException - Thrown when group or graph is null.

PropertyInvalidException - Thrown when InputSignalProcessor (get / set), SkySpectralRadiance (get / set), SunSpectralRadiantEmittance (get / set), ParentReceiver (get / set), or CentralBody (get / set) are null, or when NoiseTemperature (get / set) or DarkCurrent (get / set) are negative, or when Bandwidth (get / set), LoadImpedance (get / set), or OpticalBandpassFilterBandwidth (get / set) are not greater than zero, or when Wavelength (get / set) is less than CommunicationsConstants.MinimumOpticalWavelength or greater than CommunicationsConstants.MaximumOpticalWavelength, or when FieldOfView (get / set) is less than or equal to zero or greater than Math.PI, or when Efficiency (get / set) is less than zero or greater than one.