lsst.skymap.detail.dodecahedron Namespace Reference

Classes
class	Dodecahedron

Functions
	computeRotationMatrix (angle, axis)
	_computeCoordTransform (vec0, vec1, vec1NegativeX=False)
	_computeDodecahedronVertices (faceVecList)
	_computeFullVecList (basisSet)
	_findCloseIndexSet (vecList, ind)
	_findCloseList (vecList, vec)
	_findClosePair (vecList, ind=0)
	_sortedVectorList (vecList)

Variables
	precision
	suppress
	True
	linewidth
	vertexDodec = Dodecahedron(withFacesOnPoles=False)
	faceVec = vertexDodec.getFaceCtr(i)

Function Documentation

_computeCoordTransform()

lsst.skymap.detail.dodecahedron._computeCoordTransform ( vec0, vec1, vec1NegativeX = False )

protected

Compute a rotation matrix that puts vec0 along z and vec1 along +x in
the xz plane.

Parameters
----------
vec0 : `numpy.ndarray`
    vector 0
vec1 : `numpy.ndarray`
    vector 1
vec1NegativeX : `bool`
    If True then vec1 is rotated to face negative x.

Definition at line 138 of file dodecahedron.py.

_computeDodecahedronVertices()

lsst.skymap.detail.dodecahedron._computeDodecahedronVertices ( faceVecList )

protected

Given a vector of face positions of a Dodecahedron compute the vertices.

Definition at line 172 of file dodecahedron.py.

_computeFullVecList()

lsst.skymap.detail.dodecahedron._computeFullVecList ( basisSet )

protected

Given a collection of basis vectors, compute all permutations with both
signs of all nonzero values.

For example::

    [(0, 1, 2)] -> [(0, 1, 2), (0, -1, 2), (0, 1, -2), (0, -1, -2)]

Definition at line 201 of file dodecahedron.py.

_findCloseIndexSet()

lsst.skymap.detail.dodecahedron._findCloseIndexSet ( vecList, ind )

protected

Given a list of cartesian vectors, return a set of indices of those
closest to one of them.

This is intended for regular grids where distances are quantized.

Parameters
----------
vecList : `list`
    List of cartesian vectors.
ind : `int`
    Index of vector to be nearest.

Definition at line 226 of file dodecahedron.py.

_findCloseList()

lsst.skymap.detail.dodecahedron._findCloseList ( vecList, vec )

protected

Given a list of cartesian vectors, return all those closest to a
specified position

This is intended for regular grids where distances are quantized

Parameters
----------
vecList : `list`
    List of cartesian vectors.
vec : `iterable` of `float`
    Vector to be near.

Returns
-------
retList : `list`
    List of closest vectors.
indList : `list`
    List if indices of those vectors.

Definition at line 246 of file dodecahedron.py.

_findClosePair()

lsst.skymap.detail.dodecahedron._findClosePair ( vecList, ind = 0 )

protected

Given a list of cartesian vectors and an index, return the vector and
one of its closest neighbors.

Parameters
----------
vecList : `list` of `numpy.ndarray`
    List of cartesian vectors.
ind : `int`
    Index of first vector.

Definition at line 273 of file dodecahedron.py.

_sortedVectorList()

lsst.skymap.detail.dodecahedron._sortedVectorList ( vecList )

protected

Return a list of cartesian vectors sorted by decreasing latitude and
increasing longitude.

Definition at line 290 of file dodecahedron.py.

computeRotationMatrix()

lsst.skymap.detail.dodecahedron.computeRotationMatrix	(		angle,
			axis )

Return a 3D rotation matrix for rotation by a specified amount around a
specified axis.

Parameters
----------
angle : `float`
    Amount of rotation (rad).
axis : `int`
    Axis of rotation; one of 0, 1 or 2 for x, y or z.

Definition at line 116 of file dodecahedron.py.

Variable Documentation

faceVec

lsst.skymap.detail.dodecahedron.faceVec = vertexDodec.getFaceCtr(i)

Definition at line 311 of file dodecahedron.py.

linewidth

lsst.skymap.detail.dodecahedron.linewidth

Definition at line 306 of file dodecahedron.py.

precision

lsst.skymap.detail.dodecahedron.precision

Definition at line 306 of file dodecahedron.py.

suppress

lsst.skymap.detail.dodecahedron.suppress

Definition at line 306 of file dodecahedron.py.

True

lsst.skymap.detail.dodecahedron.True

Definition at line 306 of file dodecahedron.py.

vertexDodec

lsst.skymap.detail.dodecahedron.vertexDodec = Dodecahedron(withFacesOnPoles=False)

Definition at line 309 of file dodecahedron.py.