Click or drag to resize

AnsysHfssCrossSectionScatteringCoefficient Class

A 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.
Inheritance Hierarchy

Namespace:  AGI.Foundation.Communications
Assembly:  AGI.Foundation.Communications (in AGI.Foundation.Communications.dll) Version: 22.2.414.0 (22.2.414.0)
Syntax
public class AnsysHfssCrossSectionScatteringCoefficient : SphericalTabularMonostaticCrossSectionScatteringCoefficient

The AnsysHfssCrossSectionScatteringCoefficient type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyClockAngles
Gets the clock angles.
(Inherited from SphericalTabularMonostaticCrossSectionScatteringCoefficient.)
Public propertyConeAngles
Gets the cone angles.
(Inherited from SphericalTabularMonostaticCrossSectionScatteringCoefficient.)
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 propertyIsSymmetrical
Gets a value indicating whether or not the pattern is symmetrical.
(Inherited from SphericalTabularMonostaticCrossSectionScatteringCoefficient.)
Public propertyItem
Gets the cross section value, in meters squared, at the given clock and cone angle indices.
(Inherited from SphericalTabularMonostaticCrossSectionScatteringCoefficient.)
Top
Methods
  NameDescription
Public methodApplyScatteringCoefficient(UnitCartesian, UnitCartesian, UnitQuaternion, Signal)
Applies the scattering coefficient to the input signal.
(Inherited from SphericalTabularMonostaticCrossSectionScatteringCoefficient.)
Public methodApplyScatteringCoefficient(UnitCartesian, UnitCartesian, UnitQuaternion, Signal, Signal)
Applies the scattering coefficient to the input signals.
(Inherited from SphericalTabularMonostaticCrossSectionScatteringCoefficient.)
Protected methodCheckForSameDefinition(AnsysHfssCrossSectionScatteringCoefficient)
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(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 ScatteringCoefficient.)
Protected methodCheckForSameDefinition(ScatteringCoefficient)
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 SphericalTabularMonostaticCrossSectionScatteringCoefficient.)
Protected methodCheckForSameDefinition(SphericalTabularMonostaticCrossSectionScatteringCoefficient)
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 SphericalTabularMonostaticCrossSectionScatteringCoefficientCheckForSameDefinition(SphericalTabularMonostaticCrossSectionScatteringCoefficient).)
Public methodClone
Clones this object using the specified context.
(Overrides SphericalTabularMonostaticCrossSectionScatteringCoefficientClone(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 SphericalTabularMonostaticCrossSectionScatteringCoefficientComputeCurrentDefinitionHashCode.)
Protected methodComputeScatteringCoefficient(Spherical)
Computes the scattering coefficient in the supplied monostatic direction.
(Inherited from SphericalTabularMonostaticCrossSectionScatteringCoefficient.)
Protected methodComputeScatteringCoefficient(UnitCartesian)
Computes the scattering coefficient in the supplied monostatic direction.
(Overrides SphericalTabularMonostaticCrossSectionScatteringCoefficientComputeScatteringCoefficient(UnitCartesian).)
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 SphericalTabularMonostaticCrossSectionScatteringCoefficient.)
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 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.)
Public methodStatic memberReadData(String)
A static class method for reading in the Ansys HFSS output data (*.csv) for the primary polarization and producing a SphericalTabularMonostaticCrossSectionScatteringCoefficientCrossSectionScatteringMatrixSphericalTable.
Public methodStatic memberReadData(TextReader)
A static class method for reading in the Ansys HFSS output data (*.csv) for the primary polarization and producing a SphericalTabularMonostaticCrossSectionScatteringCoefficientCrossSectionScatteringMatrixSphericalTable.
Public methodStatic memberReadData(String, String)
A static class method for reading in the Ansys HFSS output data (*.csv) for the primary and orthogonal polarizations and producing a SphericalTabularMonostaticCrossSectionScatteringCoefficientCrossSectionScatteringMatrixSphericalTable.
Public methodStatic memberReadData(TextReader, TextReader)
A static class method for reading in the Ansys HFSS output data (*.csv) for the primary and orthogonal polarizations and producing a SphericalTabularMonostaticCrossSectionScatteringCoefficientCrossSectionScatteringMatrixSphericalTable.
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.)
Top
Remarks

If two files are imported to construct the full scattering matrix, the following conditions must be true:

  • The matrix size, Theta and Phi angle extents, and the step sizes must be the same for both files.
  • The frequency values listed in both files must be same.

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
See Also