agi.foundation.communications.signalprocessing

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

Class VariableGainAmplifierBackoffCurves

java.lang.Object

agi.foundation.communications.signalprocessing.VariableGainAmplifierBackoffCurves

All Implemented Interfaces:

IDisposable, ICloneWithContext, IThreadAware, AutoCloseable

public class VariableGainAmplifierBackoffCurves
extends Object
implements IThreadAware, IDisposable

Represents a set of input back-off curves.

Constructor Summary

Constructors

Modifier	Constructor and Description
	VariableGainAmplifierBackoffCurves(Function2<Double,Double> iboOboCurve) Initializes an instance with a given input back-off/output back-off (IBO/OBO) curve.
	VariableGainAmplifierBackoffCurves(Function2<Double,Double> iboOboCurve, Function2<Double,Double> iboCarrierToImCurve) Initializes an instance with a given input back-off/output back-off (IBO/OBO) curve and input back-off/carrier to intermodulation noise spectral density (IBO/(C/No)Im) curve.
protected	VariableGainAmplifierBackoffCurves(VariableGainAmplifierBackoffCurves existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
Object	clone(CopyContext context) Clones this object using the specified context.
void	dispose() Releases any resources associated with this instance.
protected void	dispose(boolean disposing) Releases any resources associated with this instance.
Function2<Double,Double>	getIboCarrierToImCurve() Gets a function which represents the input back-off/carrier to intermodulation noise spectral density (IBO/(C/No)Im) curve.
Function2<Double,Double>	getIboOboCurve() Gets a function which represents the input back-off/output back-off (IBO/OBO) curve.
boolean	getIsThreadSafe() Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously.

Methods inherited from class java.lang.Object

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

Methods inherited from interface agi.foundation.compatibility.IDisposable

close

Constructor Detail

VariableGainAmplifierBackoffCurves

public VariableGainAmplifierBackoffCurves(@Nonnull
                                          Function2<Double,Double> iboOboCurve)

Initializes an instance with a given input back-off/output back-off (IBO/OBO) curve. The input back-off/carrier to intermodulation noise spectral density (IBO/(C/No)_Im) curve is set to null.

Parameters:

iboOboCurve - A function representing the input back-off/output back-off (IBO/OBO) curve.

Throws:

ArgumentNullException - Thrown if the iboOboCurve is null.

VariableGainAmplifierBackoffCurves

public VariableGainAmplifierBackoffCurves(@Nonnull
                                          Function2<Double,Double> iboOboCurve,
                                          Function2<Double,Double> iboCarrierToImCurve)

Initializes an instance with a given input back-off/output back-off (IBO/OBO) curve and input back-off/carrier to intermodulation noise spectral density (IBO/(C/No)_Im) curve.

Parameters:

iboOboCurve - A function representing the input back-off/output back-off (IBO/OBO) curve.

iboCarrierToImCurve - A function representing the input back-off/carrier to intermodulation noise spectral density (IBO/(C/No)_Im) curve.

Throws:

ArgumentNullException - Thrown if the iboOboCurve is null. (iboCarrierToImCurve can be null without throwing an exception).

VariableGainAmplifierBackoffCurves

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

clone

public final Object clone(CopyContext context)

Clones this object using the specified 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:

1. Fields that are aggregate parts of the object should always be copied. A referenced object is an aggregate if properties or methods on the object being copied can modify the externally-visible value of the referenced object.
2. If the semantics of the referenced object require that it have a single parent, owner, context, etc., and the object being copied is that parent, owner, or context, then the referenced object should always be copied.

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:

1. For references to other evaluators ONLY, simply assign the reference in the constructor instead of calling CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to non-evaluators.
2. Call IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the same CopyContext passed to the constructor.
3. Implement 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;

Specified by:

clone in interface ICloneWithContext

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

dispose

public final void dispose()

Releases any resources associated with this instance.

Specified by:

dispose in interface IDisposable

dispose

protected void dispose(boolean disposing)

Releases any resources associated with this instance.

Parameters:

disposing - true to release both managed and unmanaged resources; false to release only unmanaged resources.

getIsThreadSafe

public final boolean getIsThreadSafe()

Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously.

If this property is true, all methods and properties are guaranteed to be thread safe. Conceptually, an object that returns true for this method acts as if there is a lock protecting each method and property such that only one thread at a time can be inside any method or property in the class. In reality, such locks are generally not used and are in fact discouraged. However, the user must not experience any exceptions or inconsistent behavior that would not be experienced if such locks were used.

If this property is false, the behavior when using this class from multiple threads simultaneously is undefined and may include inconsistent results and exceptions. Clients wishing to use multiple threads should call CopyForAnotherThread.copy(T) to get a separate instance of the object for each thread.

Specified by:

getIsThreadSafe in interface IThreadAware

getIboOboCurve

@Nonnull
public final Function2<Double,Double> getIboOboCurve()

Gets a function which represents the input back-off/output back-off (IBO/OBO) curve.

The below figure shows the typical variation of output back-off (OBO) as a function of input back-off (IBO), for single carrier and multi-carrier operation. The variable gain amplifier will evaluate this function for a computed IBO, in order to the determine the amplifier OBO. The model defines IBO as the carrier power at the input of the amplifier normalized by the saturation input power (Pi/Pi_sat). OBO is defined as carrier power at the output of the amplifier normalized by the saturation output power (Po/Po_sat).

getIboCarrierToImCurve

@Nullable
public final Function2<Double,Double> getIboCarrierToImCurve()

Gets a function which represents the input back-off/carrier to intermodulation noise spectral density (IBO/(C/No)_Im) curve.

The below figure shows the typical variation of carrier to noise spectral density due to intermodulation (C/No)_Im as a function of input back-off (IBO). The model defines IBO as the carrier power at the input of the amplifier normalized by the saturation input power (Pi/Pi_sat). The variable gain amplifier will evaluate this function for a computed IBO, in order to the determine the (C/No)_Im. The noise temperature due to intermodulation is then computed by dividing the carrier power by the (C/No)_Im times Boltzmann's constant.