Package generic_fns :: Package structure :: Module cones :: Class Square
[hide private]
[frames] | no frames]

Class Square

source code


The class for the square cone.

The cone is defined by:

              / phi_y,     if 0 <= theta < pi/2,
              |
   phi_max = <  phi_x,     if pi/2 <= theta < 3*pi/3,
              |
              \ phi_y,     if 3*pi/2 <= theta < 2*pi,

where phi_max is the maximum polar angle for the given azimuthal angle theta, phi_x is the maximum cone angle along the x-eigenvector, and phi_y is that of the y-eigenvector. The cone axis is assumed to be the z-axis. The maximum cone opening angle allowed is pi/2.

Instance Methods [hide private]
float
phi_max(self, theta)
Return the maximum polar angle phi for the given azimuthal angle theta.
source code
float
theta_max(self, phi, theta_min=0.0, theta_max=6.28318530718)
Return the maximum azimuthal angle theta for the given polar angle phi.
source code

Inherited from Base: __init__, limit_check

Method Details [hide private]

phi_max(self, theta)

source code 

Return the maximum polar angle phi for the given azimuthal angle theta.

Parameters:
  • theta (float) - The azimuthal angle.
Returns: float
The maximum polar angle phi for the value of theta.

theta_max(self, phi, theta_min=0.0, theta_max=6.28318530718)

source code 

Return the maximum azimuthal angle theta for the given polar angle phi.

Parameters:
  • phi (float) - The polar angle.
  • theta_min (float) - The lower limit of the azimuthal angle range for complex distributions.
  • theta_max (float) - The upper limit of the azimuthal angle range for complex distributions.
Returns: float
The maximum azimuthal angle theta for the value of phi.