Public Member Functions
	__init__ (self, withFacesOnPoles=False)

	getFaceCtrList (self)

	getFaceCtr (self, ind)

	getVertices (self, ind)

	getFaceInd (self, vec)

	getWithFacesOnPoles (self)

Public Attributes
	vertexVecList

	faceVecList

Protected Attributes
	_withFacesOnPoles

Detailed Description

A dodecahedron with  positions of faces and associated vertices.

Parameters
----------
withFacesOnPoles : `bool`
    If True center a face on each pole, else put a vertex on each pole.

Definition at line 9 of file dodecahedron.py.

Constructor & Destructor Documentation

◆ init()

lsst.skymap.detail.dodecahedron.Dodecahedron.__init__	(		self,
			withFacesOnPoles = False )

Definition at line 17 of file dodecahedron.py.

    def __init__(self, withFacesOnPoles=False):
        self._withFacesOnPoles = bool(withFacesOnPoles)
 
        # Basis cartesian vectors describing the faces of a dodecahedron;
        # the full set of vectors is obtained by choosing both signs of each
        # nonzero component of each vector.
        # The orientation of the resulting dodecahedron, while very convenient
        # for specifying face vectors, is not an orientation we want so it
        # must be rotated.
        g = (1.0 + math.sqrt(5.0)) / 2.0
        faceBases = (
            (0, 1, g),
            (1, g, 0),
            (g, 0, 1),
        )
        unrotFaceVecList = _computeFullVecList(faceBases)
        unrotVertexVecList = _computeDodecahedronVertices(unrotFaceVecList)
 
        if self._withFacesOnPoles:
            # one face is centered on each pole
            vec0, vec1 = _findClosePair(unrotFaceVecList, 0)
            rotMat = _computeCoordTransform(vec0, vec1)
        else:
            # one vertex is on each pole
            vec0, vec1 = _findClosePair(unrotVertexVecList, 0)
            rotMat = _computeCoordTransform(vec0, vec1, vec1NegativeX=True)
        self.vertexVecList = [numpy.dot(rotMat, unrotVertexVec) for unrotVertexVec in unrotVertexVecList]
        unsortedFaceList = [numpy.dot(rotMat, unrotFaceVec) for unrotFaceVec in unrotFaceVecList]
        self.faceVecList = _sortedVectorList(unsortedFaceList)
 

Member Function Documentation

◆ getFaceCtr()

lsst.skymap.detail.dodecahedron.Dodecahedron.getFaceCtr	(		self,
			ind )

Return the center of the specified face.

Parameters
----------
ind : `int`
    Index of the face to look up.

Returns
-------
results : `numpy.ndarray`
    Face center as a unit vector.

Definition at line 57 of file dodecahedron.py.

    def getFaceCtr(self, ind):
        """Return the center of the specified face.
 
        Parameters
        ----------
        ind : `int`
            Index of the face to look up.
 
        Returns
        -------
        results : `numpy.ndarray`
            Face center as a unit vector.
        """
        return self.faceVecList[ind][:]
 

◆ getFaceCtrList()

lsst.skymap.detail.dodecahedron.Dodecahedron.getFaceCtrList ( self )

Return a list of face centers.

Returns
-------
results : `list` of `numpy.ndarray`
    A list of face centers (in index order); each a unit vector.

Definition at line 47 of file dodecahedron.py.

    def getFaceCtrList(self):
        """Return a list of face centers.
 
        Returns
        -------
        results : `list` of `numpy.ndarray`
            A list of face centers (in index order); each a unit vector.
        """
        return self.faceVecList[:]
 

◆ getFaceInd()

lsst.skymap.detail.dodecahedron.Dodecahedron.getFaceInd	(		self,
			vec )

Return the index of the face containing the cartesian vector.

Parameters
----------
vec : `numpy.ndarray`
    Cartesian vector (length is ignored).

Returns
-------
results : `numpy.ndarray`
    Index of face containing vec.

Definition at line 97 of file dodecahedron.py.

    def getFaceInd(self, vec):
        """Return the index of the face containing the cartesian vector.
 
        Parameters
        ----------
        vec : `numpy.ndarray`
            Cartesian vector (length is ignored).
 
        Returns
        -------
        results : `numpy.ndarray`
            Index of face containing vec.
        """
        return numpy.argmax(numpy.dot(self.faceVecList, vec))
 

◆ getVertices()

lsst.skymap.detail.dodecahedron.Dodecahedron.getVertices	(		self,
			ind )

Return the vertices for a given face.

Parameters
----------
ind : `int`
    Face index.

Returns
-------
sortedVertexList : `list` of `numpy.ndarray`
    A list of vertices, each a unit vector.

Definition at line 72 of file dodecahedron.py.

    def getVertices(self, ind):
        """Return the vertices for a given face.
 
        Parameters
        ----------
        ind : `int`
            Face index.
 
        Returns
        -------
        sortedVertexList : `list` of `numpy.ndarray`
            A list of vertices, each a unit vector.
        """
        faceVec = self.getFaceCtr(ind)
        vertexList, indList = _findCloseList(self.vertexVecList, faceVec)
 
        # sort vertex list about face vector (direction is random)
        sortedVertexList = [vertexList[0]]
        vertexList = list(vertexList[1:])
        while len(vertexList) != 0:
            nearVertexList, nearInd = _findCloseList(vertexList, sortedVertexList[-1])
            sortedVertexList.append(nearVertexList[0])
            vertexList.pop(nearInd[0])
        return sortedVertexList
 

◆ getWithFacesOnPoles()

lsst.skymap.detail.dodecahedron.Dodecahedron.getWithFacesOnPoles ( self )

Definition at line 112 of file dodecahedron.py.

    def getWithFacesOnPoles(self):
        return self._withFacesOnPoles

Member Data Documentation

◆ _withFacesOnPoles

lsst.skymap.detail.dodecahedron.Dodecahedron._withFacesOnPoles

protected

Definition at line 18 of file dodecahedron.py.

◆ faceVecList

lsst.skymap.detail.dodecahedron.Dodecahedron.faceVecList

Definition at line 45 of file dodecahedron.py.

◆ vertexVecList

lsst.skymap.detail.dodecahedron.Dodecahedron.vertexVecList

Definition at line 43 of file dodecahedron.py.

The documentation for this class was generated from the following file:

/j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/skymap/ga8c6da7877+71e4819109/python/lsst/skymap/detail/dodecahedron.py

Public Member Functions

Public Attributes

Protected Attributes