i3assist.GridSearch

class i3assist.GridSearch(theta_max=0.0, theta_step=0.0, psi_max=0.0, psi_step=0.0, do_180=False)[source]

Describes the local grid search implemented in new I3.

See the explanation in MRASRCH and the I3 subvolume tutorial for more information on how the grid search is implemented. But overall the grid is defined by four parameters: Nutation (theta) maximum and step and Spin (psi) maximum and step. Finally there is a do_180 parameter to support the old I3 eulerFG scripts, but this is not available in new I3.

Parameters:
  • theta_max (float, optional) – Maximum half-angle of a cone of nutation about the north pole of the unit sphere.
  • theta_step (float, optional) – Angular increment of nutation.
  • psi_max (float, optional) – Maximum absolute angle of spin about the orientation axis of the particle. Searched in both directions.
  • psi_step (float, optional) – Angular increment of spin.
  • do_180 (boolean, optional) – If True the spins opposite of the current orientation’s facing will also be searched.
__init__(theta_max=0.0, theta_step=0.0, psi_max=0.0, psi_step=0.0, do_180=False)[source]

Methods

__init__([theta_max, theta_step, psi_max, ...])

Attributes

do_180 boolean Whether to search spins opposite particle facing.
psi_max float Max absolute angle of spin about the particle z-axis.
psi_step float Angular increment of spin.
rotations list of i3assist.Euler Rotations searched in i3.
theta_max float Max half-angle of nutation about the north pole.
theta_step float Angular increment of nutation.