lsst.skymap ga8c6da7877+acd47f83f4
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Attributes | List of all members
lsst.skymap.detail.dodecahedron.Dodecahedron Class Reference

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.

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.

◆ 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.

◆ 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.

◆ 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.

◆ getWithFacesOnPoles()

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

Definition at line 112 of file dodecahedron.py.

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: