lsst.geom  14.0-1-g7257b6a+8
Public Member Functions | Public Attributes | List of all members
lsst.geom.geometry.SphericalEllipse Class Reference
Inheritance diagram for lsst.geom.geometry.SphericalEllipse:
lsst.geom.geometry.SphericalRegion

Public Member Functions

def __init__ (self, center, semiMajorAxisLength, semiMinorAxisLength, majorAxisAngle)
 
def getBoundingBox (self)
 
def getBoundingCircle (self)
 
def getInnerCircle (self)
 
def getCenter (self)
 
def getMajorAxisAngle (self)
 
def getSemiMajorAxisLength (self)
 
def getSemiMinorAxisLength (self)
 
def contains (self, pointOrRegion)
 
def intersects (self, pointOrRegion)
 
def __repr__ (self)
 
def __eq__ (self, other)
 
def __hash__ (self)
 

Public Attributes

 center
 
 semiMajorAxisLength
 
 semiMinorAxisLength
 
 majorAxisAngle
 
 boundingCircle
 
 innerCircle
 

Detailed Description

An ellipse on the unit sphere. This is a standard 2D cartesian
ellipse defined on the plane tangent to the unit sphere at the ellipse
center and then orthographically projected onto the surface of the
unit sphere.

Member Function Documentation

◆ __repr__()

def lsst.geom.geometry.SphericalEllipse.__repr__ (   self)
Returns a string representation of this ellipse.

◆ contains()

def lsst.geom.geometry.SphericalEllipse.contains (   self,
  pointOrRegion 
)
Returns True if the specified point or spherical region is
completely contained in this ellipse. The implementation is
conservative in the sense that False may be returned for a region
that really is contained by this ellipse.

◆ getBoundingBox()

def lsst.geom.geometry.SphericalEllipse.getBoundingBox (   self)
Returns a bounding box for this spherical ellipse. Note that at
present this is conservative: a bounding box for the circle C with
radius equal to the semi-major axis length of this ellipse is returned.

◆ getBoundingCircle()

def lsst.geom.geometry.SphericalEllipse.getBoundingCircle (   self)
Returns a bounding circle for this spherical ellipse. This is
a circle with the same center as this ellipse and with radius
equal to the arcsine of the semi-major axis length.

◆ getCenter()

def lsst.geom.geometry.SphericalEllipse.getCenter (   self)
Returns an (ra, dec) 2-tuple of floats corresponding to the center
of this ellipse.

◆ getInnerCircle()

def lsst.geom.geometry.SphericalEllipse.getInnerCircle (   self)
Returns the circle of maximum radius having the same center as
this ellipse and which is completely contained in the ellipse.

◆ getMajorAxisAngle()

def lsst.geom.geometry.SphericalEllipse.getMajorAxisAngle (   self)
Return the major axis angle (east of north, in degrees) for this
ellipse.

◆ getSemiMajorAxisLength()

def lsst.geom.geometry.SphericalEllipse.getSemiMajorAxisLength (   self)
Returns the semi-major axis length of this ellipse. Units
are in arcsec since ellipses are typically small.

◆ getSemiMinorAxisLength()

def lsst.geom.geometry.SphericalEllipse.getSemiMinorAxisLength (   self)
Returns the semi-minor axis length of this ellipse. Units
are in arcsec since ellipses are typically small.

◆ intersects()

def lsst.geom.geometry.SphericalEllipse.intersects (   self,
  pointOrRegion 
)
Returns True if the specified point or spherical region intersects
this ellipse. The implementation is conservative in the sense that
True may be returned for a region that does not intersect this
ellipse.

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