public class AvalanchePhotodiode extends Photodiode
This is the avalanche photodiode photodetector S/N model taken from chapter 2 page 72 of "Optical Wireless Communications - System and Channel Modeling with MATLAB" by Z. Ghassemlooy, W. Popoola, and S. Rajbhandari.
| Modifier | Constructor and Description |
|---|---|
|
AvalanchePhotodiode()
Initializes a new instance.
|
protected |
AvalanchePhotodiode(AvalanchePhotodiode existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
|
AvalanchePhotodiode(SignalProcessor input,
IServiceProvider parentReceiver,
double fieldOfView,
double wavelength,
double bandwidth,
double noiseTemperature,
double efficiency,
double darkCurrent,
double loadImpedance,
double noiseFactor,
double gain,
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,
load impedance, noise factor, and gain.
|
|
AvalanchePhotodiode(SignalProcessor input,
IServiceProvider parentReceiver,
double fieldOfView,
double wavelength,
double bandwidth,
double noiseTemperature,
double efficiency,
double darkCurrent,
double loadImpedance,
double noiseFactor,
double gain,
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, noise factor, gain, central body.
|
| Modifier and Type | Method and Description |
|---|---|
protected boolean |
checkForSameDefinition(AvalanchePhotodiode other)
Checks to determine if another instance has the same definition as this instance and
returns
true if it does. |
protected boolean |
checkForSameDefinition(Photodiode other)
Checks to determine if another instance has the same definition as this instance and
returns
true if it does. |
Object |
clone(CopyContext context)
Clones this object using the specified context.
|
protected int |
computeCurrentDefinitionHashCode()
Computes a hash code based on the current properties of this object.
|
double |
getGain()
Gets the photodetector gain.
|
double |
getNoiseFactor()
Gets the photodetector noise factor.
|
SignalEvaluator |
getSignalEvaluator(EvaluatorGroup group,
SignalPropagationGraph graph)
Get an evaluator which can produce the output from the signal processor.
|
void |
setGain(double value)
Sets the photodetector gain.
|
void |
setNoiseFactor(double value)
Sets the photodetector noise factor.
|
checkForSameDefinition, getDarkCurrent, getEfficiency, getLoadImpedance, getNoiseTemperature, setDarkCurrent, setEfficiency, setLoadImpedance, setNoiseTemperature, validatePropertiescheckForSameDefinition, enumerateDependencies, getBandwidth, getCentralBody, getFieldOfView, getInputSignalProcessor, getOpticalBandpassFilterBandwidth, getParentReceiver, getSkySpectralRadiance, getSunSpectralRadiantEmittance, getWavelength, setBandwidth, setCentralBody, setFieldOfView, setInputSignalProcessor, setOpticalBandpassFilterBandwidth, setParentReceiver, setSkySpectralRadiance, setSunSpectralRadiantEmittance, setWavelengthcheckForSameDefinition, getProcessingDelay, getService, getSignalEvaluator, getSignalOutputareSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozenpublic AvalanchePhotodiode()
public AvalanchePhotodiode(SignalProcessor input, IServiceProvider parentReceiver, double fieldOfView, double wavelength, double bandwidth, double noiseTemperature, double efficiency, double darkCurrent, double loadImpedance, double noiseFactor, double gain, SignalComputation skySpectralRadiance, SignalComputation sunSpectralRadiantEmittance, double opticalBandpassFilterBandwidth)
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 noise temperature of the detector circuitry used to compute noise temperature, in kelvin.efficiency - The quantum efficiency of the detector.darkCurrent - The dark current of the detector in Amps, used to compute the dark current noise.loadImpedance - The load impedance used to compute thermal noise.noiseFactor - The noise factor of the detector used to compute the detector excess noise.gain - The detector gain.public AvalanchePhotodiode(SignalProcessor input, IServiceProvider parentReceiver, double fieldOfView, double wavelength, double bandwidth, double noiseTemperature, double efficiency, double darkCurrent, double loadImpedance, double noiseFactor, double gain, SignalComputation skySpectralRadiance, SignalComputation sunSpectralRadiantEmittance, double opticalBandpassFilterBandwidth, CentralBody centralBody)
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 noise temperature of the detector circuitry used to compute noise temperature, in kelvin.efficiency - The quantum efficiency of the detector.darkCurrent - The dark current of the detector in Amps, used to compute the dark current noise.loadImpedance - The load impedance used to compute thermal noise.noiseFactor - The noise factor of the detector used to compute the detector excess noise.gain - The detector gain.centralBody - The central body.protected AvalanchePhotodiode(@Nonnull AvalanchePhotodiode existingInstance, @Nonnull CopyContext context)
See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor
in a derived class.
existingInstance - The existing instance to copy.context - A CopyContext that controls the depth of the copy.ArgumentNullException - Thrown when existingInstance or context is null.public Object clone(CopyContext context)
This method should be implemented to call a copy constructor on the class of the
object being cloned. The copy constructor should take the CopyContext as a parameter
in addition to the existing instance to copy. The copy constructor should first call
CopyContext.addObjectMapping(T, T) to identify the newly constructed instance
as a copy of the existing instance. It should then copy all fields, using
CopyContext.updateReference(T) to copy any reference fields.
A typical implementation of ICloneWithContext:
public static class MyClass implements ICloneWithContext {
public MyClass(MyClass existingInstance, CopyContext context) {
context.addObjectMapping(existingInstance, this);
someReference = context.updateReference(existingInstance.someReference);
}
@Override
public final Object clone(CopyContext context) {
return new MyClass(this, context);
}
private Object someReference;
}
In general, all fields that are reference types should be copied with a call to
CopyContext.updateReference(T). There are a couple of exceptions:
If one of these exceptions applies, the CopyContext should be given an opportunity
to update the reference before the reference is copied explicitly. Use
CopyContext.updateReference(T) to update the reference. If CopyContext.updateReference(T) returns
the original object, indicating that the context does not have a replacement registered,
then copy the object manually by invoking a Clone method, a copy constructor, or by manually
constructing a new instance and copying the values.
alwaysCopy = context.updateReference(existingInstance.alwaysCopy);
if (existingInstance.alwaysCopy != null && alwaysCopy == existingInstance.alwaysCopy) {
alwaysCopy = (AlwaysCopy) existingInstance.alwaysCopy.clone(context);
}
If you are implementing an evaluator (a class that implements IEvaluator), the
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) method shares some responsibilities with the
copy context constructor. Code duplication can be avoided by doing the following:
CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to
non-evaluators.
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the
same CopyContext passed to the constructor.
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as normal. See the reference documentation for
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) for more information on implementing that method.
public MyClass(MyClass existingInstance, CopyContext context) {
super(existingInstance, context);
someReference = context.updateReference(existingInstance.someReference);
evaluatorReference = existingInstance.evaluatorReference;
updateEvaluatorReferences(context);
}
@Override
public void updateEvaluatorReferences(CopyContext context) {
evaluatorReference = context.updateReference(evaluatorReference);
}
@Override
public Object clone(CopyContext context) {
return new MyClass(this, context);
}
private Object someReference;
private IEvaluator evaluatorReference;clone in interface ICloneWithContextclone in class DefinitionalObjectcontext - The context to use to perform the copy.protected final boolean checkForSameDefinition(Photodiode other)
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).checkForSameDefinition in class Photodiodeother - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected boolean checkForSameDefinition(AvalanchePhotodiode other)
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).other - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected int computeCurrentDefinitionHashCode()
AvalanchePhotodiode.checkForSameDefinition(agi.foundation.communications.signalprocessing.Photodiode) method.computeCurrentDefinitionHashCode in class Photodiodepublic final double getNoiseFactor()
public final void setNoiseFactor(double value)
public final double getGain()
public final void setGain(double value)
public SignalEvaluator getSignalEvaluator(EvaluatorGroup group, SignalPropagationGraph graph)
getSignalEvaluator in interface ISignalSourcegetSignalEvaluator in class SignalProcessorgroup - The evaluator group in which to create the evaluator.graph - The graph of the communication links used to propagate signals.ArgumentNullException - Thrown when group or graph is null.