lsst::ap::CircularRegion Class Reference

A circular region of the unit sphere (sky). More...

#include <CircularRegion.h>

Public Member Functions
	CircularRegion ()
	CircularRegion (double const ra, double const dec, double const radius)
double	getCenterRa () const
	Returns the right ascension of the circle center. More...
double	getCenterDec () const
	Returns the declination of the circle center. More...
double	getRadius () const
	Returns the radius of the circle. More...
double	getMinDec () const
	Returns the minimum declination of points in the region. More...
double	getMaxDec () const
	Returns the maximum declination of points in the region. More...

Private Attributes
double	_centerRa
double	_centerDec
double	_radius

Detailed Description

A circular region of the unit sphere (sky).

Definition at line 44 of file CircularRegion.h.

Constructor & Destructor Documentation

lsst::ap::CircularRegion::CircularRegion ( )

inline

Definition at line 48 of file CircularRegion.h.

: _centerRa(0.0), _centerDec(0.0), _radius(0.0) {}

lsst::ap::CircularRegion::CircularRegion	(	double const	ra,
		double const	dec,
		double const	radius
	)

Definition at line 40 of file CircularRegion.cc.

  :
    _centerRa(ra),
    _centerDec(dec),
    _radius(radius)
{
    if (ra < 0.0 || ra >= 360.0) {
        throw LSST_EXCEPT(ex::RangeError,
                          "right ascension must be in range [0, 360) degrees");
    }
    if (dec < -90.0 || dec > 90.0) {
        throw LSST_EXCEPT(ex::RangeError,
                          "declination must be in range  [-90, 90] degrees");
    }
    if (radius < 0.0 || radius > 90.0) {
        throw LSST_EXCEPT(ex::RangeError,
                          "circle radius must be in range  [0, 90] degrees");
    }
}

Member Function Documentation

double lsst::ap::CircularRegion::getCenterDec ( ) const

inline

Returns the declination of the circle center.

Definition at line 62 of file CircularRegion.h.

                                {
        return _centerDec;
    }

double lsst::ap::CircularRegion::getCenterRa ( ) const

inline

Returns the right ascension of the circle center.

Definition at line 57 of file CircularRegion.h.

                               {
        return _centerRa;
    }

double lsst::ap::CircularRegion::getMaxDec ( ) const

inline

Returns the maximum declination of points in the region.

Definition at line 78 of file CircularRegion.h.

                             {
        double d = _centerDec + _radius;
        return (d >= 90.0 ? 90.0 : d);
    }

double lsst::ap::CircularRegion::getMinDec ( ) const

inline

Returns the minimum declination of points in the region.

Definition at line 72 of file CircularRegion.h.

                             {
        double d = _centerDec - _radius;
        return (d <= -90.0 ? -90.0 : d);
    }

double lsst::ap::CircularRegion::getRadius ( ) const

inline

Returns the radius of the circle.

Definition at line 67 of file CircularRegion.h.

                             {
        return _radius;
    }

Member Data Documentation

double lsst::ap::CircularRegion::_centerDec

private

Definition at line 86 of file CircularRegion.h.

double lsst::ap::CircularRegion::_centerRa

private

Definition at line 85 of file CircularRegion.h.

double lsst::ap::CircularRegion::_radius

private

Definition at line 87 of file CircularRegion.h.

---

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

• /lsst/home/lsstsw/stack/Linux64/ap/master-g60f1e072bb+1/include/lsst/ap/CircularRegion.h
• /lsst/home/lsstsw/stack/Linux64/ap/master-g60f1e072bb+1/src/CircularRegion.cc