public class ComplexCrossSectionScatteringCoefficient extends ComplexMatrix
The 2x2 scattering coefficient matrix is defined as: [0,0] = The complex scattering coefficient for the primary polarization channel. [0,1] = The complex scattering coefficient for the cross polarization leakage from the primary polarization channel to the orthogonal polarization channel. [1,0] = The complex scattering coefficient for the cross polarization leakage from the orthogonal polarization channel to the primary polarization channel. [1,1] = The complex scattering coefficient for the orthogonal polarization channel.
| Modifier | Constructor and Description |
|---|---|
|
ComplexCrossSectionScatteringCoefficient()
Initializes a new instance.
|
|
ComplexCrossSectionScatteringCoefficient(Complex primaryChannel,
Complex primaryToOrthogonalChannelLeakage,
Complex orthogonalToPrimaryChannelLeakage,
Complex orthogonalChannel)
Initializes a new instance with four complex values which represent the 2x2 matrix.
|
protected |
ComplexCrossSectionScatteringCoefficient(ComplexCrossSectionScatteringCoefficient existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
|
ComplexCrossSectionScatteringCoefficient(double primaryPolarizationChannelRealPart)
Initializes a new instance.
|
| Modifier and Type | Method and Description |
|---|---|
protected boolean |
checkForSameDefinition(ComplexCrossSectionScatteringCoefficient other)
Checks to determine if another instance has the same definition as this instance and
returns
true if it does. |
protected boolean |
checkForSameDefinition(ComplexMatrix 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.
|
add, add, addAssign, checkForSameDefinition, clear, elementDivide, elementDivideAssign, elementMultiply, elementMultiply, elementMultiplyAssign, equals, get, getColumnDimension, getMatrix, getMatrix, getMatrix, getMatrix, getMatrix, getMatrix, getMatrix, getMatrix, getRowDimension, hashCode, hermitianTranspose, identity, inverse, multiply, multiply, multiply, multiplyAssign, postMultiply, preMultiply, set, subtract, subtractAssign, subtractFrom, transposeareSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, enumerateDependencies, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozenpublic ComplexCrossSectionScatteringCoefficient()
public ComplexCrossSectionScatteringCoefficient(double primaryPolarizationChannelRealPart)
primaryPolarizationChannelRealPart - The real part of the primary polarization channel complex scattering coefficient.public ComplexCrossSectionScatteringCoefficient(@Nonnull Complex primaryChannel, @Nonnull Complex primaryToOrthogonalChannelLeakage, @Nonnull Complex orthogonalToPrimaryChannelLeakage, @Nonnull Complex orthogonalChannel)
primaryChannel - The complex scattering coefficient for the primary polarization channel.primaryToOrthogonalChannelLeakage - The complex scattering coefficient for the cross polarization leakage from the primary polarization channel to the orthogonal polarization channel.orthogonalToPrimaryChannelLeakage - The complex scattering coefficient for the cross polarization leakage from the orthogonal polarization channel to the primary polarization channel.orthogonalChannel - The complex scattering coefficient for the orthogonal polarization channel.protected ComplexCrossSectionScatteringCoefficient(@Nonnull ComplexCrossSectionScatteringCoefficient 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 ComplexMatrixcontext - The context to use to perform the copy.protected final boolean checkForSameDefinition(ComplexMatrix 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 ComplexMatrixother - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected boolean checkForSameDefinition(ComplexCrossSectionScatteringCoefficient 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()
ComplexCrossSectionScatteringCoefficient.checkForSameDefinition(agi.foundation.coordinates.ComplexMatrix) method.computeCurrentDefinitionHashCode in class ComplexMatrix