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

Class Base

source code


A base class for all the cone objects.

Instance Methods [hide private]
 
__init__(self, phi_x, phi_y)
Set up the cone object.
source code
bool
limit_check(self, phi, theta)
Determine if the point is within the cone.
source code
Method Details [hide private]

__init__(self, phi_x, phi_y)
(Constructor)

source code 

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.

limit_check(self, phi, theta)

source code 

Determine if the point is within the cone.

Parameters:
  • phi (float) - The polar angle.
  • theta (float) - The azimuthal angle.
Returns: bool
True if the point is within the cone, False otherwise.