lalsimulation.nrfits.quaternion_utils Namespace Reference

Functions
def	multiply_quats (q1, q2)
	q1, q2 must be [scalar, x, y, z] but those may be arrays or scalars More...
def	quat_inv (q)
	Returns QBar such that Q*QBar = 1. More...
def	align_vec_quat (vec)
	Returns a unit quaternion that will align vec with the z-axis. More...
def	transform_time_dependent_vector (quat, vec, inverse=0)
	Given (for example) a minimal rotation frame quat, transforms vec from the minimal rotation frame to the inertial frame. More...
def	rotate_in_plane (chi, phase)
	Rotates a given vector, chi, by a clockwise angle, phase, about the z-axis. More...
def	transform_vector_coorb_to_inertial (vec_coorb, orbPhase, quat_copr)
	Given a vector (of size 3) in coorbital frame, orbital phase in coprecessing frame and a minimal rotation frame quat, transforms the vector from the coorbital to the LAL inertial frame. More...

Function Documentation

multiply_quats()

def lalsimulation.nrfits.quaternion_utils.multiply_quats	(		q1,
			q2
	)

q1, q2 must be [scalar, x, y, z] but those may be arrays or scalars

Definition at line 5 of file quaternion_utils.py.

quat_inv()

def lalsimulation.nrfits.quaternion_utils.quat_inv

(

q

)

Returns QBar such that Q*QBar = 1.

Definition at line 14 of file quaternion_utils.py.

align_vec_quat()

def lalsimulation.nrfits.quaternion_utils.align_vec_quat

(

vec

)

Returns a unit quaternion that will align vec with the z-axis.

Definition at line 22 of file quaternion_utils.py.

transform_time_dependent_vector()

def lalsimulation.nrfits.quaternion_utils.transform_time_dependent_vector	(		quat,
			vec,
			inverse = 0
	)

Given (for example) a minimal rotation frame quat, transforms vec from the minimal rotation frame to the inertial frame.

With inverse=1, transforms from the inertial frame to the minimal rotation frame.

Definition at line 38 of file quaternion_utils.py.

rotate_in_plane()

def lalsimulation.nrfits.quaternion_utils.rotate_in_plane	(		chi,
			phase
	)

Rotates a given vector, chi, by a clockwise angle, phase, about the z-axis.

Can be used for transforming spins from the coprecessing frame to the coorbital frame

Definition at line 51 of file quaternion_utils.py.

transform_vector_coorb_to_inertial()

def lalsimulation.nrfits.quaternion_utils.transform_vector_coorb_to_inertial	(		vec_coorb,
			orbPhase,
			quat_copr
	)

Given a vector (of size 3) in coorbital frame, orbital phase in coprecessing frame and a minimal rotation frame quat, transforms the vector from the coorbital to the LAL inertial frame.

Definition at line 65 of file quaternion_utils.py.