agi.foundation.communications.signalprocessing

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

Class Photodetector

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.communications.signalprocessing.SignalProcessor

agi.foundation.communications.signalprocessing.Photodetector

All Implemented Interfaces:

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

Direct Known Subclasses:

Photodiode

public abstract class Photodetector
extends SignalProcessor

Base class for a photodetector signal processor.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Photodetector() Initializes a new instance.
protected	Photodetector(Photodetector existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
protected	Photodetector(SignalProcessor input, IServiceProvider parentReceiver, double fieldOfView, double wavelength, double bandwidth, 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, and central body.

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	checkForSameDefinition(Photodetector other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(SignalProcessor 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.
void	enumerateDependencies(DependencyEnumerator enumerator) Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon.
double	getBandwidth() Gets the photodetector bandwidth, in hertz.
CentralBody	getCentralBody() Gets the central body for the photodetector.
double	getFieldOfView() Gets the field of view of the photodetector in radians.
SignalProcessor	getInputSignalProcessor() Gets the input to the signal processor.
double	getOpticalBandpassFilterBandwidth() Gets the bandwidth of the optical bandpass filter preceding the detector, in hertz.
IServiceProvider	getParentReceiver() Gets the parent receiver whose axis is used in order to determine if the sun is within the field-of-view of the detector.
SignalComputation	getSkySpectralRadiance() Gets the sky spectral radiance model which produces a value in W * m-2 * sr-1 * Hz-1.
SignalComputation	getSunSpectralRadiantEmittance() Gets the sun spectral radiant emittance model which produces a value in W * m-2 * Hz-1.
double	getWavelength() Gets the design wavelength of the photodetector, in meters.
void	setBandwidth(double value) Sets the photodetector bandwidth, in hertz.
void	setCentralBody(CentralBody value) Sets the central body for the photodetector.
void	setFieldOfView(double value) Sets the field of view of the photodetector in radians.
void	setInputSignalProcessor(SignalProcessor value) Sets the input to the signal processor.
void	setOpticalBandpassFilterBandwidth(double value) Sets the bandwidth of the optical bandpass filter preceding the detector, in hertz.
void	setParentReceiver(IServiceProvider value) Sets the parent receiver whose axis is used in order to determine if the sun is within the field-of-view of the detector.
void	setSkySpectralRadiance(SignalComputation value) Sets the sky spectral radiance model which produces a value in W * m-2 * sr-1 * Hz-1.
void	setSunSpectralRadiantEmittance(SignalComputation value) Sets the sun spectral radiant emittance model which produces a value in W * m-2 * Hz-1.
void	setWavelength(double value) Sets the design wavelength of the photodetector, in meters.

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

Photodetector

protected Photodetector()

Initializes a new instance.

Photodetector

protected Photodetector(SignalProcessor input,
                        IServiceProvider parentReceiver,
                        double fieldOfView,
                        double wavelength,
                        double bandwidth,
                        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, 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.

centralBody - The central body.

Photodetector

protected Photodetector(@Nonnull
                        Photodetector 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(SignalProcessor 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 SignalProcessor

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(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).

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 Photodetector.checkForSameDefinition(agi.foundation.communications.signalprocessing.SignalProcessor) method.

Overrides:

computeCurrentDefinitionHashCode in class SignalProcessor

Returns:

The computed hash code.

enumerateDependencies

public void enumerateDependencies(DependencyEnumerator enumerator)

Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon. Derived classes which contain additional dependencies MUST override this method, call the base implementation, and enumerate dependencies introduced by the derived class.

Specified by:

enumerateDependencies in interface IEnumerateDependencies

Overrides:

enumerateDependencies in class DefinitionalObject

Parameters:

enumerator - The enumerator that is informed of the dependencies of this object.

getFieldOfView

public final double getFieldOfView()

Gets the field of view of the photodetector in radians.

setFieldOfView

public final void setFieldOfView(double value)

Sets the field of view of the photodetector in radians.

getOpticalBandpassFilterBandwidth

public final double getOpticalBandpassFilterBandwidth()

Gets the bandwidth of the optical bandpass filter preceding the detector, in hertz.

setOpticalBandpassFilterBandwidth

public final void setOpticalBandpassFilterBandwidth(double value)

Sets the bandwidth of the optical bandpass filter preceding the detector, in hertz.

getSkySpectralRadiance

public final SignalComputation getSkySpectralRadiance()

Gets the sky spectral radiance model which produces a value in W * m^-2 * sr^-1 * Hz^-1.

setSkySpectralRadiance

public final void setSkySpectralRadiance(SignalComputation value)

Sets the sky spectral radiance model which produces a value in W * m^-2 * sr^-1 * Hz^-1.

getSunSpectralRadiantEmittance

public final SignalComputation getSunSpectralRadiantEmittance()

Gets the sun spectral radiant emittance model which produces a value in W * m^-2 * Hz^-1.

setSunSpectralRadiantEmittance

public final void setSunSpectralRadiantEmittance(SignalComputation value)

Sets the sun spectral radiant emittance model which produces a value in W * m^-2 * Hz^-1.

getWavelength

public final double getWavelength()

Gets the design wavelength of the photodetector, in meters.

setWavelength

public final void setWavelength(double value)

Sets the design wavelength of the photodetector, in meters.

getBandwidth

public final double getBandwidth()

Gets the photodetector bandwidth, in hertz.

setBandwidth

public final void setBandwidth(double value)

Sets the photodetector bandwidth, in hertz.

getCentralBody

public final CentralBody getCentralBody()

Gets the central body for the photodetector.

setCentralBody

public final void setCentralBody(CentralBody value)

Sets the central body for the photodetector.

getParentReceiver

public final IServiceProvider getParentReceiver()

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

setParentReceiver

public final void setParentReceiver(IServiceProvider value)

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

getInputSignalProcessor

public SignalProcessor getInputSignalProcessor()

Gets the input to the signal processor.

Specified by:

getInputSignalProcessor in class SignalProcessor

setInputSignalProcessor

public void setInputSignalProcessor(SignalProcessor value)

Sets the input to the signal processor.

Specified by:

setInputSignalProcessor in class SignalProcessor