lsst::ap::RectangularRegion Class Reference

A rectangular region (in right ascension and declination) of the unit sphere. More...

#include <RectangularRegion.h>

Public Member Functions
	RectangularRegion ()
	RectangularRegion (double const minRa, double const maxRa, double const minDec, double const maxDec)
	RectangularRegion (double const cenRa, double const cenDec, double const radius)
	RectangularRegion (CircularRegion const &region)
double	getMinRa () const
	Returns the minimum right ascension of points in the region. More...
double	getMaxRa () const
	Returns the maximum right ascension of points in the region. 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 Member Functions
void	fromCircle (double const centerRa, double const centerDec, double const radius)

Private Attributes
double	_minRa
double	_maxRa
double	_minDec
double	_maxDec

Detailed Description

A rectangular region (in right ascension and declination) of the unit sphere.

Definition at line 43 of file RectangularRegion.h.

Constructor & Destructor Documentation

lsst::ap::RectangularRegion::RectangularRegion ( )

inline

Definition at line 47 of file RectangularRegion.h.

: _minRa(0.0), _maxRa(0.0), _minDec(0.0), _maxDec(0.0) {}

lsst::ap::RectangularRegion::RectangularRegion	(	double const	minRa,
		double const	maxRa,
		double const	minDec,
		double const	maxDec
	)

Definition at line 42 of file RectangularRegion.cc.

  :
    _minRa(minRa),
    _maxRa(maxRa),
    _minDec(minDec),
    _maxDec(maxDec)
{
    if (minRa < 0.0 || minRa >= 360.0 || maxRa < 0.0 || maxRa >= 360.0) {
        throw LSST_EXCEPT(ex::RangeError,
                          "right ascension must be in range [0, 360) degrees");
    }
    if (minDec < -90.0 || minDec > 90.0 || maxDec < -90.0 || maxDec > 90.0) {
        throw LSST_EXCEPT(ex::RangeError,
                          "declination must be in range [-90, 90] degrees");
    }
    if (maxDec < minDec) {
        throw LSST_EXCEPT(ex::InvalidParameterError,
                          "minimum declination greater than maximum declination");
    }
}

lsst::ap::RectangularRegion::RectangularRegion	(	double const	cenRa,
		double const	cenDec,
		double const	radius
	)

Definition at line 68 of file RectangularRegion.cc.

  {
    fromCircle(centerRa, centerDec, radius);
}

lsst::ap::RectangularRegion::RectangularRegion ( CircularRegion const &  region )

explicit

Definition at line 77 of file RectangularRegion.cc.

                                                                        {
    fromCircle(region.getCenterRa(), region.getCenterDec(), region.getRadius());
}

Member Function Documentation

void lsst::ap::RectangularRegion::fromCircle ( double const  centerRa, double const  centerDec, double const  radius  )

private

Definition at line 82 of file RectangularRegion.cc.

  {
    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");
    }
    double alpha = maxAlpha(radius, dec);
    _minRa = ra - alpha;
    if (_minRa < 0.0) {
        _minRa += 360.0;
    }
    _maxRa = ra + alpha;
    if (_maxRa >= 360.0) {
        _maxRa -= 360.0;
    }
    _minDec = dec - radius;
    if (_minDec < -90.0) {
        _minDec = -90.0;
    }
    _maxDec = dec + radius;
    if (_maxDec > 90.0) {
        _maxDec = 90.0;
    }
}

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

inline

Returns the maximum declination of points in the region.

Definition at line 80 of file RectangularRegion.h.

                             {
        return _maxDec;
    }

double lsst::ap::RectangularRegion::getMaxRa ( ) const

inline

Returns the maximum right ascension of points in the region.

Definition at line 70 of file RectangularRegion.h.

                            {
        return _maxRa;
    }

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

inline

Returns the minimum declination of points in the region.

Definition at line 75 of file RectangularRegion.h.

                             {
        return _minDec;
    }

double lsst::ap::RectangularRegion::getMinRa ( ) const

inline

Returns the minimum right ascension of points in the region.

Definition at line 65 of file RectangularRegion.h.

                            {
        return _minRa;
    }

Member Data Documentation

double lsst::ap::RectangularRegion::_maxDec

private

Definition at line 89 of file RectangularRegion.h.

double lsst::ap::RectangularRegion::_maxRa

private

Definition at line 87 of file RectangularRegion.h.

double lsst::ap::RectangularRegion::_minDec

private

Definition at line 88 of file RectangularRegion.h.

double lsst::ap::RectangularRegion::_minRa

private

Definition at line 86 of file RectangularRegion.h.

---

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

• /home/lsstsw/stack/Linux64/ap/10.0+224/include/lsst/ap/RectangularRegion.h
• /home/lsstsw/stack/Linux64/ap/10.0+224/src/RectangularRegion.cc