Package empro :: Package toolkit :: Package results :: Module far_field :: Class FarField
[frames] | no frames]

Class FarField

source code

excitation_based.ExcitationBased --+
                                   |
                                  FarField

Instance Methods
 
__init__(self, results, sensorName, **kwargs) source code
plots the farfield pattern based on the specified query
plot() source code
 
__add__(self, other) source code
 
__radd__(self, other) source code
 
__mul__(self, coef) source code
 
__rmul__(self, coef) source code
farField
translate(translation)
Returns: the translated farfield
source code
farField
rotate(angle, axis)
Returns: the rotated farField
source code
returns the Ephi and Etheta values at the given frequency
EphiTheta(frequency)
Returns: list of [Etheta, Ephi]
source code
 
angles1(self)
angles1 -> returns the values of angle1(theta) in radian
source code
 
angles2(self)
angles2 -> returns the values of angle2(phi) in radian
source code
double
radiatedPower(frequency= None)
Returns: radiated power at the given frequency (in case of frequency = None, a list of all values for all frequencies is returned)
source code
double
netAvailablePower(frequency= None)
Returns: net available power at the given frequency (in case of frequency = None, a list of all values for all frequencies is returned)
source code
double
netInputPower(frequency= None)
Returns: net input power at the given frequency (in case of frequency = None, a list of all values for all frequencies is returned)
source code
double
maxETotal(frequency= None)
Returns: max of Etotal at the given frequency (in case of frequency = None, a list of all values for all frequencies is returned)
source code
double
maxEtheta(frequency= None)
Returns: max of Etheta at the given frequency (in case of frequency = None, a list of all values for all frequencies is returned)
source code
double
maxEphi(frequency= None)
Returns: max of Ephi at the given frequency (in case of frequency = None, a list of all values for all frequencies is returned)
source code
double
maxEhorizontal(frequency= None)
Returns: max of Ehorizontal at the given frequency (in case of frequency = None, a list of all values for all frequencies is returned)
source code
double
maxEvertical(frequency= None)
Returns: max of Ehorizontal at the given frequency (in case of frequency = None, a list of all values for all frequencies is returned)
source code
a pair of floats
mainLobeDirection(frequency= None)
Returns: the direction of the main lobe in radian([theta, phi]) at the given frequency (in case of frequency = None, a list of all values for all frequencies is returned)
source code
double
systemEfficiency(frequency= None)
Returns: system efficiency at the given frequency (in case of frequency = None, a list of all values for all frequencies is returned)
source code
double
radiationEfficiency(frequency= None)
Returns: radiation efficiency at the given frequency (in case of frequency = None, a list of all values for all frequencies is returned)
source code

Inherited from excitation_based.ExcitationBased: __sub__, weights

Method Details

__init__(self, results, sensorName, **kwargs)
(Constructor)

source code 
Overrides: excitation_based.ExcitationBased.__init__

__add__(self, other)
(Addition operator)

source code 
Overrides: excitation_based.ExcitationBased.__add__

__radd__(self, other)
(Right-side addition operator)

source code 
Overrides: excitation_based.ExcitationBased.__radd__

__mul__(self, coef)

source code 
Overrides: excitation_based.ExcitationBased.__mul__

__rmul__(self, coef)

source code 
Overrides: excitation_based.ExcitationBased.__rmul__

translate(translation)

source code 
Parameters:
  • translation (Vector3d) - the translation vector of the farfield
Returns: farField
the translated farfield

rotate(angle, axis)

source code 
Parameters:
  • angle (float) - rotation angle
  • axis (Vector3D) - rotation axis
Returns: farField
the rotated farField

EphiTheta(frequency)

source code 
Parameters:
  • frequency (double) - the frequency of interest
Returns: returns the Ephi and Etheta values at the given frequency
list of [Etheta, Ephi]

radiatedPower(frequency= None)

source code 
Parameters:
  • frequency (float) - frequency of interest --- The default is None which considers all the frequencies
Returns: double
radiated power at the given frequency (in case of frequency = None, a list of all values for all frequencies is returned)

netAvailablePower(frequency= None)

source code 
Parameters:
  • frequency (float) - frequency of interest --- The default is None which considers all the frequencies
Returns: double
net available power at the given frequency (in case of frequency = None, a list of all values for all frequencies is returned)

netInputPower(frequency= None)

source code 
Parameters:
  • frequency (float) - frequency of interest --- The default is None which considers all the frequencies
Returns: double
net input power at the given frequency (in case of frequency = None, a list of all values for all frequencies is returned)

maxETotal(frequency= None)

source code 
Parameters:
  • frequency (float) - frequency of interest --- The default is None which considers all the frequencies
Returns: double
max of Etotal at the given frequency (in case of frequency = None, a list of all values for all frequencies is returned)

maxEtheta(frequency= None)

source code 
Parameters:
  • frequency (float) - frequency of interest --- The default is None which considers all the frequencies
Returns: double
max of Etheta at the given frequency (in case of frequency = None, a list of all values for all frequencies is returned)

maxEphi(frequency= None)

source code 
Parameters:
  • frequency (float) - frequency of interest --- The default is None which considers all the frequencies
Returns: double
max of Ephi at the given frequency (in case of frequency = None, a list of all values for all frequencies is returned)

maxEhorizontal(frequency= None)

source code 
Parameters:
  • frequency (float) - frequency of interest --- The default is None which considers all the frequencies
Returns: double
max of Ehorizontal at the given frequency (in case of frequency = None, a list of all values for all frequencies is returned)

maxEvertical(frequency= None)

source code 
Parameters:
  • frequency (float) - frequency of interest --- The default is None which considers all the frequencies
Returns: double
max of Ehorizontal at the given frequency (in case of frequency = None, a list of all values for all frequencies is returned)

mainLobeDirection(frequency= None)

source code 
Parameters:
  • frequency (float) - frequency of interest --- The default is None which considers all the frequencies
Returns: a pair of floats
the direction of the main lobe in radian([theta, phi]) at the given frequency (in case of frequency = None, a list of all values for all frequencies is returned)

systemEfficiency(frequency= None)

source code 
Parameters:
  • frequency (float) - frequency of interest --- The default is None which considers all the frequencies
Returns: double
system efficiency at the given frequency (in case of frequency = None, a list of all values for all frequencies is returned)

radiationEfficiency(frequency= None)

source code 
Parameters:
  • frequency (float) - frequency of interest --- The default is None which considers all the frequencies
Returns: double
radiation efficiency at the given frequency (in case of frequency = None, a list of all values for all frequencies is returned)