public class AnsysHfssCrossSectionScatteringCoefficient extends SphericalTabularMonostaticCrossSectionScatteringCoefficient
SphericalTabularMonostaticCrossSectionScatteringCoefficient which contains complex scattering data produced as output from Ansys HFSS. Ansys HFSS can compute complex cross section for platforms based on their
 geometry and material characteristics. It exports complex cross section data in the comma separated value (CSV) file format. Each run of HFSS produces results for one signal source polarization. For example, a signal source
 model with horizontal (H) polarization computes cross section returns for the H-H (H incident and H reflected signal polarization) combination and for V-H (H incident and V reflected signal polarization). V is the vertical polarization.
 A second run produces data for vertical (V) signal polarization and computes cross section returns for the V-V (V incident and V reflected signal polarization) combination and for H-V (V incident and H reflected signal polarization).
 This class can accept a single file for the primary polarization or it can combine the exported files to produce a complex scattering cross section matrix for [HH, HV, VH, VV] values. The class reads the column headers in the CSV
 format files and parses the cross section data frequency value, the polarization scattering metrics element (H-H, V-H, H-V, V-V), phi angle start value (degrees), and phi angle stop value. It then computes the phi angle step value.
 Phi is the clock angle of the spherical coordinate system and is defined as the azimuth angle from the positive x-axis to the orthogonal projection of the point in the x-y plane.
 The first column of the CSV file give the theta values. The starting, ending, and step size for the theta values are determined by reading the first column data. Theta is the cone angle of the spherical coordinate system as is defined
 defined as the zenith angle from the positive z-axis to the point.
 
If two files are imported to construct the full scattering matrix, the following conditions must be true:
The following is an example of a primary horizontal polarization file in this format:
 IWaveTheta [deg], H-H []-Freq='2.8GHz' IWavePhi='-180deg',  H-H []-Freq='2.8GHz' IWavePhi='-178deg'  ...  H-H []-Freq='2.8GHz' IWavePhi='178deg',   H-H []-Freq='2.8GHz' IWavePhi='180deg'  ... V-H []-Freq='2.8GHz' IWavePhi='-180deg',  V-H []-Freq='2.8GHz' IWavePhi='-178deg'  ...  V-H []-Freq='2.8GHz' IWavePhi='178deg',   V-H []-Freq='2.8GHz' IWavePhi='180deg'
 -180,             1.35247111370217 +0.327498382189397i,     1.35272080565699 +0.327786284917021i     ...  1.35247111370217 +0.327498382189397i,     1.35272080565699 +0.327786284917021i    ... 1.35247111370217 +0.327498382189397i,     1.35272080565699 +0.327786284917021i     ...  1.35247111370217 +0.327498382189397i,     1.35272080565699 +0.327786284917021i  
 -178,             1.02703805546412 +0.165331727348533i,     0.997827142181449 +0.132792590938819i    ...  1.02703805546412 +0.165331727348533i,     0.997827142181449 +0.132792590938819i   ... 1.02703805546412 +0.165331727348533i,     0.997827142181449 +0.132792590938819i    ...  1.02703805546412 +0.165331727348533i,     0.997827142181449 +0.132792590938819i
  ...                              ...                                 ...                                         ...                                           ...                                        ...                                      ...                                             ...                                           ...
 178,              1.35247111370217 +0.327498382189397i,     1.35272080565699 +0.327786284917021i     ...  1.35247111370217 +0.327498382189397i,     1.35272080565699 +0.327786284917021i    ... 1.35247111370217 +0.327498382189397i,     1.35272080565699 +0.327786284917021i     ...  1.35247111370217 +0.327498382189397i,     1.35272080565699 +0.327786284917021i  
 180,              1.02703805546412 +0.165331727348533i,     0.997827142181449 +0.132792590938819i    ...  1.02703805546412 +0.165331727348533i,     0.997827142181449 +0.132792590938819i   ... 1.02703805546412 +0.165331727348533i,     0.997827142181449 +0.132792590938819i    ...  1.02703805546412 +0.165331727348533i,     0.997827142181449 +0.132792590938819i
 
 The following is an example of an orthogonal vertical polarization file in this format:
 IWaveTheta [deg], V-V []-Freq='2.8GHz' IWavePhi='-180deg',  V-V []-Freq='2.8GHz' IWavePhi='-178deg'  ...  V-V []-Freq='2.8GHz' IWavePhi='178deg',   V-V []-Freq='2.8GHz' IWavePhi='180deg'  ... H-V []-Freq='2.8GHz' IWavePhi='-180deg',  H-V []-Freq='2.8GHz' IWavePhi='-178deg'  ...  H-V []-Freq='2.8GHz' IWavePhi='178deg',   H-V []-Freq='2.8GHz' IWavePhi='180deg'
 -180,             1.35247111370217 +0.327498382189397i,     1.35272080565699 +0.327786284917021i     ...  1.35247111370217 +0.327498382189397i,     1.35272080565699 +0.327786284917021i    ... 1.35247111370217 +0.327498382189397i,     1.35272080565699 +0.327786284917021i     ...  1.35247111370217 +0.327498382189397i,     1.35272080565699 +0.327786284917021i  
 -178,             1.02703805546412 +0.165331727348533i,     0.997827142181449 +0.132792590938819i    ...  1.02703805546412 +0.165331727348533i,     0.997827142181449 +0.132792590938819i   ... 1.02703805546412 +0.165331727348533i,     0.997827142181449 +0.132792590938819i    ...  1.02703805546412 +0.165331727348533i,     0.997827142181449 +0.132792590938819i
  ...                              ...                                 ...                                         ...                                           ...                                        ...                                      ...                                             ...                                           ...
 178,              1.35247111370217 +0.327498382189397i,     1.35272080565699 +0.327786284917021i     ...  1.35247111370217 +0.327498382189397i,     1.35272080565699 +0.327786284917021i    ... 1.35247111370217 +0.327498382189397i,     1.35272080565699 +0.327786284917021i     ...  1.35247111370217 +0.327498382189397i,     1.35272080565699 +0.327786284917021i  
 180,              1.02703805546412 +0.165331727348533i,     0.997827142181449 +0.132792590938819i    ...  1.02703805546412 +0.165331727348533i,     0.997827142181449 +0.132792590938819i   ... 1.02703805546412 +0.165331727348533i,     0.997827142181449 +0.132792590938819i    ...  1.02703805546412 +0.165331727348533i,     0.997827142181449 +0.132792590938819i
 SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable, SphericalTabularMonostaticCrossSectionScatteringCoefficient.PolarizationScatteringBasis| Modifier | Constructor and Description | 
|---|---|
  | 
AnsysHfssCrossSectionScatteringCoefficient(BufferedReader primaryPolarizationSource)
Initializes a new instance. 
 | 
  | 
AnsysHfssCrossSectionScatteringCoefficient(BufferedReader primaryPolarizationSource,
                                          BufferedReader orthogonalPolarizationSource)
Initializes a new instance. 
 | 
protected  | 
AnsysHfssCrossSectionScatteringCoefficient(SphericalTabularMonostaticCrossSectionScatteringCoefficient existingInstance,
                                          CopyContext context)
Initializes a new instance as a copy of an existing instance. 
 | 
  | 
AnsysHfssCrossSectionScatteringCoefficient(String primaryPolarizationFileName)
Initializes a new instance. 
 | 
  | 
AnsysHfssCrossSectionScatteringCoefficient(String primaryPolarizationFileName,
                                          String orthogonalPolarizationFileName)
Initializes a new instance. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
protected boolean | 
checkForSameDefinition(AnsysHfssCrossSectionScatteringCoefficient other)
Checks to determine if another instance has the same definition as this instance and
    returns  
true if it does. | 
protected boolean | 
checkForSameDefinition(SphericalTabularMonostaticCrossSectionScatteringCoefficient 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. 
 | 
protected ComplexCrossSectionScatteringCoefficient | 
computeScatteringCoefficient(UnitCartesian monoStaticDirection)
Computes the scattering coefficient in the supplied monostatic direction. 
 | 
static SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable | 
readData(BufferedReader primaryPolarizationSource)
A static class method for reading in the Ansys HFSS output data (*.csv) for the primary polarization and producing a  
SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable. | 
static SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable | 
readData(BufferedReader primaryPolarizationSource,
        BufferedReader orthogonalPolarizationSource)
A static class method for reading in the Ansys HFSS output data (*.csv) for the primary and orthogonal polarizations and producing a  
SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable. | 
static SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable | 
readData(String primaryPolarizationFileName)
A static class method for reading in the Ansys HFSS output data (*.csv) for the primary polarization and producing a  
SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable. | 
static SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable | 
readData(String primaryPolarizationFileName,
        String orthogonalPolarizationFileName)
A static class method for reading in the Ansys HFSS output data (*.csv) for the primary and orthogonal polarizations and producing a  
SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable. | 
applyScatteringCoefficient, applyScatteringCoefficient, checkForSameDefinition, computeScatteringCoefficient, enumerateDependencies, get, getClockAngles, getConeAngles, getIsSymmetricalcheckForSameDefinition, toScatteringCoefficientareSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozenpublic AnsysHfssCrossSectionScatteringCoefficient(@Nonnull String primaryPolarizationFileName)
primaryPolarizationFileName - The fully qualified path to a desired Ansys HFSS output file (*.csv) which represents the complex scattering data for the primary polarization.public AnsysHfssCrossSectionScatteringCoefficient(@Nonnull BufferedReader primaryPolarizationSource)
primaryPolarizationSource - A BufferedReader used to read in the Ansys HFSS output data (*.csv) which represents the complex scattering data for the primary polarization.public AnsysHfssCrossSectionScatteringCoefficient(@Nonnull String primaryPolarizationFileName, String orthogonalPolarizationFileName)
primaryPolarizationFileName - The fully qualified path to a desired Ansys HFSS output file (*.csv) which represents the complex scattering data for the primary polarization.orthogonalPolarizationFileName - The fully qualified path to a desired Ansys HFSS output file (*.csv) which represents the complex scattering data for the orthogonal polarization.public AnsysHfssCrossSectionScatteringCoefficient(@Nonnull BufferedReader primaryPolarizationSource, BufferedReader orthogonalPolarizationSource)
primaryPolarizationSource - A BufferedReader used to read in the Ansys HFSS output data (*.csv) which represents the complex scattering data for the primary polarization.orthogonalPolarizationSource - A BufferedReader used to read in the Ansys HFSS output data (*.csv) which represents the complex scattering data for the orthogonal polarization.protected AnsysHfssCrossSectionScatteringCoefficient(@Nonnull SphericalTabularMonostaticCrossSectionScatteringCoefficient 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 SphericalTabularMonostaticCrossSectionScatteringCoefficientcontext - The context to use to perform the copy.protected final boolean checkForSameDefinition(SphericalTabularMonostaticCrossSectionScatteringCoefficient 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 SphericalTabularMonostaticCrossSectionScatteringCoefficientother - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected boolean checkForSameDefinition(AnsysHfssCrossSectionScatteringCoefficient 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()
AnsysHfssCrossSectionScatteringCoefficient.checkForSameDefinition(agi.foundation.communications.SphericalTabularMonostaticCrossSectionScatteringCoefficient) method.computeCurrentDefinitionHashCode in class SphericalTabularMonostaticCrossSectionScatteringCoefficient@Nonnull public static SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable readData(@Nonnull String primaryPolarizationFileName)
SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable.primaryPolarizationFileName - The fully qualified path to a desired Ansys HFSS output file (*.csv) which represents the complex scattering data for the primary polarization.SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable object.ArgumentNullException - Thrown if primaryPolarizationFileName is null.InvalidDataException - Thrown in the following cases:
@Nonnull public static SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable readData(@Nonnull String primaryPolarizationFileName, String orthogonalPolarizationFileName)
SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable.primaryPolarizationFileName - The fully qualified path to a desired Ansys HFSS output file (*.csv) which represents the complex scattering data for the primary polarization.orthogonalPolarizationFileName - The fully qualified path to a desired Ansys HFSS output file (*.csv) which represents the complex scattering data for the orthogonal polarization.SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable object.ArgumentNullException - Thrown if primaryPolarizationFileName is null.InvalidDataException - Thrown in the following cases:
@Nonnull public static SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable readData(@Nonnull BufferedReader primaryPolarizationSource)
SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable.primaryPolarizationSource - A BufferedReader used to read in the Ansys HFSS output data (*.csv) which represents the complex scattering data for the primary polarization.SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable object.ArgumentNullException - Thrown if primaryPolarizationSource is null.InvalidDataException - Thrown in the following cases:
@Nonnull public static SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable readData(@Nonnull BufferedReader primaryPolarizationSource, BufferedReader orthogonalPolarizationSource)
SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable.primaryPolarizationSource - A BufferedReader used to read in the Ansys HFSS output data (*.csv) which represents the complex scattering data for the primary polarization.orthogonalPolarizationSource - A BufferedReader used to read in the Ansys HFSS output data (*.csv) which represents the complex scattering data for the orthogonal polarization.SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable object.ArgumentNullException - Thrown if primaryPolarizationSource is null.InvalidDataException - Thrown in the following cases:
protected ComplexCrossSectionScatteringCoefficient computeScatteringCoefficient(@Nonnull UnitCartesian monoStaticDirection)
computeScatteringCoefficient in class SphericalTabularMonostaticCrossSectionScatteringCoefficientmonoStaticDirection - The monostatic direction used to compute the scattering coefficient.