Namespaces
	detail

	ellipses

	transformConfig

	xyTransformFactory

Classes
class	AffineTransform
	An affine coordinate transformation consisting of a linear transformation and an offset. More...

class	AngleUnit
	A class used to convert scalar POD types such as double to Angle. More...

class	Angle

class	Box2I
	An integer coordinate rectangle. More...

class	Box2D
	A floating-point coordinate rectangle geometry. More...

class	Point
	A coordinate class intended to represent absolute positions. More...

class	Extent
	A coordinate class intended to represent offsets and dimensions. More...

class	CoordinateBase
	A CRTP base class for coordinate objects. More...

class	CoordinateBase< Derived, T, 2 >
	Specialization of CoordinateBase for 2 dimensions. More...

class	CoordinateBase< Derived, T, 3 >
	Specialization of CoordinateBase for 3 dimensions. More...

class	CoordinateExpr
	A boolean coordinate. More...

class	ExtentBase

class	Extent< T, 2 >
	A coordinate class intended to represent offsets and dimensions (2-d specialization). More...

class	Extent< T, 3 >
	A coordinate class intended to represent offsets and dimensions (3-d specialization). More...

class	LinearTransform
	A 2D linear coordinate transformation. More...

class	PointBase

class	Point< T, 2 >
	A coordinate class intended to represent absolute positions (2-d specialization). More...

class	Point< T, 3 >
	A coordinate class intended to represent absolute positions (3-d specialization). More...

class	Polygon

class	Span
	A range of pixels within one row of an Image. More...

class	SpanPixelIterator
	An iterator that yields Point2I and increases in the x direction. More...

class	TransformMap

class	XYTransform
	Virtual base class for 2D transforms. More...

class	IdentityXYTransform
	A trivial XYTransform satisfying f(x)=x. More...

class	InvertedXYTransform
	Wrap an XYTransform, swapping forward and reverse transforms. More...

class	MultiXYTransform
	Wrap a sequence of multiple XYTransforms. More...

class	AffineXYTransform
	Wrap an AffineTransform. More...

class	RadialXYTransform
	A purely radial polynomial distortion, up to 6th order. More...

Typedefs
typedef Box2D	BoxD = Box2D

typedef Box2I	BoxI = Box2I

typedef CoordinateExpr< 2 >	CoordinateExpr2

typedef CoordinateExpr< 3 >	CoordinateExpr3

typedef Extent< int, 2 >	ExtentI = Extent2I

typedef Extent< int, 2 >	Extent2I

typedef Extent< int, 3 >	Extent3I

typedef Extent< double, 2 >	ExtentD = Extent2D

typedef Extent< double, 2 >	Extent2D

typedef Extent< double, 3 >	Extent3D

typedef Point< int, 2 >	PointI = Point2I

typedef Point< int, 2 >	Point2I

typedef Point< int, 3 >	Point3I

typedef Point< double, 2 >	PointD = Point2D

typedef Point< double, 2 >	Point2D

typedef Point< double, 3 >	Point3D

Functions
std::ostream &	operator<< (std::ostream &os, lsst::afw::geom::AffineTransform const &transform)

AffineTransform	makeAffineTransformFromTriple (Point2D const &p1, Point2D const &p2, Point2D const &p3, Point2D const &q1, Point2D const &q2, Point2D const &q3)

double	degToRad (double x)

double	radToDeg (double x)

double	radToArcsec (double x)

double	radToMas (double x)

double	arcsecToRad (double x)

double	masToRad (double x)

const Angle	operator+ (Angle const a, Angle const d)

const Angle	operator- (Angle const a, Angle const d)

const Angle	operator* (Angle const a, Angle const d)

const Angle	operator* (Angle const a, double d)

const Angle	operator* (double d, Angle const a)

const Angle	operator* (Angle const a, int d)

const Angle	operator* (int d, Angle const a)

const Angle	operator/ (Angle const a, int d)

const Angle	operator/ (Angle const a, double d)

template<typename T >
double	operator/ (T const lhs, Angle const rhs)

template<typename T >
bool	isAngle (T)
	Allow a user to check if they have an angle (yes; they could do this themselves via trivial TMP) More...

bool	isAngle (Angle const &)

template<typename T >
const Angle	operator* (T lhs, AngleUnit const rhs)
	Use AngleUnit to convert a POD (e.g. int, double) to an Angle; e.g. 180*afwGeomdegrees. More...

std::ostream &	operator<< (std::ostream &s, Angle const a)

std::ostream &	operator<< (std::ostream &os, Box2I const &box)

std::ostream &	operator<< (std::ostream &os, Box2D const &box)

template<typename Derived , typename T , int N>
bool	allclose (CoordinateBase< Derived, T, N > const &a, CoordinateBase< Derived, T, N > const &b, T rtol=static_cast< T >(1E-5), T atol=static_cast< T >(1E-8))

template<typename Derived , typename T , int N>
std::ostream &	operator<< (std::ostream &os, CoordinateBase< Derived, T, N > const &coordinate)

template<int N>
bool	all (CoordinateExpr< N > const &expr)
	Return true if all elements are true. More...

template<int N>
bool	any (CoordinateExpr< N > const &expr)
	Return true if any elements are true. More...

std::ostream &	operator<< (std::ostream &os, lsst::afw::geom::LinearTransform const &t)

	LSST_EXCEPTION_TYPE (SinglePolygonException, lsst::pex::exceptions::RuntimeError, lsst::afw::geom::SinglePolygonException)

std::ostream &	operator<< (std::ostream &os, Polygon const &poly)
	Stream polygon. More...

Variables
double const	PI = boost::math::constants::pi<double>()
	The ratio of a circle's circumference to diameter. More...

double const	TWOPI = boost::math::constants::pi<double>() * 2.0

double const	HALFPI = boost::math::constants::pi<double>() * 0.5

double const	ONE_OVER_PI = 1.0 / boost::math::constants::pi<double>()

double const	SQRTPI = sqrt(boost::math::constants::pi<double>())

double const	INVSQRTPI = 1.0/sqrt(boost::math::constants::pi<double>())

double const	ROOT2 = boost::math::constants::root_two<double>()

AngleUnit const	radians = AngleUnit(1.0)
	constant with units of radians More...

AngleUnit const	degrees = AngleUnit(PI/180.0)

AngleUnit const	hours = AngleUnit(PI*15.0/180.0)

AngleUnit const	arcminutes = AngleUnit(PI/60/180.0)

AngleUnit const	arcseconds = AngleUnit(PI/180.0/3600.0)

Angle const	NullAngle = Angle(-1000000., degrees)

dictionary	Point = {(int, 2):Point2I, (float, 2):Point2D, (int, 3):Point3I, (float, 3):Point3D}

dictionary	Extent = {(int, 2):Extent2I, (float, 2):Extent2D, (int, 3):Extent3I, (float, 3):Extent3D}

dictionary	CoordinateExpr = {2:CoordinateExpr2, 3:CoordinateExpr3}

Typedef Documentation

lsst::afw::geom::BoxD = Box2D

Definition at line 478 of file Box.h.

lsst::afw::geom::BoxI = Box2I

Definition at line 479 of file Box.h.

typedef CoordinateExpr<2> lsst::afw::geom::CoordinateExpr2

Definition at line 92 of file CoordinateExpr.h.

typedef CoordinateExpr<3> lsst::afw::geom::CoordinateExpr3

Definition at line 93 of file CoordinateExpr.h.

typedef Extent<double,2> lsst::afw::geom::Extent2D

Definition at line 353 of file Extent.h.

typedef Extent<int,2> lsst::afw::geom::Extent2I

Examples:: image2.cc, and maskedImage2.cc.

Definition at line 350 of file Extent.h.

typedef Extent<double,3> lsst::afw::geom::Extent3D

Definition at line 354 of file Extent.h.

typedef Extent<int,3> lsst::afw::geom::Extent3I

Definition at line 351 of file Extent.h.

lsst::afw::geom::ExtentD = Extent2D

Definition at line 352 of file Extent.h.

lsst::afw::geom::ExtentI = Extent2I

Definition at line 347 of file Extent.h.

typedef Point<double,2> lsst::afw::geom::Point2D

Definition at line 277 of file Point.h.

typedef Point< int, 2 > lsst::afw::geom::Point2I

Definition at line 274 of file Point.h.

typedef Point<double,3> lsst::afw::geom::Point3D

Definition at line 278 of file Point.h.

typedef Point<int,3> lsst::afw::geom::Point3I

Definition at line 275 of file Point.h.

lsst::afw::geom::PointD = Point2D

Definition at line 276 of file Point.h.

lsst::afw::geom::PointI = Point2I

Definition at line 273 of file Point.h.

Function Documentation

template<int N>

bool lsst::afw::geom::all ( CoordinateExpr< N > const & expr )

inline

Return true if all elements are true.

Definition at line 80 of file CoordinateExpr.h.

                                                 {
     for (int n=0; n<N; ++n) if (!expr[n]) return false;
     return true;
 }

template<typename Derived , typename T , int N>

bool lsst::afw::geom::allclose	(	CoordinateBase< Derived, T, N > const &	a,
		CoordinateBase< Derived, T, N > const &	b,
		T	rtol = `static_cast< T >(1E-5)`,
		T	atol = `static_cast< T >(1E-8)`
	)

template<int N>

bool lsst::afw::geom::any ( CoordinateExpr< N > const & expr )

inline

Return true if any elements are true.

Definition at line 87 of file CoordinateExpr.h.

                                                 {
     for (int n=0; n<N; ++n) if (expr[n]) return true;
     return false;
 }

double lsst::afw::geom::arcsecToRad ( double x )

inline

Definition at line 41 of file Angle.h.

                                     {
         return (x / 3600.) * PI / 180.;
 }

double lsst::afw::geom::degToRad ( double x )

inline

Definition at line 29 of file Angle.h.

                                  {
         return x * PI / 180.;
 }

template<typename T >

bool lsst::afw::geom::isAngle ( T )

inline

Allow a user to check if they have an angle (yes; they could do this themselves via trivial TMP)

Definition at line 290 of file Angle.h.

                        {
     return false;
 };

bool lsst::afw::geom::isAngle ( Angle const & )

inline

Definition at line 294 of file Angle.h.

                                   {
     return true;
 };

lsst::afw::geom::LSST_EXCEPTION_TYPE	(	SinglePolygonException	,
		lsst::pex::exceptions::RuntimeError	,
		lsst::afw::geom::SinglePolygonException
	)

An exception that indicates the single-polygon assumption has been violated

The single-polygon assumption is used in Polygon::intersectionSingle and Polygon::unionSingle.

AffineTransform lsst::afw::geom::makeAffineTransformFromTriple	(	Point2D const &	p1,
		Point2D const &	p2,
		Point2D const &	p3,
		Point2D const &	q1,
		Point2D const &	q2,
		Point2D const &	q3
	)

double lsst::afw::geom::masToRad ( double x )

inline

Definition at line 44 of file Angle.h.

                                  {
         return (x / (1000. * 3600.)) * PI / 180.;
 }

const Angle lsst::afw::geom::operator*	(	Angle const	a,
		Angle const	d
	)

inline

Definition at line 266 of file Angle.h.

274 {

const Angle lsst::afw::geom::operator*	(	Angle const	a,
		double	d
	)

inline

Definition at line 267 of file Angle.h.

274 {

const Angle lsst::afw::geom::operator*	(	double	d,
		Angle const	a
	)

inline

Definition at line 267 of file Angle.h.

274 {

const Angle lsst::afw::geom::operator*	(	Angle const	a,
		int	d
	)

inline

Definition at line 268 of file Angle.h.

274 {

const Angle lsst::afw::geom::operator*	(	int	d,
		Angle const	a
	)

inline

Definition at line 268 of file Angle.h.

274 {

template<typename T >

const Angle lsst::afw::geom::operator*	(	T	lhs,
		AngleUnit const	rhs
	)

inline

Use AngleUnit to convert a POD (e.g. int, double) to an Angle; e.g. 180*afwGeomdegrees.

Parameters

lhs	the value to convert
rhs	the conversion coefficient

Definition at line 304 of file Angle.h.

                         {
     BOOST_STATIC_ASSERT_MSG(std::numeric_limits<T>::is_specialized,
                             "Only numeric types may be converted to Angles using degrees/radians!");
     return Angle(lhs*rhs._val);
 }

const Angle lsst::afw::geom::operator+	(	Angle const	a,
		Angle const	d
	)

inline

Definition at line 264 of file Angle.h.

274 {

const Angle lsst::afw::geom::operator-	(	Angle const	a,
		Angle const	d
	)

inline

Definition at line 265 of file Angle.h.

274 {

const Angle lsst::afw::geom::operator/	(	Angle const	a,
		int	d
	)

inline

Definition at line 274 of file Angle.h.

                                                     {
     return Angle(static_cast<double>(a)/d);
 }

const Angle lsst::afw::geom::operator/	(	Angle const	a,
		double	d
	)

inline

Definition at line 278 of file Angle.h.

                                                        {
     return Angle(static_cast<double>(a)/d);
 }

template<typename T >

double lsst::afw::geom::operator/	(	T const	lhs,
		Angle const	rhs
	)

std::ostream& lsst::afw::geom::operator<<	(	std::ostream &	os,
		lsst::afw::geom::LinearTransform const &	t
	)

template<typename Derived , typename T , int N>

std::ostream& lsst::afw::geom::operator<<	(	std::ostream &	os,
		CoordinateBase< Derived, T, N > const &	coordinate
	)

Definition at line 199 of file CoordinateBase.h.

                                                                                          {
     os << "(" << coordinate[0];
     for (int n=1; n<N; ++n) os << ", " << coordinate[n];
     return os << ")";
 }

std::ostream& lsst::afw::geom::operator<<	(	std::ostream &	os,
		Polygon const &	poly
	)

Stream polygon.

std::ostream& lsst::afw::geom::operator<<	(	std::ostream &	os,
		lsst::afw::geom::AffineTransform const &	transform
	)

std::ostream& lsst::afw::geom::operator<<	(	std::ostream &	s,
		Angle const	a
	)

Output operator for an Angle

Parameters

s	The output stream
a	The angle

std::ostream& lsst::afw::geom::operator<<	(	std::ostream &	os,
		Box2I const &	box
	)

std::ostream& lsst::afw::geom::operator<<	(	std::ostream &	os,
		Box2D const &	box
	)

double lsst::afw::geom::radToArcsec ( double x )

inline

Definition at line 35 of file Angle.h.

                                     {
         return x * 3600. * 180. / PI;
 }

double lsst::afw::geom::radToDeg ( double x )

inline

Definition at line 32 of file Angle.h.

                                  {
         return x * 180. / PI;
 }

double lsst::afw::geom::radToMas ( double x )

inline

Definition at line 38 of file Angle.h.

                                  {
         return x * 1000. * 3600. * 180. / PI;
 }

Variable Documentation

AngleUnit const lsst::afw::geom::arcminutes = AngleUnit(PI/60/180.0)

Definition at line 94 of file Angle.h.

AngleUnit const lsst::afw::geom::arcseconds = AngleUnit(PI/180.0/3600.0)

Definition at line 95 of file Angle.h.

dictionary lsst.afw.geom.CoordinateExpr = {2:CoordinateExpr2, 3:CoordinateExpr3}

Definition at line 40 of file __init__.py.

AngleUnit const lsst::afw::geom::degrees = AngleUnit(PI/180.0)

Definition at line 92 of file Angle.h.

dictionary lsst.afw.geom.Extent = {(int, 2):Extent2I, (float, 2):Extent2D, (int, 3):Extent3I, (float, 3):Extent3D}

Definition at line 39 of file __init__.py.

double const lsst::afw::geom::HALFPI = boost::math::constants::pi<double>() * 0.5

Definition at line 20 of file Angle.h.

AngleUnit const lsst::afw::geom::hours = AngleUnit(PI*15.0/180.0)

Definition at line 93 of file Angle.h.

double const lsst::afw::geom::INVSQRTPI = 1.0/sqrt(boost::math::constants::pi<double>())

Definition at line 23 of file Angle.h.

Angle const lsst::afw::geom::NullAngle = Angle(-1000000., degrees)

Definition at line 240 of file Angle.h.

double const lsst::afw::geom::ONE_OVER_PI = 1.0 / boost::math::constants::pi<double>()

Definition at line 21 of file Angle.h.

double const lsst::afw::geom::PI = boost::math::constants::pi<double>()

The ratio of a circle's circumference to diameter.

Definition at line 18 of file Angle.h.

dictionary lsst.afw.geom.Point = {(int, 2):Point2I, (float, 2):Point2D, (int, 3):Point3I, (float, 3):Point3D}

Definition at line 38 of file __init__.py.

AngleUnit const lsst::afw::geom::radians = AngleUnit(1.0)

constant with units of radians

Definition at line 91 of file Angle.h.

double const lsst::afw::geom::ROOT2 = boost::math::constants::root_two<double>()

Definition at line 24 of file Angle.h.

double const lsst::afw::geom::SQRTPI = sqrt(boost::math::constants::pi<double>())

Definition at line 22 of file Angle.h.

double const lsst::afw::geom::TWOPI = boost::math::constants::pi<double>() * 2.0

Definition at line 19 of file Angle.h.

Namespaces

Classes

Typedefs

Functions

Variables

Typedef Documentation

Function Documentation

Variable Documentation