lsst.geom.geometry.SphericalCircle Class Reference

Inheritance diagram for lsst.geom.geometry.SphericalCircle:

Public Member Functions
def	__init__ (self, center, radius)
def	getBoundingBox (self)
def	getBoundingCircle (self)
def	getCenter (self)
def	getRadius (self)
def	isEmpty (self)
def	isFull (self)
def	contains (self, pointOrRegion)
def	intersects (self, pointOrRegion)
def	__repr__ (self)
def	__eq__ (self, other)
def	__hash__ (self)

Public Attributes
	center
	radius
	boundingBox

Detailed Description

A circle on the unit sphere. Points falling exactly on the
circle are considered to be inside (contained by) the circle.

Definition at line 794 of file geometry.py.

Constructor & Destructor Documentation

__init__()

def lsst.geom.geometry.SphericalCircle.__init__	(		self,
			center,
			radius
	)

Creates a new spherical circle with the given center and radius.

Definition at line 799 of file geometry.py.

    def __init__(self, center, radius):
        """Creates a new spherical circle with the given center and radius.
        """
        self.center = sphericalCoords(center)
        self.radius = float(radius)
        self.boundingBox = None
        if self.radius < 0.0 or self.radius > 180.0:
            raise RuntimeError(
                'Circle radius is negative or greater than 180 deg')
        self.center = (reduceTheta(self.center[0]), self.center[1])

Member Function Documentation

__eq__()

def lsst.geom.geometry.SphericalCircle.__eq__	(		self,
			other
	)

Definition at line 948 of file geometry.py.

    def __eq__(self, other):
        if isinstance(other, SphericalCircle):
            if self.isEmpty() and other.isEmpty():
                return True
            if self.radius == other.radius:
                if self.center[1] == other.center[1]:
                    if abs(self.center[1]) == 90.0:
                        return True
                    return self.center[0] == other.center[0]
        return False

__hash__()

def lsst.geom.geometry.SphericalCircle.__hash__

(

self

)

Definition at line 959 of file geometry.py.

    def __hash__(self):
        return hash((self.center, self.radius))

__repr__()

def lsst.geom.geometry.SphericalCircle.__repr__

(

self

)

Returns a string representation of this circle.

Definition at line 942 of file geometry.py.

    def __repr__(self):
        """Returns a string representation of this circle.
        """
        return ''.join([self.__class__.__name__, '(', repr(self.center),
                        ', ', repr(self.radius), ')'])

contains()

def lsst.geom.geometry.SphericalCircle.contains	(		self,
			pointOrRegion
	)

Returns True if the specified point or spherical region is
completely contained in this circle. Note that the implementation
is conservative where ellipses are concerned: False may be returned
for an ellipse that is actually completely contained in this circle.

Definition at line 858 of file geometry.py.

    def contains(self, pointOrRegion):
        """Returns True if the specified point or spherical region is
        completely contained in this circle. Note that the implementation
        is conservative where ellipses are concerned: False may be returned
        for an ellipse that is actually completely contained in this circle.
        """
        if self.isEmpty():
            return False
        pr = pointOrRegion
        c = self.center
        r = self.radius
        if isinstance(pr, SphericalBox):
            if pr.isEmpty():
                return False
            minp = pr.getMin()
            maxp = pr.getMax()
            if (sphericalAngularSep(c, minp) > r or
                sphericalAngularSep(c, maxp) > r or
                sphericalAngularSep(c, (minp[0], maxp[1])) > r or
                    sphericalAngularSep(c, (maxp[0], minp[1])) > r):
                return False
            a = alpha(r, c[1], minp[1])
            if a is not None:
                if (pr.containsPoint((c[0] + a, minp[1])) or
                        pr.containsPoint((c[0] - a, minp[1]))):
                    return False
            a = alpha(r, c[1], maxp[1])
            if a is not None:
                if (pr.containsPoint((c[0] + a, maxp[1])) or
                        pr.containsPoint((c[0] - a, maxp[1]))):
                    return False
            return True
        elif isinstance(pr, SphericalCircle):
            if pr.isEmpty():
                return False
            return sphericalAngularSep(c, pr.center) <= r - pr.radius
        elif isinstance(pr, SphericalEllipse):
            bc = pr.getBoundingCircle()
            return sphericalAngularSep(c, bc.center) <= r - bc.radius
        elif isinstance(pr, SphericalConvexPolygon):
            p = cartesianUnitVector(c)
            for v in pr.getVertices():
                if cartesianAngularSep(p, v) > r:
                    return False
            return True
        else:
            return sphericalAngularSep(c, sphericalCoords(pr)) <= r

getBoundingBox()

def lsst.geom.geometry.SphericalCircle.getBoundingBox

(

self

)

Returns a bounding box for this spherical circle.

Definition at line 810 of file geometry.py.

    def getBoundingBox(self):
        """Returns a bounding box for this spherical circle.
        """
        if self.boundingBox is None:
            if self.isEmpty():
                self.boundingBox = SphericalBox()
            elif self.isFull():
                self.boundingBox = SphericalBox()
                self.boundingBox.setFull()
            else:
                alpha = maxAlpha(self.radius, self.center[1])
                minPhi = clampPhi(self.center[1] - self.radius)
                maxPhi = clampPhi(self.center[1] + self.radius)
                if alpha > 180.0 - ANGLE_EPSILON:
                    minTheta = 0.0
                    maxTheta = 360.0
                else:
                    minTheta = self.center[0] - alpha
                    maxTheta = self.center[0] + alpha
                self.boundingBox = SphericalBox((minTheta, minPhi),
                                                (maxTheta, maxPhi))
        return self.boundingBox

getBoundingCircle()

def lsst.geom.geometry.SphericalCircle.getBoundingCircle

(

self

)

Definition at line 833 of file geometry.py.

    def getBoundingCircle(self):
        return self

getCenter()

def lsst.geom.geometry.SphericalCircle.getCenter

(

self

)

Returns an (ra, dec) 2-tuple of floats corresponding to the
center of this circle.

Definition at line 836 of file geometry.py.

    def getCenter(self):
        """Returns an (ra, dec) 2-tuple of floats corresponding to the
        center of this circle.
        """
        return self.center

getRadius()

def lsst.geom.geometry.SphericalCircle.getRadius

(

self

)

Returns the radius (degrees) of this circle.

Definition at line 842 of file geometry.py.

    def getRadius(self):
        """Returns the radius (degrees) of this circle.
        """
        return self.radius

intersects()

def lsst.geom.geometry.SphericalCircle.intersects	(		self,
			pointOrRegion
	)

Returns True if the given point or spherical region intersects
this circle. Note that the implementation is conservative where
ellipses are concerned: True may be returned for an ellipse that
is actually disjoint from this circle.

Definition at line 906 of file geometry.py.

    def intersects(self, pointOrRegion):
        """Returns True if the given point or spherical region intersects
        this circle. Note that the implementation is conservative where
        ellipses are concerned: True may be returned for an ellipse that
        is actually disjoint from this circle.
        """
        if self.isEmpty():
            return False
        pr = pointOrRegion
        c = self.center
        r = self.radius
        if isinstance(pr, SphericalBox):
            if pr.isEmpty():
                return False
            elif pr.containsPoint(c):
                return True
            minp = pr.getMin()
            maxp = pr.getMax()
            if (minPhiEdgeSep(c, minp[1], minp[0], maxp[0]) <= r or
                    minPhiEdgeSep(c, maxp[1], minp[0], maxp[0]) <= r):
                return True
            p = cartesianUnitVector(c)
            return (minThetaEdgeSep(p, minp[0], minp[1], maxp[1]) <= r or
                    minThetaEdgeSep(p, maxp[0], minp[1], maxp[1]) <= r)
        elif isinstance(pr, SphericalCircle):
            if pr.isEmpty():
                return False
            return sphericalAngularSep(c, pr.center) <= r + pr.radius
        elif isinstance(pr, SphericalEllipse):
            bc = pr.getBoundingCircle()
            return sphericalAngularSep(c, bc.center) <= r + bc.radius
        elif isinstance(pr, SphericalConvexPolygon):
            return pr.intersects(self)
        else:
            return sphericalAngularSep(c, sphericalCoords(pr)) <= r

isEmpty()

def lsst.geom.geometry.SphericalCircle.isEmpty

(

self

)

Returns True if this circle contains no points.

Definition at line 847 of file geometry.py.

    def isEmpty(self):
        """Returns True if this circle contains no points.
        """
        return self.radius < 0.0

isFull()

def lsst.geom.geometry.SphericalCircle.isFull

(

self

)

Returns True if this spherical box contains every point
on the unit sphere.

Definition at line 852 of file geometry.py.

    def isFull(self):
        """Returns True if this spherical box contains every point
        on the unit sphere.
        """
        return self.radius >= 180.0

Member Data Documentation

boundingBox

lsst.geom.geometry.SphericalCircle.boundingBox

Definition at line 804 of file geometry.py.

center

lsst.geom.geometry.SphericalCircle.center

Definition at line 802 of file geometry.py.

radius

lsst.geom.geometry.SphericalCircle.radius

Definition at line 803 of file geometry.py.

---

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

• /home/jenkins-slave/snowflake/release/lsstsw/stack/Linux64/geom/15.0+10/python/lsst/geom/geometry.py