lsst::meas::algorithms::BinnedWcs Class Reference

#include <BinnedWcs.h>

Inheritance diagram for lsst::meas::algorithms::BinnedWcs:

Public Types
typedef std::shared_ptr< Persistable >	Ptr
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
	BinnedWcs (boost::shared_ptr< afw::image::Wcs > parent, unsigned int xBin, unsigned int yBin, afw::geom::Point2I xy0)
virtual	~BinnedWcs ()
virtual boost::shared_ptr< afw::image::Wcs >	clone () const
boost::shared_ptr< afw::image::Wcs >	upcast ()
boost::shared_ptr< afw::image::Wcs >	getParent () const
unsigned int	getXBin () const
unsigned int	getYBin () const
afw::geom::Point2I	getXY0 () const
virtual bool	hasDistortion () const
virtual bool	isPersistable () const
	Whether the Wcs is persistable using afw::table::io archives. More...
virtual void	flipImage (int flipLR, int flipTB, afw::geom::Extent2I dimensions) const
	Flip CD matrix around the y-axis. More...
virtual void	rotateImageBy90 (int nQuarter, afw::geom::Extent2I dimensions) const
	Rotate image by nQuarter times 90 degrees. More...
virtual 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...
afw::geom::AffineTransform	getBinnedToOriginal () const
afw::geom::AffineTransform	getOriginalToBinned () const
bool	operator== (Wcs const &other) const
bool	operator!= (Wcs const &other) const
std::shared_ptr< lsst::afw::coord::Coord >	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...
bool	isFlipped () const
	Does the Wcs follow the convention of North=Up, East=Left? More...
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...
std::shared_ptr< coord::Coord >	pixelToSky (double pix1, double pix2) const
	Convert from pixel position to sky coordinates (e.g. More...
std::shared_ptr< coord::Coord >	pixelToSky (lsst::afw::geom::Point2D const &pixel) const
	Convert from pixel position to sky coordinates (e.g. More...
void	pixelToSky (double pixel1, double pixel2, geom::Angle &sky1, geom::Angle &sky2) const
	Convert from pixel position to sky coordinates (e.g. More...
geom::Point2D	skyToPixel (geom::Angle sky1, geom::Angle sky2) const
	Convert from sky coordinates (e.g. 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. More...
afw::coord::CoordSystem	getCoordSystem () const
double	getEquinox () const
bool	isSameSkySystem (Wcs const &wcs) const
	Return true if a WCS has the same coordinate system and equinox as this one. More...
geom::LinearTransform	getLinearTransform () const
	Return the linear part of the Wcs, the CD matrix in FITS-speak, as an AffineTransform. More...
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)
template<class Archive >
void	serialize (Archive &, unsigned int const)
	Template boost::serialization function for the base class. More...
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...
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...
T	shared_from_this (T... args)

Static Public Member Functions
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 std::shared_ptr< Wcs >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object. More...
static std::shared_ptr< Wcs >	readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
	Read an object from a regular FITS file. More...
static std::shared_ptr< Wcs >	readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
	Read an object from a FITS file in memory. More...
Census
Provide a list of current Citizens
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...
callbackIDs
Set callback Ids. The old Id is returned
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...
callbacks
Set the New/Delete callback functions; in each case the previously installed callback is returned. These callback functions return a value which is Added to the previously registered id. The default callback functions are called default{New,Delete}Callback; you may want to set a break point in these callbacks from your favourite debugger
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...

Protected Types
typedef io::OutputArchiveHandle	OutputArchiveHandle

Protected Member Functions
virtual void	pixelToSkyImpl (double pixel1, double pixel2, afw::geom::Angle skyTmp[2]) const
	Worker routine for pixelToSky. More...
virtual afw::geom::Point2D	skyToPixelImpl (afw::geom::Angle sky1, afw::geom::Angle sky2) const
	Worker routine for skyToPixel. More...
bool	_mayBePersistable () const
	Perform basic checks on whether *this might be persistable. More...
virtual std::string	getPersistenceName () const
	Return the unique name used to persist this object and look up its factory. More...
virtual std::string	getPythonModule () const
	Return the fully-qualified Python module that should be imported to guarantee that its factory is registered. More...
virtual void	write (OutputArchiveHandle &handle) const
	Write the object to one or more catalogs. More...
virtual bool	_isSubset (Wcs const &other) const
bool	_isIcrs () const
std::shared_ptr< afw::coord::Coord >	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...
std::shared_ptr< afw::coord::Coord >	convertCoordToSky (coord::Coord const &coord) const
	Given a Coord (as a shared pointer), return the sky position in the correct coordinate system for this Wcs. More...
virtual geom::AffineTransform	linearizePixelToSkyInternal (geom::Point2D const &pix, coord::Coord const &coord, geom::AngleUnit skyUnit) const
	Implementation for the overloaded public linearizePixelToSky methods, requiring both a pixel coordinate and the corresponding sky coordinate. More...
virtual geom::AffineTransform	linearizeSkyToPixelInternal (geom::Point2D const &pix, coord::Coord const &coord, geom::AngleUnit skyUnit) const
	Implementation for the overloaded public linearizeSkyToPixel methods, requiring both a pixel coordinate and the corresponding sky coordinate. More...
void	initWcsLibFromFits (std::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 ()
	Set some internal variables that we need to refer to. More...
void	_setWcslibParams ()

Protected Attributes
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
bool	_skyAxesSwapped
	if true then the sky axes are swapped More...

Private Member Functions
void	notImplemented () const

Private Attributes
boost::shared_ptr< afw::image::Wcs > const	_parent
unsigned int const	_xBin
unsigned int const	_yBin
afw::geom::Point2I const	_xy0
afw::geom::AffineTransform const	_binnedToOriginal
afw::geom::AffineTransform const	_originalToBinned

Detailed Description

Definition at line 41 of file BinnedWcs.h.

Member Typedef Documentation

memCallback

typedef memId(* lsst::daf::base::Citizen::memCallback) (const Citizen *ptr)

inherited

Definition at line 59 of file Citizen.h.

memId

typedef unsigned long lsst::daf::base::Citizen::memId

inherited

Type of the block's ID.

Definition at line 56 of file Citizen.h.

memNewCallback

typedef memId(* lsst::daf::base::Citizen::memNewCallback) (const memId cid)

inherited

A function used to register a callback.

Definition at line 58 of file Citizen.h.

OutputArchiveHandle

typedef io::OutputArchiveHandle lsst::afw::table::io::Persistable::OutputArchiveHandle

protectedinherited

Definition at line 108 of file Persistable.h.

Ptr

typedef std::shared_ptr<Persistable> lsst::daf::base::Persistable::Ptr

inherited

Definition at line 76 of file Persistable.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

inherited

Enumerator
magicSentinel

Definition at line 86 of file Citizen.h.

{ magicSentinel = 0xdeadbeef }; 

Constructor & Destructor Documentation

BinnedWcs()

lsst::meas::algorithms::BinnedWcs::BinnedWcs	(	boost::shared_ptr< afw::image::Wcs >	parent,
		unsigned int	xBin,
		unsigned int	yBin,
		afw::geom::Point2I	xy0
	)

Definition at line 29 of file BinnedWcs.cc.

      :
    afw::image::Wcs(*parent), // We have to inherit the implementation as well as the interface...
    _parent(parent), _xBin(xBin), _yBin(yBin), _xy0(xy0),
    _binnedToOriginal(afw::geom::AffineTransform::makeTranslation(afw::geom::Extent2D(_xy0))*
                      afw::geom::AffineTransform::makeScaling(_xBin, _yBin)),
    _originalToBinned(_binnedToOriginal.invert())
{
    // Correct CRPIX
    afw::geom::Point2D const crpix = _originalToBinned(parent->getPixelOrigin());
    _wcsInfo->crpix[0] = crpix.getX() + 1; // convert LSST --> FITS
    _wcsInfo->crpix[1] = crpix.getY() + 1; // convert LSST --> FITS
}

~BinnedWcs()

virtual lsst::meas::algorithms::BinnedWcs::~BinnedWcs ( )

inlinevirtual

Definition at line 44 of file BinnedWcs.h.

{}

Member Function Documentation

_initWcs()

void lsst::afw::image::Wcs::_initWcs ( )

protectedinherited

Set some internal variables that we need to refer to.

Definition at line 114 of file Wcs.cc.

                   {
    // first four characters of CTYPE1 (name of first axis)
    std::string ctype1 = std::string(_wcsInfo->ctype[0]).substr(0, 4);

    if (_wcsInfo) {
        if (ctype1[0] == 'G') {
            _coordSystem = coord::GALACTIC;
            _skyAxesSwapped = (ctype1[2] == 'A');  // GLAT instead of GLON
        } else if (ctype1[0] == 'E') {
            _coordSystem = coord::ECLIPTIC;
            _skyAxesSwapped = (ctype1[2] == 'A');  // ELAT instead of ELON
        } else {
            _coordSystem = coord::makeCoordEnum(_wcsInfo->radesys);
            _skyAxesSwapped = (ctype1[0] == 'D');  // DEC instead of RA
        }

        // tell WCSlib that values have been updated
        _wcsInfo->flag = 0;
        // and then tell it to do its internal magic.
        int status = wcsset(_wcsInfo);
        if (status != 0) {
            throw LSST_EXCEPT(except::RuntimeError,
                              (boost::format("Failed to setup wcs structure with wcsset. Status %d: %s") %
                               status % wcs_errmsg[status])
                                      .str());
        }
    }
}

_isIcrs()

bool lsst::afw::image::Wcs::_isIcrs ( ) const

inlineprotectedinherited

Definition at line 371 of file Wcs.h.

                         {
        return (getCoordSystem() == afw::coord::ICRS) ||
               ((getCoordSystem() == afw::coord::FK5) && (getEquinox() == 2000));
    }

_isSubset()

bool lsst::afw::image::Wcs::_isSubset ( Wcs const &  other ) const

protectedvirtualinherited

Reimplemented in lsst::afw::image::TanWcs.

Definition at line 504 of file Wcs.cc.

                                        {
    CHECK_NULLS(_wcsInfo, rhs._wcsInfo);
    CHECK_NULLS(_wcsInfo->crval, rhs._wcsInfo->crval);
    CHECK_NULLS(_wcsInfo->cd, rhs._wcsInfo->cd);
    CHECK_NULLS(_wcsInfo->crpix, rhs._wcsInfo->crpix);
    CHECK_NULLS(_wcsInfo->cunit, rhs._wcsInfo->cunit);
    CHECK_NULLS(_wcsInfo->ctype, rhs._wcsInfo->ctype);
    return _nWcsInfo == rhs._nWcsInfo && _coordSystem == rhs._coordSystem &&
           _wcsInfo->naxis == rhs._wcsInfo->naxis && _wcsInfo->equinox == rhs._wcsInfo->equinox &&
           _wcsInfo->altlin == rhs._wcsInfo->altlin &&
           compareArrays(_wcsInfo->crval, rhs._wcsInfo->crval, 2) &&
           compareArrays(_wcsInfo->crpix, rhs._wcsInfo->crpix, 2) &&
           compareArrays(_wcsInfo->cd, rhs._wcsInfo->cd, 4) &&
           compareStringArrays(_wcsInfo->cunit, rhs._wcsInfo->cunit, 2) &&
           compareStringArrays(_wcsInfo->ctype, rhs._wcsInfo->ctype, 2) &&
           skyToPixel(_wcsInfo->crval[0] * geom::degrees, _wcsInfo->crval[1] * geom::degrees) ==
                   rhs.skyToPixel(_wcsInfo->crval[0] * geom::degrees, _wcsInfo->crval[1] * geom::degrees) &&
           *pixelToSky(_wcsInfo->crpix[0], _wcsInfo->crpix[1]) ==
                   *rhs.pixelToSky(_wcsInfo->crpix[0], _wcsInfo->crpix[1]);
}

_mayBePersistable()

bool lsst::afw::image::Wcs::_mayBePersistable ( ) const

protectedinherited

Perform basic checks on whether *this might be persistable.

Definition at line 1003 of file Wcs.cc.

                                  {
    if (_wcsInfo[0].naxis != 2) return false;
    if (std::strcmp(_wcsInfo[0].cunit[0], "deg") != 0) return false;
    if (std::strcmp(_wcsInfo[0].cunit[1], "deg") != 0) return false;

    return true;
}

_setWcslibParams()

void lsst::afw::image::Wcs::_setWcslibParams ( )

protectedinherited

Definition at line 68 of file Wcs.cc.

                           {
    _wcsfixCtrl =        // ctrl for wcsfix
            2;           // Translate "H" to "h"
    _wcshdrCtrl =        // ctrl for wcspih
            2;           // Report each rejected keyrecord and the reason why it was rejected
    _relax =             // relax parameter for wcspih;
            WCSHDR_all;  // Accept all extensions recognized by the parser
}

census() [1/3]

int lsst::daf::base::Citizen::census ( int  , memId  startingMemId = 0  )

staticinherited

How many active Citizens are there?

Parameters

startingMemId

Don't print Citizens with lower IDs

Definition at line 267 of file Citizen.cc.

      {
    if (startingMemId == 0) {              // easy
        ReadGuard guard(citizenLock);
        return _activeCitizens.size();
    }

    int n = 0;
    ReadGuard guard(citizenLock);
    for (table::iterator cur = _activeCitizens.begin();
         cur != _activeCitizens.end(); cur++) {
        if (cur->first->_CitizenId >= startingMemId) {
            n++;
        }
    }

    return n;    
}

census() [2/3]

void lsst::daf::base::Citizen::census ( std::ostream &  stream, memId  startingMemId = 0  )

staticinherited

Print a list of all active Citizens to stream, sorted by ID.

Parameters

stream	stream to print to
startingMemId	Don't print Citizens with lower IDs

Definition at line 290 of file Citizen.cc.

      {
    ReadGuard guard(citizenLock);

    std::unique_ptr<std::vector<Citizen const*> const> leaks(Citizen::census());

    for (std::vector<Citizen const *>::const_iterator citizen = leaks->begin(), end = leaks->end();
         citizen != end; ++citizen) {
        if ((*citizen)->getId() >= startingMemId) {
            stream << (*citizen)->repr() << "\n";
        }
    }
}

census() [3/3]

std::vector< dafBase::Citizen const * > const * lsst::daf::base::Citizen::census ( )

staticinherited

Return a (newly allocated) std::vector of active Citizens sorted by ID.

You are responsible for deleting it; or you can say std::unique_ptr<std::vector<Citizen const*> const> leaks(Citizen::census()); and not bother (that becomes std::unique_ptr in C++11)

Definition at line 322 of file Citizen.cc.

                                                               {
    std::vector<Citizen const*>* vec =
        new std::vector<Citizen const*>(0);
    ReadGuard guard(citizenLock);
    vec->reserve(_activeCitizens.size());

    for (table::iterator cur = _activeCitizens.begin();
         cur != _activeCitizens.end(); cur++) {
        vec->push_back(dynamic_cast<Citizen const*>(cur->first));
    }
        
    std::sort(vec->begin(), vec->end(), cmpId);

    return vec;
}

clone()

virtual boost::shared_ptr< afw::image::Wcs > lsst::meas::algorithms::BinnedWcs::clone ( void  ) const

inlinevirtual

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

Definition at line 46 of file BinnedWcs.h.

                                           {
        return PTR(afw::image::Wcs)(std::make_shared<BinnedWcs>(_parent, _xBin, _yBin, _xy0));
    }

convertCoordToSky()

std::shared_ptr< coord::Coord > lsst::afw::image::Wcs::convertCoordToSky ( coord::Coord const &  coord ) const

protectedinherited

Given a Coord (as a shared pointer), return the sky position in the correct coordinate system for this Wcs.

Definition at line 741 of file Wcs.cc.

                                                                              {
    return coord.convert(_coordSystem, _wcsInfo->equinox);
}

flipImage()

virtual void lsst::meas::algorithms::BinnedWcs::flipImage ( int  flipLR, int  flipTB, afw::geom::Extent2I  dimensions  ) const

inlinevirtual

Flip CD matrix around the y-axis.

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

Definition at line 59 of file BinnedWcs.h.

                                                                                     {
        notImplemented();
    }

getBinnedToOriginal()

afw::geom::AffineTransform lsst::meas::algorithms::BinnedWcs::getBinnedToOriginal ( ) const

inline

Definition at line 70 of file BinnedWcs.h.

{ return _binnedToOriginal; }

getCDMatrix()

Eigen::Matrix2d lsst::afw::image::Wcs::getCDMatrix ( ) const

inherited

Returns the CD matrix.

Definition at line 550 of file Wcs.cc.

                                     {
    assert(_wcsInfo);
    int const naxis = _wcsInfo->naxis;

    // If naxis != 2, I'm not sure if any of what follows is correct
    assert(naxis == 2);

    Eigen::Matrix2d C;

    for (int i = 0; i < naxis; ++i) {
        for (int j = 0; j < naxis; ++j) {
            C(i, j) = _wcsInfo->cd[(i * naxis) + j];
        }
    }

    return C;
}

getCoordSystem()

afw::coord::CoordSystem lsst::afw::image::Wcs::getCoordSystem ( ) const

inlineinherited

Definition at line 229 of file Wcs.h.

{ return _coordSystem; };

getEquinox()

double lsst::afw::image::Wcs::getEquinox ( ) const

inherited

Definition at line 789 of file Wcs.cc.

                             {
    if (_wcsInfo == nullptr) {
        return std::numeric_limits<double>::quiet_NaN();
    }
    return _wcsInfo->equinox;
}

getFitsMetadata()

virtual boost::shared_ptr< daf::base::PropertyList > lsst::meas::algorithms::BinnedWcs::getFitsMetadata ( ) const

inlinevirtual

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

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

Definition at line 65 of file BinnedWcs.h.

                                                             {
        notImplemented();
        return PTR(daf::base::PropertyList)(); // unreached
    }

getId()

dafBase::Citizen::memId lsst::daf::base::Citizen::getId ( ) const

inherited

Return the Citizen's ID.

Definition at line 224 of file Citizen.cc.

                                                {
    return _CitizenId;
}

getLinearTransform()

geom::LinearTransform lsst::afw::image::Wcs::getLinearTransform ( ) const

inherited

Return the linear part of the Wcs, the CD matrix in FITS-speak, as an AffineTransform.

Definition at line 916 of file Wcs.cc.

{ return geom::LinearTransform(getCDMatrix()); }

getNextMemId()

dafBase::Citizen::memId lsst::daf::base::Citizen::getNextMemId ( )

staticinherited

Return the memId of the next object to be allocated.

Definition at line 229 of file Citizen.cc.

                                                 {
    return _nextMemId();
}

getOriginalToBinned()

afw::geom::AffineTransform lsst::meas::algorithms::BinnedWcs::getOriginalToBinned ( ) const

inline

Definition at line 71 of file BinnedWcs.h.

{ return _originalToBinned; }

getParent()

boost::shared_ptr< afw::image::Wcs > lsst::meas::algorithms::BinnedWcs::getParent ( ) const

inline

Definition at line 51 of file BinnedWcs.h.

{ return _parent; }

getPersistenceName()

std::string lsst::afw::image::Wcs::getPersistenceName ( ) const

protectedvirtualinherited

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::table::io::Persistable.

Reimplemented in lsst::afw::image::TanWcs.

Definition at line 980 of file Wcs.cc.

{ return getWcsPersistenceName(); }

getPixelOrigin()

GeomPoint lsst::afw::image::Wcs::getPixelOrigin ( ) const

inherited

Returns CRPIX (corrected to LSST convention).

Definition at line 542 of file Wcs.cc.

                                    {
    assert(_wcsInfo);
    // Convert from fits units back to lsst units
    double p1 = _wcsInfo->crpix[0] + fitsToLsstPixels;
    double p2 = _wcsInfo->crpix[1] + fitsToLsstPixels;
    return geom::Point2D(p1, p2);
}

getPythonModule()

std::string lsst::afw::image::Wcs::getPythonModule ( ) const

protectedvirtualinherited

Return the fully-qualified Python module that should be imported to guarantee that its factory is registered.

Must be less than ArchiveIndexSchema::MAX_MODULE_LENGTH characters.

Will be ignored if empty.

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 982 of file Wcs.cc.

{ return "lsst.afw.image"; }

getSkyOrigin()

CoordPtr lsst::afw::image::Wcs::getSkyOrigin ( ) const

inherited

Returns CRVAL. This need not be the centre of the image.

Definition at line 537 of file Wcs.cc.

                                 {
    assert(_wcsInfo);
    return makeCorrectCoord(_wcsInfo->crval[0] * geom::degrees, _wcsInfo->crval[1] * geom::degrees);
}

getXBin()

unsigned int lsst::meas::algorithms::BinnedWcs::getXBin ( ) const

inline

Definition at line 52 of file BinnedWcs.h.

{ return _xBin; }

getXY0()

afw::geom::Point2I lsst::meas::algorithms::BinnedWcs::getXY0 ( ) const

inline

Definition at line 54 of file BinnedWcs.h.

{ return _xy0; }

getYBin()

unsigned int lsst::meas::algorithms::BinnedWcs::getYBin ( ) const

inline

Definition at line 53 of file BinnedWcs.h.

{ return _yBin; }

hasBeenCorrupted()

bool lsst::daf::base::Citizen::hasBeenCorrupted ( )

staticinherited

Check all allocated blocks for corruption.

Definition at line 353 of file Citizen.cc.

                                      {
    ReadGuard guard(citizenLock);
    for (table::iterator cur = _activeCitizens.begin();
         cur != _activeCitizens.end(); cur++) {
        if (cur->first->_hasBeenCorrupted()) {
            return true;
        }
    }
    for (table::iterator cur = _persistentCitizens.begin();
         cur != _persistentCitizens.end(); cur++) {
        if (cur->first->_hasBeenCorrupted()) {
            return true;
        }
    }

    return false;
}

hasDistortion()

virtual bool lsst::meas::algorithms::BinnedWcs::hasDistortion ( ) const

inlinevirtual

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

Definition at line 56 of file BinnedWcs.h.

{ return _parent->hasDistortion(); }

init()

int lsst::daf::base::Citizen::init ( )

staticinherited

Called once when the memory system is being initialised.

Definition at line 214 of file Citizen.cc.

                         {
    volatile int dummy = 1;
    return dummy;
}

initWcsLibFromFits()

void lsst::afw::image::Wcs::initWcsLibFromFits ( std::shared_ptr< lsst::daf::base::PropertySet const > const &  fitsMetadata )

protectedinherited

Parse a fits header, extract the relevant metadata and create a Wcs object.

Definition at line 160 of file Wcs.cc.

                                                                                  {
    /*
     * Access control for the input header
     *
     * We want to hack up the input, and in order to do so we need to do a deep copy on it.
     * We only want to do that copy once, and would like to avoid doing it altogether.
     */
    class HeaderAccess {
    public:
        // Return a readable version of the metadata
        std::shared_ptr<daf::base::PropertySet const> const& toRead() { return _constHeader; }
        // Return a writable version of the metadata
        std::shared_ptr<daf::base::PropertySet> const& toWrite() {
            if (!_hackHeader) {
                _hackHeader = _constHeader->deepCopy();
                _constHeader = _hackHeader;
            }
            return _hackHeader;
        }

        // Ctor
        HeaderAccess(std::shared_ptr<daf::base::PropertySet const> const& header)
                : _constHeader(header), _hackHeader() {}

    private:
        std::shared_ptr<daf::base::PropertySet const> _constHeader;
        std::shared_ptr<daf::base::PropertySet> _hackHeader;
    };

    HeaderAccess access(header);

    // Some headers (e.g. SDSS ones from FNAL) have EQUINOX as a string.  Fix this,
    // as wcslib 4.4.4 refuses to handle it.  Furthermore, some headers (e.g. Skymapper)
    // use a string but prepend 'J':  "J2000.0" -- if we don't handle this, we deduce
    // an equinox of 0.0
    {
        std::string const& key = "EQUINOX";
        if (access.toRead()->exists(key) && access.toRead()->typeOf(key) == typeid(std::string)) {
            auto equinoxStr = access.toRead()->getAsString(key).c_str();
            double equinox = ::atof(equinoxStr[0] == 'J' ? equinoxStr + 1 : equinoxStr);
            access.toWrite()->set(key, equinox);
        }
    }

    //Check header isn't empty
    int nCards = lsst::afw::formatters::countFitsHeaderCards(*(access.toRead()));
    if (nCards <= 0) {
        string msg = "Could not parse FITS WCS: no header cards found";
        throw LSST_EXCEPT(except::InvalidParameterError, msg);
    }

    // While the standard does not insist on CRVAL and CRPIX being present, it
    // is almost certain their absence indicates a problem.
    // Check for CRPIX
    if (!access.toRead()->exists("CRPIX1") && !access.toRead()->exists("CRPIX1a")) {
        string msg = "Neither CRPIX1 not CRPIX1a found";
        throw LSST_EXCEPT(except::InvalidParameterError, msg);
    }

    if (!access.toRead()->exists("CRPIX2") && !access.toRead()->exists("CRPIX2a")) {
        string msg = "Neither CRPIX2 not CRPIX2a found";
        throw LSST_EXCEPT(except::InvalidParameterError, msg);
    }

    // And the same for CRVAL
    if (!access.toRead()->exists("CRVAL1") && !access.toRead()->exists("CRVAL1a")) {
        string msg = "Neither CRVAL1 not CRVAL1a found";
        throw LSST_EXCEPT(except::InvalidParameterError, msg);
    }

    if (!access.toRead()->exists("CRVAL2") && !access.toRead()->exists("CRVAL2a")) {
        string msg = "Neither CRVAL2 not CRVAL2a found";
        throw LSST_EXCEPT(except::InvalidParameterError, msg);
    }
    /*
     * According to Greisen and Calabretta (A&A 395, 1061–1075 (2002)) it's illegal to mix PCi_j and CDi_j
     * headers; unfortunately Subaru puts both in its headers.  It actually uses PC001002 instead of PC1_2
     * (dating to a proposed FITS standard from 1996) and at least sometimes fails to include CDELT[12],
     * so the CD and PC matrices are inconsistent
     *
     * If we detect any part of a CD matrix, delete all PC matrices
     */
    if (access.toRead()->exists("CD1_1") || access.toRead()->exists("CD1_2") ||
        access.toRead()->exists("CD2_1") || access.toRead()->exists("CD2_2")) {
        for (int i = 1; i <= 2; ++i) {
            for (int j = 1; j <= 2; ++j) {
                std::string key = (boost::format("PC%i_%i") % j % i).str();
                if (access.toRead()->exists(key)) {
                    double const val = access.toRead()->getAsDouble(key);
                    access.toWrite()->remove(key);
                    access.toWrite()->add("X_" + key, val);
                }

                key = (boost::format("PC%03d%03d") % j % i).str();
                if (access.toRead()->exists(key)) {
                    double const val = access.toRead()->getAsDouble(key);
                    access.toWrite()->remove(key);
                    access.toWrite()->add("X_" + key, val);
                }
            }
        }
    }

    //Pass the header into wcslib's formatter to extract & setup the Wcs. First need
    //to convert to a C style string, so the compile doesn't complain about constness
    std::string metadataStr = formatters::formatFitsProperties(*(access.toRead()));
    // We own the data, and wcslib is slack about constness, so no qualms with casting away const
    char* hdrString = const_cast<char*>(metadataStr.c_str());
    // printf("wcspih string:\n%s\n", hdrString);

    nCards = formatters::countFitsHeaderCards(*(access.toRead()));  // we may have dropped some
    int pihStatus = wcspih(hdrString, nCards, _relax, _wcshdrCtrl, &_nReject, &_nWcsInfo, &_wcsInfo);

    if (pihStatus != 0) {
        throw LSST_EXCEPT(except::RuntimeError,
                          (boost::format("Could not parse FITS WCS: wcspih status = %d (%s)") % pihStatus %
                           wcs_errmsg[pihStatus])
                                  .str());
    }

    // Run wcsfix on _wcsInfo to try and fix any problems it knows about.
    const int* naxes = NULL;  // should be {NAXIS1, NAXIS2, ...} to check cylindrical projections
    int stats[NWCSFIX];       // status returns from wcsfix
    int fixStatus = wcsfix(_wcsfixCtrl, naxes, _wcsInfo, stats);
    if (fixStatus != 0) {
        std::stringstream errStream;
        errStream << "Could not parse FITS WCS: wcsfix failed " << std::endl;
        for (int ii = 0; ii < NWCSFIX; ++ii) {
            if (stats[ii] >= 0) {
                errStream << "\t" << ii << ": " << stats[ii] << " " << wcsfix_errmsg[stats[ii]] << std::endl;
            } else {
                errStream << "\t" << ii << ": " << stats[ii] << std::endl;
            }
        }
    }

    // The Wcs standard requires a default value for RADESYS if the keyword
    // doesn't exist in header, but wcslib doesn't set it. So we do so here. This code
    // conforms to Calabretta & Greisen 2002 \S 3.1
    if (!(access.toRead()->exists("RADESYS") || access.toRead()->exists("RADESYSa"))) {
        // If RADECSYS exists, use that (counter to Calabretta & Greisen 2002 \S 3.1, but commonly used).
        // If equinox exist and < 1984, use FK4. If >= 1984, use FK5
        if (access.toRead()->exists("RADECSYS")) {
            strncpy(_wcsInfo->radesys, access.toRead()->getAsString("RADECSYS").c_str(), STRLEN);
        } else if (access.toRead()->exists("EQUINOX") || access.toRead()->exists("EQUINOXa")) {
            std::string const EQUINOX = access.toRead()->exists("EQUINOX") ? "EQUINOX" : "EQUINOXa";
            double const equinox = access.toRead()->getAsDouble(EQUINOX);
            if (equinox < 1984) {
                strncpy(_wcsInfo->radesys, "FK4", STRLEN);
            } else {
                strncpy(_wcsInfo->radesys, "FK5", STRLEN);
            }
        } else {
            // If Equinox doesn't exist, default to ICRS
            strncpy(_wcsInfo->radesys, "ICRS", STRLEN);
        }
    }
    // strip trailing whitespace
    {
        for (int i = strlen(_wcsInfo->radesys) - 1; i >= 0; i--) {
            if (isspace(_wcsInfo->radesys[i])) {
                _wcsInfo->radesys[i] = '\0';
            }
        }
    }
    //
    // If there are no CDi_j cards in the header, set CDi_j from PCi_j
    // CDi_j == CDELTi*PCi_j
    //
    if ((_wcsInfo->altlin & 2) == 0) {  // no CDi_j cards were found in the header
        double const* cdelt = _wcsInfo->cdelt;
        double const* pc = _wcsInfo->pc;
        double* cd = _wcsInfo->cd;

        cd[0] = cdelt[0] * pc[0];  // 1_1
        cd[1] = cdelt[0] * pc[1];  // 1_2
        cd[2] = cdelt[1] * pc[2];  // 2_1
        cd[3] = cdelt[1] * pc[3];  // 2_2
    }
}

isFlipped()

bool lsst::afw::image::Wcs::isFlipped ( ) const

inherited

Does the Wcs follow the convention of North=Up, East=Left?

The conventional sense for a WCS image is to have North up and East to the left, or at least to be able to rotate the image to that orientation. It is possible to create a "flipped" WCS, where East points right when the image is rotated such that North is up. Flipping a WCS is akin to producing a mirror image. This function tests whether the image is flipped or not.

Definition at line 648 of file Wcs.cc.

                          {
    // We calculate the determinant of the CD (i.e the rotation and scaling)
    // matrix. If this determinant is positive, then the image can be rotated
    // to a position where increasing the right ascension and declination
    // increases the horizontal and vertical pixel position. In this case the
    // image is flipped.
    assert(_wcsInfo);
    double det = (_wcsInfo->cd[0] * _wcsInfo->cd[3]) - (_wcsInfo->cd[1] * _wcsInfo->cd[2]);

    if (det == 0) {
        throw(LSST_EXCEPT(except::RuntimeError, "Wcs CD matrix is singular"));
    }

    return (det > 0);
}

isPersistable()

virtual bool lsst::meas::algorithms::BinnedWcs::isPersistable ( ) const

inlinevirtual

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

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

Definition at line 57 of file BinnedWcs.h.

{ return false; }

isSameSkySystem()

bool lsst::afw::image::Wcs::isSameSkySystem ( Wcs const &  wcs ) const

inherited

Return true if a WCS has the same coordinate system and equinox as this one.

There are two special cases:

• Equinox is ignored if the coordinate system is ICRS
• FK5 J2000 is considered the same as ICRS

Definition at line 796 of file Wcs.cc.

                                              {
    if (_isIcrs() && wcs._isIcrs()) {
        return true;
    }
    return (getCoordSystem() == wcs.getCoordSystem()) && (getEquinox() == wcs.getEquinox());
}

linearizePixelToSky() [1/2]

geom::AffineTransform lsst::afw::image::Wcs::linearizePixelToSky ( coord::Coord const &  coord, geom::AngleUnit  skyUnit = geom::degrees  ) const

inherited

Return the local linear approximation to Wcs::pixelToSky at a point given in sky coordinates.

The local linear approximation is defined such the following is true (ignoring floating-point errors):

wcs.linearizePixelToSky(sky, skyUnit)(wcs.skyToPixel(sky)) == sky.getPosition(skyUnit);

(recall that AffineTransform::operator() is matrix multiplication with the augmented point (x,y,1)).

This is currently implemented as a numerical derivative, but we should specialise the Wcs class (or rather its implementation) to handle "simple" cases such as TAN-SIP analytically

Parameters

[in]	coord	Position in sky coordinates where transform is desired.
[in]	skyUnit	Units to use for sky coordinates; units of matrix elements will be skyUnits/pixel.

Definition at line 868 of file Wcs.cc.

                                                                                                 {
    return linearizePixelToSkyInternal(skyToPixel(coord), coord, skyUnit);
}

linearizePixelToSky() [2/2]

geom::AffineTransform lsst::afw::image::Wcs::linearizePixelToSky ( geom::Point2D const &  pix, geom::AngleUnit  skyUnit = geom::degrees  ) const

inherited

Return the local linear approximation to Wcs::pixelToSky at a point given in pixel coordinates.

The local linear approximation is defined such the following is true (ignoring floating-point errors):

wcs.linearizePixelToSky(pix, skyUnit)(pix) == wcs.pixelToSky(pix).getPosition(skyUnit)

(recall that AffineTransform::operator() is matrix multiplication with the augmented point (x,y,1)).

This is currently implemented as a numerical derivative, but we should specialise the Wcs class (or rather its implementation) to handle "simple" cases such as TAN-SIP analytically

Parameters

[in]	pix	Position in pixel coordinates where transform is desired.
[in]	skyUnit	Units to use for sky coordinates; units of matrix elements will be skyUnits/pixel.

Definition at line 871 of file Wcs.cc.

                                                                                              {
    return linearizePixelToSkyInternal(pix, *pixelToSky(pix), skyUnit);
}

linearizePixelToSkyInternal()

geom::AffineTransform lsst::afw::image::Wcs::linearizePixelToSkyInternal ( geom::Point2D const &  pix, coord::Coord const &  coord, geom::AngleUnit  skyUnit  ) const

protectedvirtualinherited

Implementation for the overloaded public linearizePixelToSky methods, requiring both a pixel coordinate and the corresponding sky coordinate.

Definition at line 875 of file Wcs.cc.

                                                                                    {
    //
    // Figure out the (0, 0), (0, 1), and (1, 0) ra/dec coordinates of the corners of a square drawn in pixel
    // It'd be better to centre the square at sky00, but that would involve another conversion between sky and
    // pixel coordinates so I didn't bother
    //
    const double side = 10;  // length of the square's sides in pixels
    GeomPoint const sky00 = coord.getPosition(skyUnit);
    typedef std::pair<geom::Angle, geom::Angle> AngleAngle;
    AngleAngle const dsky10 = coord.getTangentPlaneOffset(*pixelToSky(pix00 + geom::Extent2D(side, 0)));
    AngleAngle const dsky01 = coord.getTangentPlaneOffset(*pixelToSky(pix00 + geom::Extent2D(0, side)));

    Eigen::Matrix2d m;
    m(0, 0) = dsky10.first.asAngularUnits(skyUnit) / side;
    m(0, 1) = dsky01.first.asAngularUnits(skyUnit) / side;
    m(1, 0) = dsky10.second.asAngularUnits(skyUnit) / side;
    m(1, 1) = dsky01.second.asAngularUnits(skyUnit) / side;

    Eigen::Vector2d sky00v;
    sky00v << sky00.getX(), sky00.getY();
    Eigen::Vector2d pix00v;
    pix00v << pix00.getX(), pix00.getY();
    // return geom::AffineTransform(m, geom::Extent2D(sky00v - m * pix00v));
    return geom::AffineTransform(m, (sky00v - m * pix00v));
}

linearizeSkyToPixel() [1/2]

geom::AffineTransform lsst::afw::image::Wcs::linearizeSkyToPixel ( coord::Coord const &  coord, geom::AngleUnit  skyUnit = geom::degrees  ) const

inherited

Return the local linear approximation to Wcs::skyToPixel at a point given in sky coordinates.

The local linear approximation is defined such the following is true (ignoring floating-point errors):

wcs.linearizeSkyToPixel(sky, skyUnit)(sky.getPosition(skyUnit)) == wcs.skyToPixel(sky)

(recall that AffineTransform::operator() is matrix multiplication with the augmented point (x,y,1)).

This is currently implemented as a numerical derivative, but we should specialise the Wcs class (or rather its implementation) to handle "simple" cases such as TAN-SIP analytically

Parameters

[in]	coord	Position in sky coordinates where transform is desired.
[in]	skyUnit	Units to use for sky coordinates; units of matrix elements will be pixels/skyUnit.

Definition at line 902 of file Wcs.cc.

                                                                                                 {
    return linearizeSkyToPixelInternal(skyToPixel(coord), coord, skyUnit);
}

linearizeSkyToPixel() [2/2]

geom::AffineTransform lsst::afw::image::Wcs::linearizeSkyToPixel ( geom::Point2D const &  pix, geom::AngleUnit  skyUnit = geom::degrees  ) const

inherited

Return the local linear approximation to Wcs::skyToPixel at a point given in pixel coordinates.

The local linear approximation is defined such the following is true (ignoring floating-point errors):

wcs.linearizeSkyToPixel(pix, skyUnit)(wcs.pixelToSky(pix).getPosition(skyUnit)) == pix

(recall that AffineTransform::operator() is matrix multiplication with the augmented point (x,y,1)).

This is currently implemented as a numerical derivative, but we should specialise the Wcs class (or rather its implementation) to handle "simple" cases such as TAN-SIP analytically

Parameters

[in]	pix	Position in pixel coordinates where transform is desired.
[in]	skyUnit	Units to use for sky coordinates; units of matrix elements will be pixels/skyUnit.

Definition at line 906 of file Wcs.cc.

                                                                                              {
    return linearizeSkyToPixelInternal(pix, *pixelToSky(pix), skyUnit);
}

linearizeSkyToPixelInternal()

geom::AffineTransform lsst::afw::image::Wcs::linearizeSkyToPixelInternal ( geom::Point2D const &  pix, coord::Coord const &  coord, geom::AngleUnit  skyUnit  ) const

protectedvirtualinherited

Implementation for the overloaded public linearizeSkyToPixel methods, requiring both a pixel coordinate and the corresponding sky coordinate.

Definition at line 910 of file Wcs.cc.

                                                                                    {
    geom::AffineTransform inverse = linearizePixelToSkyInternal(pix00, coord, skyUnit);
    return inverse.invert();
}

makeCorrectCoord()

CoordPtr lsst::afw::image::Wcs::makeCorrectCoord ( geom::Angle  sky0, geom::Angle  sky1  ) const

protectedinherited

Given a sky position, use the values stored in ctype and radesys to return the correct sub-class of Coord.

Definition at line 846 of file Wcs.cc.

                                                                   {
    auto coordSystem = getCoordSystem();
    if ((coordSystem == coord::ICRS) || (coordSystem == coord::GALACTIC)) {
        // equinox not relevant
        if (_skyAxesSwapped) {
            return coord::makeCoord(coordSystem, sky1, sky0);
        } else {
            return coord::makeCoord(coordSystem, sky0, sky1);
        }
    } else if ((coordSystem == coord::FK5) || (coordSystem == coord::ECLIPTIC)) {
        if (_skyAxesSwapped) {
            return coord::makeCoord(coordSystem, sky1, sky0, _wcsInfo->equinox);
        } else {
            return coord::makeCoord(coordSystem, sky0, sky1, _wcsInfo->equinox);
        }
    }
    throw LSST_EXCEPT(
            except::RuntimeError,
            (boost::format("Can't create Coord object: Unrecognised coordinate system %s") % coordSystem)
                    .str());
}

markPersistent()

void lsst::daf::base::Citizen::markPersistent ( void  )

inherited

Mark a Citizen as persistent and not destroyed until process end.

Definition at line 254 of file Citizen.cc.

                                        {
    WriteGuard guard(citizenLock);
    _persistentCitizens[this] = _activeCitizens[this];
    _activeCitizens.erase(this);
}

notImplemented()

void lsst::meas::algorithms::BinnedWcs::notImplemented ( ) const

inlineprivate

Definition at line 78 of file BinnedWcs.h.

                                {
        throw LSST_EXCEPT(NotImplementedException, "Feature has not been implemented");
    }

operator!=()

bool lsst::afw::image::Wcs::operator!= ( Wcs const &  other ) const

inlineinherited

Definition at line 141 of file Wcs.h.

{ return !(*this == other); }

operator==()

bool lsst::afw::image::Wcs::operator== ( Wcs const &  other ) const

inherited

Definition at line 468 of file Wcs.cc.

                                           {
    if (&other == this) return true;
    // We do a bidirectional test with a virtual member function in case one of us is a derived
    // class with members we don't know about here.
    // This is not the most efficient possible implementation, but I think it's the easiest one
    // with which to ensure correctness, and I think that's more important in this case.
    return this->_isSubset(other) && other._isSubset(*this);
}

pixArea()

double lsst::afw::image::Wcs::pixArea ( lsst::afw::geom::Point2D  pix00 ) const

inherited

Sky area covered by a pixel at position pix00 in units of square degrees.

Parameters

pix00

The pixel point where the area is desired

Definition at line 666 of file Wcs.cc.

                                         {
    //
    // Figure out the (0, 0), (0, 1), and (1, 0) ra/dec coordinates of the corners of a square drawn in pixel
    // It'd be better to centre the square at sky00, but that would involve another conversion between sky and
    // pixel coordinates so I didn't bother
    //
    const double side = 1;  // length of the square's sides in pixels

    // Work in 3-space to avoid RA wrapping and pole issues.
    geom::Point3D v0 = pixelToSky(pix00)->getVector();

    // Step by "side" in x and y pixel directions...
    GeomPoint px(pix00);
    GeomPoint py(pix00);
    px.shift(geom::Extent2D(side, 0));
    py.shift(geom::Extent2D(0, side));
    // Push the points through the WCS, and find difference in 3-space.
    geom::Extent3D dx = pixelToSky(px)->getVector() - v0;
    geom::Extent3D dy = pixelToSky(py)->getVector() - v0;

    // Compute |cross product| = area of parallelogram with sides dx,dy
    // FIXME -- this is slightly incorrect -- it's making the small-angle
    // approximation, taking the distance *through* the unit sphere
    // rather than over its surface.
    // This is in units of ~radians^2
    double area = sqrt(square(dx[1] * dy[2] - dx[2] * dy[1]) + square(dx[2] * dy[0] - dx[0] * dy[2]) +
                       square(dx[0] * dy[1] - dx[1] * dy[0]));

    return area / square(side) * square(180. / geom::PI);
}

pixelScale()

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

inherited

Returns the pixel scale [Angle/pixel].

Definition at line 697 of file Wcs.cc.

{ return sqrt(pixArea(getPixelOrigin())) * geom::degrees; }

pixelToSky() [1/3]

CoordPtr lsst::afw::image::Wcs::pixelToSky ( double  pix1, double  pix2  ) const

inherited

Convert from pixel position to sky coordinates (e.g.

RA/dec)

Convert a pixel position (e.g. x,y) to a celestial coordinate (e.g. RA/dec). The output coordinate system depends on the values of CTYPE used to construct the object. For RA/dec, the CTYPES should be RA—TAN and DEC–TAN.

Definition at line 827 of file Wcs.cc.

                                                           {
    assert(_wcsInfo);

    geom::Angle skyTmp[2];
    pixelToSkyImpl(pixel1, pixel2, skyTmp);
    return makeCorrectCoord(skyTmp[0], skyTmp[1]);
}

pixelToSky() [2/3]

CoordPtr lsst::afw::image::Wcs::pixelToSky ( lsst::afw::geom::Point2D const &  pixel ) const

inherited

Convert from pixel position to sky coordinates (e.g.

RA/dec)

Convert a pixel position (e.g. x,y) to a celestial coordinate (e.g. RA/dec). The output coordinate system depends on the values of CTYPE used to construct the object. For RA/dec, the CTYPES should be RA—TAN and DEC–TAN.

Definition at line 825 of file Wcs.cc.

{ return pixelToSky(pixel.getX(), pixel.getY()); }

pixelToSky() [3/3]

void lsst::afw::image::Wcs::pixelToSky ( double  pixel1, double  pixel2, geom::Angle &  sky1, geom::Angle &  sky2  ) const

inherited

Convert from pixel position to sky coordinates (e.g.

RA/dec)

Note

This routine is designed for the knowledgeable user in need of performance; it's safer to call the version that returns a std::shared_ptr<Coord>.

Definition at line 835 of file Wcs.cc.

                                                                                         {
    geom::Angle skyTmp[2];
    // HACK -- we shouldn't need to initialize these -- pixelToSkyImpl() sets them unless an
    // exception is thrown -- but be safe.
    skyTmp[0] = 0. * geom::radians;
    skyTmp[1] = 0. * geom::radians;
    pixelToSkyImpl(pixel1, pixel2, skyTmp);
    sky1 = skyTmp[0];
    sky2 = skyTmp[1];
}

pixelToSkyImpl()

void lsst::meas::algorithms::BinnedWcs::pixelToSkyImpl ( double  pixel1, double  pixel2, afw::geom::Angle  skyTmp[2]  ) const

protectedvirtual

Worker routine for pixelToSky.

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

Definition at line 48 of file BinnedWcs.cc.

{
    PTR(afw::coord::Coord) coord = _parent->pixelToSky(_binnedToOriginal(afw::geom::Point2D(x, y)));
    skyTmp[0] = coord->getLongitude();
    skyTmp[1] = coord->getLatitude();
}

readFits() [1/3]

static std::shared_ptr<Wcs > lsst::afw::table::io::PersistableFacade< Wcs >::readFits ( fits::Fits &  fitsfile )

inlinestaticinherited

Read an object from an already open FITS object.

Parameters

[in]

fitsfile

FITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

                                                         {
        return std::dynamic_pointer_cast<T>(Persistable::_readFits(fitsfile));
    }

readFits() [2/3]

static std::shared_ptr<Wcs > lsst::afw::table::io::PersistableFacade< Wcs >::readFits ( std::string const &  fileName, int  hdu = fits::DEFAULT_HDU  )

inlinestaticinherited

Read an object from a regular FITS file.

Parameters

[in]	fileName	Name of the file to read.
[in]	hdu	HDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 194 of file Persistable.h.

                                                                                           {
        return std::dynamic_pointer_cast<T>(Persistable::_readFits(fileName, hdu));
    }

readFits() [3/3]

static std::shared_ptr<Wcs > lsst::afw::table::io::PersistableFacade< Wcs >::readFits ( fits::MemFileManager &  manager, int  hdu = fits::DEFAULT_HDU  )

inlinestaticinherited

Read an object from a FITS file in memory.

Parameters

[in]	manager	Manager for the memory to read from.
[in]	hdu	HDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 205 of file Persistable.h.

                                                                                             {
        return std::dynamic_pointer_cast<T>(Persistable::_readFits(manager, hdu));
    }

repr()

std::string lsst::daf::base::Citizen::repr ( ) const

inherited

Return a string representation of a Citizen.

Definition at line 245 of file Citizen.cc.

                                     {
    return boost::str(boost::format("%d: %08x %s")
                      % _CitizenId
                      % this
                      % lsst::utils::demangleType(_typeName)
                     );
}

rotateImageBy90()

virtual void lsst::meas::algorithms::BinnedWcs::rotateImageBy90 ( int  nQuarter, afw::geom::Extent2I  dimensions  ) const

inlinevirtual

Rotate image by nQuarter times 90 degrees.

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

Definition at line 62 of file BinnedWcs.h.

                                                                                 {
        notImplemented();
    }

serialize()

template<class Archive >

void lsst::daf::base::Persistable::serialize ( Archive &  , unsigned int  const  )

inlineinherited

Template boost::serialization function for the base class.

Doesn't actually do anything, since there is no data associated with the base. Inline to allow expansion wherever needed.

Definition at line 86 of file Persistable.h.

{ }

setCorruptionCallback()

dafBase::Citizen::memCallback lsst::daf::base::Citizen::setCorruptionCallback ( Citizen::memCallback  func )

staticinherited

Set the CorruptionCallback function.

Parameters

func	function be called when block is found to be corrupted

Definition at line 432 of file Citizen.cc.

                                                     {
    Citizen::memCallback old = _corruptionCallback;
    _corruptionCallback = func;

    return old;
}

setDeleteCallback()

dafBase::Citizen::memCallback lsst::daf::base::Citizen::setDeleteCallback ( Citizen::memCallback  func )

staticinherited

Set the DeleteCallback function.

Parameters

func	function be called when desired block is deleted

Definition at line 422 of file Citizen.cc.

      {
    Citizen::memCallback old = _deleteCallback;
    _deleteCallback = func;

    return old;
}

setDeleteCallbackId()

dafBase::Citizen::memId lsst::daf::base::Citizen::setDeleteCallbackId ( Citizen::memId  id )

staticinherited

Call the current DeleteCallback when block is deleted.

Parameters

id	Desired ID

Definition at line 387 of file Citizen.cc.

      {
    WriteGuard guard(citizenLock);
    Citizen::memId oldId = _deleteId;
    _deleteId = id;

    return oldId;
}

setNewCallback()

dafBase::Citizen::memNewCallback lsst::daf::base::Citizen::setNewCallback ( Citizen::memNewCallback  func )

staticinherited

Set the NewCallback function.

Parameters

func	The new function to be called when a designated block is allocated

Definition at line 412 of file Citizen.cc.

      {
    Citizen::memNewCallback old = _newCallback;
    _newCallback = func;

    return old;
}

setNewCallbackId()

dafBase::Citizen::memId lsst::daf::base::Citizen::setNewCallbackId ( Citizen::memId  id )

staticinherited

Call the NewCallback when block is allocated.

Parameters

id	Desired ID

Definition at line 376 of file Citizen.cc.

      {
    WriteGuard guard(citizenLock);
    Citizen::memId oldId = _newId;
    _newId = id;

    return oldId;
}

shiftReferencePixel() [1/2]

void lsst::afw::image::Wcs::shiftReferencePixel ( double  dx, double  dy  )

virtualinherited

Move the pixel reference position by (dx, dy)

Used when persisting and retrieving sub-images. The LSST convention is that Wcs returns pixel position (which is based on position in the parent image), but the FITS convention is to return pixel index (which is bases on position in the sub-image). In order that the FITS files we create make sense to other FITS viewers, we change to the FITS convention when writing out images.

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

Definition at line 1057 of file Wcs.cc.

                                                  {
    assert(_wcsInfo);
    _wcsInfo->crpix[0] += dx;
    _wcsInfo->crpix[1] += dy;

    // tells libwcs to invalidate cached data, since transformation has been modified
    _wcsInfo->flag = 0;
}

shiftReferencePixel() [2/2]

virtual void lsst::afw::image::Wcs::shiftReferencePixel ( geom::Extent2D const &  d )

inlinevirtualinherited

Definition at line 333 of file Wcs.h.

{ shiftReferencePixel(d.getX(), d.getY()); }

skyToIntermediateWorldCoord()

GeomPoint lsst::afw::image::Wcs::skyToIntermediateWorldCoord ( coord::Coord const &  coord ) const

inherited

Convert from sky coordinates (e.g.

RA/dec) to intermediate world coordinates

Intermediate world coordinates are in DEGREES.

Definition at line 747 of file Wcs.cc.

                                                                        {
    assert(_wcsInfo);

    std::shared_ptr<coord::Coord> sky = convertCoordToSky(coord);
    double skyTmp[2];
    double imgcrd[2];
    double phi, theta;
    double pixTmp[2];

    /*
     printf("skyToIWC: _coordSystem = %i\n", (int)_coordSystem);
     printf("coord (%.3f, %.3f)\n", coord->getLongitude().asDegrees(), coord->getLatitude().asDegrees());
     printf("->sky (%.3f, %.3f)\n", sky->getLongitude().asDegrees(), sky->getLatitude().asDegrees());
     */

    skyTmp[_wcsInfo->lng] = sky->getLongitude().asDegrees();
    skyTmp[_wcsInfo->lat] = sky->getLatitude().asDegrees();

    // Estimate pixel coordinates
    int stat[1];
    int status = 0;
    imgcrd[0] = imgcrd[1] = -1e6;
    /*
     printf("  skyTmp[] = (%.3f, %.3f)\n", skyTmp[0], skyTmp[1]);
     printf("  _wcsInfo->lng,lat = %i, %i\n", _wcsInfo->lng, _wcsInfo->lat);
     */
    status = wcss2p(_wcsInfo, 1, 2, skyTmp, &phi, &theta, imgcrd, pixTmp, stat);
    if (status > 0) {
        throw LSST_EXCEPT(except::RuntimeError,
                          (boost::format("Error: wcslib returned a status code of %d at sky %s, %s deg: %s") %
                           status % skyTmp[0] % skyTmp[1] % wcs_errmsg[status])
                                  .str());
    }
    /*
     printf("->iwc (%.3f, %.3f)\n", imgcrd[0], imgcrd[1]);
     printf("-> pix (%.2f, %.2f)\n", pixTmp[0], pixTmp[1]);
     std::shared_ptr<coord::Coord> crval = getSkyOrigin();
     printf("(crval is (%.3f, %.3f))\n", crval->getLongitude().asDegrees(), crval->getLatitude().asDegrees());
     */
    return GeomPoint(imgcrd[0], imgcrd[1]);
}

skyToPixel() [1/2]

GeomPoint lsst::afw::image::Wcs::skyToPixel ( geom::Angle  sky1, geom::Angle  sky2  ) const

inherited

Convert from sky coordinates (e.g.

RA/dec) to pixel positions

Convert a sky position (e.g. RA/dec) to a pixel position. The exact meaning of sky1, sky2 and the return value depend on the properties of the wcs (i.e. the values of CTYPE1 and CTYPE2), but the inputs are usually RA/dec. The outputs are x and y pixel position.

ASSUMES the angles are in the appropriate coordinate system for this Wcs.

Definition at line 745 of file Wcs.cc.

{ return skyToPixelImpl(sky1, sky2); }

skyToPixel() [2/2]

GeomPoint lsst::afw::image::Wcs::skyToPixel ( coord::Coord const &  coord ) const

inherited

Convert from sky coordinates (e.g. RA/dec) to pixel positions.

Definition at line 736 of file Wcs.cc.

                                                       {
    std::shared_ptr<coord::Coord> sky = convertCoordToSky(coord);
    return skyToPixelImpl(sky->getLongitude(), sky->getLatitude());
}

skyToPixelImpl()

afw::geom::Point2D lsst::meas::algorithms::BinnedWcs::skyToPixelImpl ( afw::geom::Angle  sky1, afw::geom::Angle  sky2  ) const

protectedvirtual

Worker routine for skyToPixel.

Parameters

sky1	RA (or, more generally, longitude)
sky2	Dec (or latitude)

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

Definition at line 55 of file BinnedWcs.cc.

{
    return _originalToBinned(_parent->skyToPixel(*makeCorrectCoord(sky1, sky2)));
}

upcast()

boost::shared_ptr< afw::image::Wcs > lsst::meas::algorithms::BinnedWcs::upcast ( )

inline

Definition at line 49 of file BinnedWcs.h.

{ return shared_from_this(); }

write()

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

protectedvirtualinherited

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::table::io::Persistable.

Reimplemented in lsst::afw::image::TanWcs.

Definition at line 984 of file Wcs.cc.

                                                 {
    WcsPersistenceHelper const& keys = WcsPersistenceHelper::get();
    afw::table::BaseCatalog catalog = handle.makeCatalog(keys.schema);
    std::shared_ptr<afw::table::BaseRecord> record = catalog.addNew();
    record->set(keys.crval.getX(), _wcsInfo[0].crval[0]);
    record->set(keys.crval.getY(), _wcsInfo[0].crval[1]);
    record->set(keys.crpix, getPixelOrigin());
    Eigen::Matrix2d cdIn = getCDMatrix();
    Eigen::Map<Eigen::Matrix2d> cdOut((*record)[keys.cd].getData());
    cdOut = cdIn;
    record->set(keys.ctype1, std::string(_wcsInfo[0].ctype[0]));
    record->set(keys.ctype2, std::string(_wcsInfo[0].ctype[1]));
    record->set(keys.equinox, _wcsInfo[0].equinox);
    record->set(keys.radesys, std::string(_wcsInfo[0].radesys));
    record->set(keys.cunit1, std::string(_wcsInfo[0].cunit[0]));
    record->set(keys.cunit2, std::string(_wcsInfo[0].cunit[1]));
    handle.saveCatalog(catalog);
}

writeFits() [1/3]

void lsst::afw::table::io::Persistable::writeFits ( std::string const &  fileName, std::string const &  mode = "w"  ) const

inherited

Write the object to a regular FITS file.

Parameters

[in]	fileName	Name of the file to write to.
[in]	mode	If "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

writeFits() [2/3]

void lsst::afw::table::io::Persistable::writeFits ( fits::MemFileManager &  manager, std::string const &  mode = "w"  ) const

inherited

Write the object to a FITS image in memory.

Parameters

[in]	manager	Name of the file to write to.
[in]	mode	If "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

writeFits() [3/3]

void lsst::afw::table::io::Persistable::writeFits ( fits::Fits &  fitsfile ) const

inherited

Write the object to an already-open FITS object.

Parameters

[in]

fitsfile

Open FITS object to write to.

Member Data Documentation

_binnedToOriginal

afw::geom::AffineTransform const lsst::meas::algorithms::BinnedWcs::_binnedToOriginal

private

Definition at line 84 of file BinnedWcs.h.

_coordSystem

coord::CoordSystem lsst::afw::image::Wcs::_coordSystem

protectedinherited

Definition at line 452 of file Wcs.h.

_nReject

int lsst::afw::image::Wcs::_nReject

protectedinherited

Definition at line 451 of file Wcs.h.

_nWcsInfo

int lsst::afw::image::Wcs::_nWcsInfo

protectedinherited

Definition at line 447 of file Wcs.h.

_originalToBinned

afw::geom::AffineTransform const lsst::meas::algorithms::BinnedWcs::_originalToBinned

private

Definition at line 84 of file BinnedWcs.h.

_parent

boost::shared_ptr< afw::image::Wcs > const lsst::meas::algorithms::BinnedWcs::_parent

private

Definition at line 81 of file BinnedWcs.h.

_relax

int lsst::afw::image::Wcs::_relax

protectedinherited

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

Definition at line 448 of file Wcs.h.

_skyAxesSwapped

bool lsst::afw::image::Wcs::_skyAxesSwapped

protectedinherited

if true then the sky axes are swapped

Definition at line 453 of file Wcs.h.

_wcsfixCtrl

int lsst::afw::image::Wcs::_wcsfixCtrl

protectedinherited

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

Definition at line 449 of file Wcs.h.

_wcshdrCtrl

int lsst::afw::image::Wcs::_wcshdrCtrl

protectedinherited

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

Definition at line 450 of file Wcs.h.

_wcsInfo

struct wcsprm* lsst::afw::image::Wcs::_wcsInfo

protectedinherited

Definition at line 446 of file Wcs.h.

_xBin

unsigned int const lsst::meas::algorithms::BinnedWcs::_xBin

private

Definition at line 82 of file BinnedWcs.h.

_xy0

afw::geom::Point2I const lsst::meas::algorithms::BinnedWcs::_xy0

private

Definition at line 83 of file BinnedWcs.h.

_yBin

unsigned int const lsst::meas::algorithms::BinnedWcs::_yBin

private

Definition at line 82 of file BinnedWcs.h.

---

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

• /home/jenkins-slave/snowflake/release/lsstsw/stack/Linux64/meas_algorithms/14.0-14-gbf7a6f8a/include/lsst/meas/algorithms/BinnedWcs.h
• /home/jenkins-slave/snowflake/release/lsstsw/stack/Linux64/meas_algorithms/14.0-14-gbf7a6f8a/src/BinnedWcs.cc