lsst::afw::image::XYTransformFromWcsPair Class Reference

XYTransformFromWcsPair: An XYTransform obtained by putting two Wcs objects "back to back". More...

#include <Wcs.h>

Inheritance diagram for lsst::afw::image::XYTransformFromWcsPair:

Public Member Functions
	XYTransformFromWcsPair (boost::shared_ptr< Wcs const > dst, boost::shared_ptr< Wcs const > src)
virtual	~XYTransformFromWcsPair ()
virtual boost::shared_ptr < afw::geom::XYTransform >	invert () const
	returns a "deep inverse" in this sense that the forward+inverse transforms do not share state More...
virtual boost::shared_ptr < afw::geom::XYTransform >	clone () const
	The following methods are needed to devirtualize the XYTransform parent class. More...
virtual Point2D	forwardTransform (Point2D const &pixel) const
	virtuals for forward and reverse transforms More...
virtual Point2D	reverseTransform (Point2D const &pixel) const
Public Member Functions inherited from lsst::afw::geom::XYTransform
	XYTransform ()
virtual	~XYTransform ()
virtual AffineTransform	linearizeForwardTransform (Point2D const &point) const
	linearized forward and reversed transforms More...
virtual AffineTransform	linearizeReverseTransform (Point2D const &point) const
Public Member Functions inherited from lsst::daf::base::Citizen
	Citizen (const std::type_info &)
	Citizen (Citizen const &)
	~Citizen ()
Citizen &	operator= (Citizen const &)
std::string	repr () const
	Return a string representation of a Citizen. More...
void	markPersistent (void)
	Mark a Citizen as persistent and not destroyed until process end. More...
memId	getId () const
	Return the Citizen's ID. More...

Protected Attributes
boost::shared_ptr< Wcs const >	_dst
boost::shared_ptr< Wcs const >	_src

Additional Inherited Members
Public Types inherited from lsst::afw::geom::XYTransform
typedef afw::geom::Point2D	Point2D
typedef afw::geom::AffineTransform	AffineTransform
Public Types inherited from lsst::daf::base::Citizen
enum	{ magicSentinel = 0xdeadbeef }
typedef unsigned long	memId
	Type of the block's ID. More...
typedef memId(*	memNewCallback )(const memId cid)
	A function used to register a callback. More...
typedef memId(*	memCallback )(const Citizen *ptr)
Static Public Member Functions inherited from lsst::daf::base::Citizen
static bool	hasBeenCorrupted ()
	Check all allocated blocks for corruption. More...
static memId	getNextMemId ()
	Return the memId of the next object to be allocated. More...
static int	init ()
	Called once when the memory system is being initialised. More...
static int	census (int, memId startingMemId=0)
	How many active Citizens are there? More...
static void	census (std::ostream &stream, memId startingMemId=0)
	Print a list of all active Citizens to stream, sorted by ID. More...
static const std::vector < const Citizen * > *	census ()
	Return a (newly allocated) std::vector of active Citizens sorted by ID. More...
static memId	setNewCallbackId (memId id)
	Call the NewCallback when block is allocated. More...
static memId	setDeleteCallbackId (memId id)
	Call the current DeleteCallback when block is deleted. More...
static memNewCallback	setNewCallback (memNewCallback func)
	Set the NewCallback function. More...
static memCallback	setDeleteCallback (memCallback func)
	Set the DeleteCallback function. More...
static memCallback	setCorruptionCallback (memCallback func)
	Set the CorruptionCallback function. More...

Detailed Description

XYTransformFromWcsPair: An XYTransform obtained by putting two Wcs objects "back to back".

Eventually there will be an XYTransform subclass which represents a camera distortion. For now we can get a SIP camera distortion in a clunky way, by using an XYTransformFromWcsPair with a SIP-distorted TanWcs and an undistorted Wcs.

Note: this is very similar to class afw::math::detail::WcsPositionFunctor but watch out since the XY0 offset convention is different!!

Definition at line 432 of file Wcs.h.

Constructor & Destructor Documentation

XYTransformFromWcsPair::XYTransformFromWcsPair	(	boost::shared_ptr< Wcs const >	dst,
		boost::shared_ptr< Wcs const >	src
	)

Definition at line 1284 of file Wcs.cc.

    : XYTransform(), _dst(dst), _src(src)
{ }

virtual lsst::afw::image::XYTransformFromWcsPair::~XYTransformFromWcsPair ( )

inlinevirtual

Definition at line 436 of file Wcs.h.

{ }

Member Function Documentation

boost::shared_ptr< afwGeom::XYTransform > XYTransformFromWcsPair::clone ( void  ) const

virtual

The following methods are needed to devirtualize the XYTransform parent class.

Implements lsst::afw::geom::XYTransform.

Definition at line 1289 of file Wcs.cc.

{
    return boost::make_shared<XYTransformFromWcsPair>(_dst->clone(), _src->clone());
}

afwGeom::Point2D XYTransformFromWcsPair::forwardTransform ( Point2D const &  point ) const

virtual

virtuals for forward and reverse transforms

These routines are responsible for throwing exceptions if the 'point' arg is outside the domain of the transform.

Implements lsst::afw::geom::XYTransform.

Definition at line 1295 of file Wcs.cc.

{
    //
    // TODO there is an alternate version of pixelToSky() which is designated for the 
    // "knowledgeable user in need of performance".  This is probably better, but first I need 
    // to understand exactly which checks are needed (e.g. I think we need to check by hand 
    // that both Wcs's use the same celestial coordinate system)
    //
    PTR(afw::coord::Coord) x = _src->pixelToSky(pixel);
    return _dst->skyToPixel(*x);
}

boost::shared_ptr< afwGeom::XYTransform > XYTransformFromWcsPair::invert ( ) const

virtual

returns a "deep inverse" in this sense that the forward+inverse transforms do not share state

Reimplemented from lsst::afw::geom::XYTransform.

Definition at line 1313 of file Wcs.cc.

{
    // just swap src, dst
    return boost::make_shared<XYTransformFromWcsPair> (_src, _dst);
}

afwGeom::Point2D XYTransformFromWcsPair::reverseTransform ( Point2D const &  pixel ) const

virtual

Implements lsst::afw::geom::XYTransform.

Definition at line 1307 of file Wcs.cc.

{
    PTR(afw::coord::Coord) x = _dst->pixelToSky(pixel);
    return _src->skyToPixel(*x);
}

Member Data Documentation

boost::shared_ptr< Wcs const> lsst::afw::image::XYTransformFromWcsPair::_dst

protected

Definition at line 446 of file Wcs.h.

boost::shared_ptr< Wcs const> lsst::afw::image::XYTransformFromWcsPair::_src

protected

Definition at line 447 of file Wcs.h.

---

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

• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/image/Wcs.h
• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/src/image/Wcs.cc