Implementation of the WCS standard for the special case of the Gnomonic (tangent plane) projection. More...

#include <TanWcs.h>

Inheritance diagram for lsst::afw::image::TanWcs:

Public Types
typedef boost::shared_ptr < lsst::afw::image::TanWcs >	Ptr

typedef boost::shared_ptr < lsst::afw::image::TanWcs const >	ConstPtr

Public Types inherited from lsst::afw::image::Wcs
typedef boost::shared_ptr< Wcs >	Ptr

typedef boost::shared_ptr< Wcs const >	ConstPtr

Public Types inherited from lsst::daf::base::Persistable
typedef boost::shared_ptr < Persistable >	Ptr

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)

Public Member Functions
	TanWcs (geom::Point2D const &crval, geom::Point2D const &crpix, Eigen::Matrix2d const &cd, double equinox=2000, std::string const &raDecSys="FK5", std::string const &cunits1="deg", std::string const &cunits2="deg")
	Construct a tangent plane wcs without distortion terms. More...

	TanWcs (geom::Point2D const &crval, geom::Point2D const &crpix, Eigen::Matrix2d const &cd, Eigen::MatrixXd const &sipA, Eigen::MatrixXd const &sipB, Eigen::MatrixXd const &sipAp, Eigen::MatrixXd const &sipBp, double equinox=2000, std::string const &raDecSys="FK5", std::string const &cunits1="deg", std::string const &cunits2="deg")
	Construct a tangent plane wcs with distortion terms. More...

virtual	~TanWcs ()

virtual boost::shared_ptr< Wcs >	clone () const
	Polymorphic deep-copy. More...

geom::Angle	pixelScale () const
	Returns the pixel scale, in Angle/pixel. More...

geom::Point2D	distortPixel (geom::Point2D const &pixel) const
	Applies the SIP AP and BP distortion (used in the skyToPixel direction) More...

geom::Point2D	undistortPixel (geom::Point2D const &pixel) const
	Applies the SIP A and B un-distortion (used in the pixelToSky direction) More...

bool	hasDistortion () const

boost::shared_ptr < daf::base::PropertyList >	getFitsMetadata () const
	Return a PropertyList containing FITS header keywords that can be used to save the Wcs.x. More...

void	setDistortionMatrices (Eigen::MatrixXd const &sipA, Eigen::MatrixXd const &sipB, Eigen::MatrixXd const &sipAp, Eigen::MatrixXd const &sipBp)
	Set the distortion matrices. More...

virtual bool	isPersistable () const
	Whether the object is persistable using afw::table::io archives. More...

Public Member Functions inherited from lsst::afw::image::Wcs
	Wcs (lsst::afw::geom::Point2D const &crval, lsst::afw::geom::Point2D const &crpix, Eigen::Matrix2d const &CD, std::string const &ctype1="RA---TAN", std::string const &ctype2="DEC--TAN", double equinox=2000, std::string const &raDecSys="ICRS", std::string const &cunits1="deg", std::string const &cunits2="deg")
	Create a Wcs object with some known information. More...

virtual	~Wcs ()

bool	operator== (Wcs const &other) const

bool	operator!= (Wcs const &other) const

lsst::afw::coord::Coord::Ptr	getSkyOrigin () const
	Returns CRVAL. This need not be the centre of the image. More...

lsst::afw::geom::Point2D	getPixelOrigin () const
	Returns CRPIX (corrected to LSST convention). More...

Eigen::Matrix2d	getCDMatrix () const
	Returns the CD matrix. More...

virtual void	flipImage (int flipLR, int flipTB, lsst::afw::geom::Extent2I dimensions) const
	Flip CD matrix around the y-axis. More...

virtual void	rotateImageBy90 (int nQuarter, lsst::afw::geom::Extent2I dimensions) const
	Rotate image by nQuarter times 90 degrees. More...

bool	isFlipped () const

double	pixArea (lsst::afw::geom::Point2D pix00) const
	Sky area covered by a pixel at position `pix00` in units of square degrees. More...

geom::Angle	pixelScale () const
	Returns the pixel scale [Angle/pixel]. More...

boost::shared_ptr< coord::Coord >	pixelToSky (double pix1, double pix2) const
	Convert from pixel position to sky coordinates (e.g. RA/dec) More...

boost::shared_ptr< coord::Coord >	pixelToSky (lsst::afw::geom::Point2D const &pixel) const
	Convert from pixel position to sky coordinates (e.g. RA/dec) More...

void	pixelToSky (double pixel1, double pixel2, geom::Angle &sky1, geom::Angle &sky2) const

geom::Point2D	skyToPixel (geom::Angle sky1, geom::Angle sky2) const
	Convert from sky coordinates (e.g. RA/dec) to pixel positions. More...

geom::Point2D	skyToPixel (coord::Coord const &coord) const
	Convert from sky coordinates (e.g. RA/dec) to pixel positions. More...

geom::Point2D	skyToIntermediateWorldCoord (coord::Coord const &coord) const
	Convert from sky coordinates (e.g. RA/dec) to intermediate world coordinates. More...

geom::LinearTransform	getLinearTransform () const

geom::AffineTransform	linearizePixelToSky (coord::Coord const &coord, geom::AngleUnit skyUnit=geom::degrees) const
	Return the local linear approximation to Wcs::pixelToSky at a point given in sky coordinates. More...

geom::AffineTransform	linearizePixelToSky (geom::Point2D const &pix, geom::AngleUnit skyUnit=geom::degrees) const
	Return the local linear approximation to Wcs::pixelToSky at a point given in pixel coordinates. More...

geom::AffineTransform	linearizeSkyToPixel (coord::Coord const &coord, geom::AngleUnit skyUnit=geom::degrees) const
	Return the local linear approximation to Wcs::skyToPixel at a point given in sky coordinates. More...

geom::AffineTransform	linearizeSkyToPixel (geom::Point2D const &pix, geom::AngleUnit skyUnit=geom::degrees) const
	Return the local linear approximation to Wcs::skyToPixel at a point given in pixel coordinates. More...

virtual void	shiftReferencePixel (double dx, double dy)
	Move the pixel reference position by (dx, dy) More...

virtual void	shiftReferencePixel (geom::Extent2D const &d)

Public Member Functions inherited from lsst::daf::base::Persistable
	Persistable (void)

virtual	~Persistable (void)

template<class Archive >
void	serialize (Archive &, unsigned int 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...

Public Member Functions inherited from lsst::afw::table::io::Persistable
void	writeFits (std::string const &fileName, std::string const &mode="w") const
	Write the object to a regular FITS file. More...

void	writeFits (fits::MemFileManager &manager, std::string const &mode="w") const
	Write the object to a FITS image in memory. More...

void	writeFits (fits::Fits &fitsfile) const
	Write the object to an already-open FITS object. More...

virtual	~Persistable ()

Static Public Member Functions
static void	decodeSipHeader (daf::base::PropertySet const &fitsMetadata, std::string const &which, Eigen::MatrixXd &m)
	Decode the SIP headers for a given matrix, if present. More...

Static Public Member Functions inherited from lsst::afw::table::io::PersistableFacade< TanWcs >
static boost::shared_ptr< TanWcs >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object. More...

static boost::shared_ptr< TanWcs >	readFits (std::string const &fileName, int hdu=0)
	Read an object from a regular FITS file. More...

static boost::shared_ptr< TanWcs >	readFits (fits::MemFileManager &manager, int hdu=0)
	Read an object from a FITS file in memory. More...

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...

Static Public Member Functions inherited from lsst::afw::table::io::PersistableFacade< Wcs >
static boost::shared_ptr< Wcs >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object. More...

static boost::shared_ptr< Wcs >	readFits (std::string const &fileName, int hdu=0)
	Read an object from a regular FITS file. More...

static boost::shared_ptr< Wcs >	readFits (fits::MemFileManager &manager, int hdu=0)
	Read an object from a FITS file in memory. More...

Protected Member Functions
	TanWcs (TanWcs const &rhs)

virtual void	pixelToSkyImpl (double pixel1, double pixel2, geom::Angle skyTmp[2]) const

virtual geom::Point2D	skyToPixelImpl (geom::Angle sky1, geom::Angle sky2) const

Protected Member Functions inherited from lsst::afw::image::Wcs
bool	_mayBePersistable () const
	Perform basic checks on whether *this might be persistable. More...

virtual std::string	getPythonModule () const
	Return the fully-qualified Python module that should be imported to guarantee that its factory is registered. More...

	Wcs ()
	Construct an invalid Wcs given no arguments. More...

	Wcs (boost::shared_ptr< lsst::daf::base::PropertySet const > const &fitsMetadata)

	Wcs (afw::table::BaseRecord const &record)

	Wcs (Wcs const &rhs)
	Copy constructor. More...

Wcs &	operator= (const Wcs &)

afw::coord::Coord::Ptr	makeCorrectCoord (geom::Angle sky0, geom::Angle sky1) const
	Given a sky position, use the values stored in ctype and radesys to return the correct sub-class of Coord. More...

afw::coord::Coord::Ptr	convertCoordToSky (coord::Coord const &coord) const

virtual geom::AffineTransform	linearizePixelToSkyInternal (geom::Point2D const &pix, coord::Coord const &coord, geom::AngleUnit skyUnit) const

virtual geom::AffineTransform	linearizeSkyToPixelInternal (geom::Point2D const &pix, coord::Coord const &coord, geom::AngleUnit skyUnit) const

void	initWcsLibFromFits (boost::shared_ptr< lsst::daf::base::PropertySet const > const &fitsMetadata)
	Parse a fits header, extract the relevant metadata and create a Wcs object. More...

void	_initWcs ()

void	_setWcslibParams ()

Protected Member Functions inherited from lsst::afw::table::io::Persistable
	Persistable ()

	Persistable (Persistable const &other)

void	operator= (Persistable const &other)

Private Member Functions
virtual std::string	getPersistenceName () const
	Return the unique name used to persist this object and look up its factory. More...

virtual void	write (OutputArchiveHandle &handle) const
	Write the object to one or more catalogs. More...

virtual bool	_isSubset (Wcs const &) const

	TanWcs ()

	TanWcs (boost::shared_ptr< daf::base::PropertySet const > const &fitsMetadata)

	TanWcs (afw::table::BaseRecord const &mainRecord, boost::shared_ptr< afw::table::BaseRecord const > sipRecord)

TanWcs &	operator= (const TanWcs &)

Private Attributes
bool	_hasDistortion

Eigen::MatrixXd	_sipA

Eigen::MatrixXd	_sipB

Eigen::MatrixXd	_sipAp

Eigen::MatrixXd	_sipBp

Friends
class	TanWcsFactory

boost::shared_ptr< Wcs >	makeWcs (boost::shared_ptr< daf::base::PropertySet > const &metadata, bool)

Additional Inherited Members
Protected Types inherited from lsst::afw::table::io::Persistable
typedef io::OutputArchiveHandle	OutputArchiveHandle

Protected Attributes inherited from lsst::afw::image::Wcs
struct wcsprm *	_wcsInfo

int	_nWcsInfo

int	_relax
	Degree of permissiveness for wcspih (0 for strict); see wcshdr.h for details. More...

int	_wcsfixCtrl
	Do potentially unsafe translations of non-standard unit strings? 0/1 = no/yes. More...

int	_wcshdrCtrl
	Controls messages to stderr from wcshdr (0 for none); see wcshdr.h for details. More...

int	_nReject

coord::CoordSystem	_coordSystem

Detailed Description

Implementation of the WCS standard for the special case of the Gnomonic (tangent plane) projection.

This class treats the special case of tangent plane projection. It extends the Wcs standard by optionally accounting for distortion in the image plane using the Simple Imaging Polynomial (SIP) convention. This convention is described in Shupe et al. (2005) (Astronomical Data Analysis Software and Systems XIV, Asp Conf. Series Vol XXX, Ed: Shopbell et al.), and descibed in some more detail in http://web.ipac.caltech.edu/staff/fmasci/home/wise/codeVdist.html

To convert from pixel coordintates to radec ("intermediate world coordinates"), first use the matrices _sipA and _sipB to calculate undistorted coorinates (i.e where on the chip the image would lie if the optics gave undistorted images), then pass these undistorted coorinates wcsp2s() to calculate radec.

For the reverse, radec -> pixels, convert the radec to undistorted coords, and then use the _sipAp and _sipBp matrices to add in the distortion terms.

Definition at line 68 of file TanWcs.h.

Member Typedef Documentation

typedef boost::shared_ptr<lsst::afw::image::TanWcs const> lsst::afw::image::TanWcs::ConstPtr

Definition at line 71 of file TanWcs.h.

typedef boost::shared_ptr<lsst::afw::image::TanWcs> lsst::afw::image::TanWcs::Ptr

Definition at line 70 of file TanWcs.h.

Constructor & Destructor Documentation

lsst::afw::image::TanWcs::TanWcs	(	geom::Point2D const &	crval,
		geom::Point2D const &	crpix,
		Eigen::Matrix2d const &	cd,
		double	equinox = `2000`,
		std::string const &	raDecSys = `"FK5"`,
		std::string const &	cunits1 = `"deg"`,
		std::string const &	cunits2 = `"deg"`
	)

Construct a tangent plane wcs without distortion terms.

Parameters

crval	The sky position of the reference point
crpix	The pixel position corresponding to crval in Lsst units
cd	Matrix describing transformations from pixel to sky positions
equinox	Equinox of coordinate system, eg 2000 (Julian) or 1950 (Besselian)
raDecSys	System used to describe right ascension or declination, e.g FK4, FK5 or ICRS
cunits1	Units of sky position. One of deg, arcmin or arcsec
cunits2	Units of sky position. One of deg, arcmin or arcsec

lsst::afw::image::TanWcs::TanWcs	(	geom::Point2D const &	crval,
		geom::Point2D const &	crpix,
		Eigen::Matrix2d const &	cd,
		Eigen::MatrixXd const &	sipA,
		Eigen::MatrixXd const &	sipB,
		Eigen::MatrixXd const &	sipAp,
		Eigen::MatrixXd const &	sipBp,
		double	equinox = `2000`,
		std::string const &	raDecSys = `"FK5"`,
		std::string const &	cunits1 = `"deg"`,
		std::string const &	cunits2 = `"deg"`
	)

Construct a tangent plane wcs with distortion terms.

Parameters

crval	The sky position of the reference point
crpix	The pixel position corresponding to crval in Lsst units
cd	Matrix describing transformations from pixel to sky positions
sipA	Forward distortion matrix for axis 1
sipB	Forward distortion matrix for axis 2
sipAp	Reverse distortion matrix for axis 1
sipBp	Reverse distortion matrix for axis 2
equinox	Equinox of coordinate system, eg 2000 (Julian) or 1950 (Besselian)
raDecSys	System used to describe right ascension or declination, e.g FK4, FK5 or ICRS
cunits1	Units of sky position. One of deg, arcmin or arcsec
cunits2	Units of sky position. One of deg, arcmin or arcsec

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

inlinevirtual

Definition at line 124 of file TanWcs.h.

124 {};

lsst::afw::image::TanWcs::TanWcs ( TanWcs const & rhs )

protected

lsst::afw::image::TanWcs::TanWcs ( )

private

lsst::afw::image::TanWcs::TanWcs ( boost::shared_ptr< daf::base::PropertySet const > const & fitsMetadata )

private

lsst::afw::image::TanWcs::TanWcs	(	afw::table::BaseRecord const &	mainRecord,
		boost::shared_ptr< afw::table::BaseRecord const >	sipRecord
	)

private

Member Function Documentation

virtual bool lsst::afw::image::TanWcs::_isSubset ( Wcs const & ) const

privatevirtual

Reimplemented from lsst::afw::image::Wcs.

virtual boost::shared_ptr< Wcs > lsst::afw::image::TanWcs::clone ( ) const

virtual

Polymorphic deep-copy.

Reimplemented from lsst::afw::image::Wcs.

Reimplemented in lsst::afw::image::DistortedTanWcs.

static void lsst::afw::image::TanWcs::decodeSipHeader	(	daf::base::PropertySet const &	fitsMetadata,
		std::string const &	which,
		Eigen::MatrixXd &	m
	)

static

Decode the SIP headers for a given matrix, if present.

geom::Point2D lsst::afw::image::TanWcs::distortPixel ( geom::Point2D const & pixel ) const

Applies the SIP AP and BP distortion (used in the skyToPixel direction)

boost::shared_ptr< daf::base::PropertyList > lsst::afw::image::TanWcs::getFitsMetadata ( ) const

virtual

Return a PropertyList containing FITS header keywords that can be used to save the Wcs.x.

Reimplemented from lsst::afw::image::Wcs.

virtual std::string lsst::afw::image::TanWcs::getPersistenceName ( ) const

privatevirtual

Return the unique name used to persist this object and look up its factory.

Must be less than ArchiveIndexSchema::MAX_NAME_LENGTH characters.

Reimplemented from lsst::afw::image::Wcs.

bool lsst::afw::image::TanWcs::hasDistortion ( ) const

inlinevirtual

Reimplemented from lsst::afw::image::Wcs.

Definition at line 140 of file TanWcs.h.

140 { return _hasDistortion;};

lsst::afw::image::TanWcs::_hasDistortion

bool _hasDistortion

Definition: TanWcs.h:204

virtual bool lsst::afw::image::TanWcs::isPersistable ( ) const

virtual

Whether the object is persistable using afw::table::io archives.

Reimplemented from lsst::afw::image::Wcs.

Reimplemented in lsst::afw::image::DistortedTanWcs.

TanWcs& lsst::afw::image::TanWcs::operator= ( const TanWcs & )

private

geom::Angle lsst::afw::image::TanWcs::pixelScale ( ) const

Returns the pixel scale, in Angle/pixel.

virtual void lsst::afw::image::TanWcs::pixelToSkyImpl	(	double	pixel1,
		double	pixel2,
		geom::Angle	skyTmp[2]
	)		const

protectedvirtual

Reimplemented from lsst::afw::image::Wcs.

Reimplemented in lsst::afw::image::DistortedTanWcs.

void lsst::afw::image::TanWcs::setDistortionMatrices	(	Eigen::MatrixXd const &	sipA,
		Eigen::MatrixXd const &	sipB,
		Eigen::MatrixXd const &	sipAp,
		Eigen::MatrixXd const &	sipBp
	)

Set the distortion matrices.

Parameters

sipA	Forward distortion matrix for 1st axis
sipB	Forward distortion matrix for 2nd axis
sipAp	Reverse distortion matrix for 1st axis
sipBp	Reverse distortion matrix for 2nd axis

Because the base class provides the option of creating a Wcs without distortion coefficients we supply a way of setting them here. This also help make code neater by breaking an enormous constructor (above) into two small pieces.

virtual geom::Point2D lsst::afw::image::TanWcs::skyToPixelImpl	(	geom::Angle	sky1,
		geom::Angle	sky2
	)		const

protectedvirtual

Reimplemented from lsst::afw::image::Wcs.

Reimplemented in lsst::afw::image::DistortedTanWcs.

geom::Point2D lsst::afw::image::TanWcs::undistortPixel ( geom::Point2D const & pixel ) const

Applies the SIP A and B un-distortion (used in the pixelToSky direction)

virtual void lsst::afw::image::TanWcs::write ( OutputArchiveHandle & handle ) const

privatevirtual

Write the object to one or more catalogs.

The handle object passed to this function provides an interface for adding new catalogs and adding nested objects to the same archive (while checking for duplicates). See OutputArchiveHandle for more information.

Reimplemented from lsst::afw::image::Wcs.

Friends And Related Function Documentation

boost::shared_ptr< Wcs > makeWcs	(	boost::shared_ptr< daf::base::PropertySet > const &	metadata,
		bool
	)

friend

friend class TanWcsFactory

friend

Definition at line 178 of file TanWcs.h.

Member Data Documentation

bool lsst::afw::image::TanWcs::_hasDistortion

private

Definition at line 204 of file TanWcs.h.

Eigen::MatrixXd lsst::afw::image::TanWcs::_sipA

private

Definition at line 205 of file TanWcs.h.

Eigen::MatrixXd lsst::afw::image::TanWcs::_sipAp

private

Definition at line 205 of file TanWcs.h.

Eigen::MatrixXd lsst::afw::image::TanWcs::_sipB

private

Definition at line 205 of file TanWcs.h.

Eigen::MatrixXd lsst::afw::image::TanWcs::_sipBp

private

Definition at line 205 of file TanWcs.h.

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

/home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/image/TanWcs.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation