Click or drag to resize

PinPhotodiode Class

Represents a PIN type photodiode photodetector.
Inheritance Hierarchy

Namespace:  AGI.Foundation.Communications.SignalProcessing
Assembly:  AGI.Foundation.Communications (in AGI.Foundation.Communications.dll) Version: 24.2.419.0 (24.2.419.0)
Syntax
public class PinPhotodiode : Photodiode

The PinPhotodiode type exposes the following members.

Constructors
  NameDescription
Public methodPinPhotodiode
Initializes a new instance.
Protected methodPinPhotodiode(PinPhotodiode, CopyContext)
Initializes a new instance as a copy of an existing instance.
Public methodPinPhotodiode(SignalProcessor, IServiceProvider, Double, Double, Double, Double, Double, Double, Double, SignalComputation, SignalComputation, Double)
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.
Public methodPinPhotodiode(SignalProcessor, IServiceProvider, Double, Double, Double, Double, Double, Double, Double, SignalComputation, SignalComputation, Double, 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.
Top
Properties
  NameDescription
Public propertyBandwidth
Gets or sets the photodetector bandwidth, in hertz.
(Inherited from Photodetector.)
Public propertyCentralBody
Gets or sets the central body for the photodetector.
(Inherited from Photodetector.)
Public propertyDarkCurrent
Gets or sets the photodetector dark current in amps.
(Inherited from Photodiode.)
Public propertyEfficiency
Gets or sets the photodetector quantum efficiency.
(Inherited from Photodiode.)
Public propertyFieldOfView
Gets or sets the field of view of the photodetector in radians.
(Inherited from Photodetector.)
Public propertyInputSignalProcessor
Gets or sets the input to the signal processor.
(Inherited from Photodetector.)
Public propertyIsFrozen
Gets a value indicating whether this object is frozen. A frozen object cannot be modified and an ObjectFrozenException will be thrown if an attempt is made to do so.
(Inherited from DefinitionalObject.)
Public propertyLoadImpedance
Gets or sets the photodetector load impedance in ohms.
(Inherited from Photodiode.)
Public propertyNoiseTemperature
Gets or sets the photodetector noise temperature, in kelvin.
(Inherited from Photodiode.)
Public propertyOpticalBandpassFilterBandwidth
Gets or sets the bandwidth of the optical bandpass filter preceding the detector, in hertz.
(Inherited from Photodetector.)
Public propertyParentReceiver
Gets or sets the parent receiver whose axis is used in order to determine if the sun is within the field-of-view of the detector.
(Inherited from Photodetector.)
Public propertySignalOutput
Gets the signal processor representing the output of the service provider.
(Inherited from SignalProcessor.)
Public propertySkySpectralRadiance
Gets or sets the sky spectral radiance model which produces a value in W * m-2 * sr-1 * Hz-1.
(Inherited from Photodetector.)
Public propertySunSpectralRadiantEmittance
Gets or sets the sun spectral radiant emittance model which produces a value in W * m-2 * Hz-1.
(Inherited from Photodetector.)
Public propertyWavelength
Gets or sets the design wavelength of the photodetector, in meters.
(Inherited from Photodetector.)
Top
Methods
  NameDescription
Protected methodCheckForSameDefinition(DefinitionalObject)
Checks to determine if another instance has the same definition as this instance and returns 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 for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Inherited from SignalProcessor.)
Protected methodCheckForSameDefinition(Photodetector)
Checks to determine if another instance has the same definition as this instance and returns 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 for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Inherited from Photodiode.)
Protected methodCheckForSameDefinition(Photodiode)
Checks to determine if another instance has the same definition as this instance and returns 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 for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Overrides PhotodiodeCheckForSameDefinition(Photodiode).)
Protected methodCheckForSameDefinition(PinPhotodiode)
Checks to determine if another instance has the same definition as this instance and returns 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 for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
Protected methodCheckForSameDefinition(SignalProcessor)
Checks to determine if another instance has the same definition as this instance and returns 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 for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Inherited from Photodetector.)
Public methodClone
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(CopyContext).)
Protected methodComputeCurrentDefinitionHashCode
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 CheckForSameDefinition(DefinitionalObject) method.
(Overrides PhotodiodeComputeCurrentDefinitionHashCode.)
Public methodEnumerateDependencies
Enumerates the dependencies of this object by calling EnumerateT(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.
(Inherited from Photodetector.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFreeze
Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.
(Inherited from DefinitionalObject.)
Protected methodFreezeAggregatedObjects
Called by Freeze to also freeze any objects that are considered to be a part of this object. Derived classes which contain additional aggregated objects MUST override this method, call the base implementation, and freeze aggregated objects introduced by the derived class. The objects that need to be frozen in this method are frequently created in this object's constructor and are not settable via properties.
(Inherited from DefinitionalObject.)
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetProcessingDelay
Get an evaluator which computes the time delay between the input and output of this signal processor.
(Inherited from SignalProcessor.)
Public methodGetService
Gets the service object of the specified type.
(Inherited from SignalProcessor.)
Public methodGetSignalEvaluator(SignalPropagationGraph)
Get an evaluator which can produce the output from the signal processor.
(Inherited from SignalProcessor.)
Public methodGetSignalEvaluator(EvaluatorGroup, SignalPropagationGraph)
Get an evaluator which can produce the output from the signal processor.
(Overrides SignalProcessorGetSignalEvaluator(EvaluatorGroup, SignalPropagationGraph).)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsSameDefinition
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodThrowIfFrozen
Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodValidateProperties
Validates that required properties and parameters are configured correctly in order to get an evaluator for this instance.
(Inherited from Photodiode.)
Top
Remarks
This is the PIN 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.
See Also