Class Cosine

The class for the cosine cone.

The ellipse is defined by:

   phi_max = cos(theta) * phi_x  +  sin(theta) * phi_y,

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

__init__(self, phi_x, phi_y)
Set up the cone object.

float phi_max(self, theta)
Return the maximum polar angle phi for the given azimuthal angle theta.

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.

Inherited from Base: limit_check

Method Details

__init__(self, phi_x, phi_y)
(Constructor)

Set up the cone object.

Parameters:

• phi_x (float) - The maximum cone angle along the x-eigenvector.
• phi_y (float) - The maximum cone angle along the y-eigenvector.

Overrides: Base.__init__

phi_max(self, theta)

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)

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.