lsst::meas::algorithms::CoaddPsf Class Reference

CoaddPsf is the Psf derived to be used for non-PSF-matched Coadd images. More...

#include <CoaddPsf.h>

Inheritance diagram for lsst::meas::algorithms::CoaddPsf:

Classes
class	Factory

Public Member Functions
	CoaddPsf (afw::table::ExposureCatalog const &catalog, afw::image::Wcs const &coaddWcs, std::string const &weightFieldName="weight", std::string const &warpingKernelName="lanczos3", int cacheSize=10000)
	Main constructors for CoaddPsf. More...
virtual boost::shared_ptr < afw::detection::Psf >	clone () const
	Polymorphic deep copy. Usually unnecessary, as Psfs are immutable. More...
virtual afw::geom::Point2D	getAveragePosition () const
	Return the average of the positions of the stars that went into this Psf. More...
boost::shared_ptr < afw::image::Wcs const >	getCoaddWcs ()
	Return the Wcs of the coadd (defines the coordinate system of the Psf). More...
int	getComponentCount () const
	Return the number of component Psfs in this CoaddPsf. More...
boost::shared_ptr < afw::detection::Psf const >	getPsf (int index)
boost::shared_ptr < afw::image::Wcs const >	getWcs (int index)
double	getWeight (int index)
afw::table::RecordId	getId (int index)
afw::geom::Box2I	getBBox (int index)
boost::shared_ptr < afw::geom::polygon::Polygon const >	getValidPolygon (int index)
virtual bool	isPersistable () const
	Return true if the CoaddPsf persistable (always true). More...
Public Member Functions inherited from lsst::afw::detection::Psf
virtual	~Psf ()
boost::shared_ptr< Image >	computeImage (geom::Point2D position=makeNullPoint(), image::Color color=image::Color(), ImageOwnerEnum owner=COPY) const
	Return an Image of the PSF, in a form that can be compared directly with star images. More...
boost::shared_ptr< Image >	computeKernelImage (geom::Point2D position=makeNullPoint(), image::Color color=image::Color(), ImageOwnerEnum owner=COPY) const
	Return an Image of the PSF, in a form suitable for convolution. More...
double	computePeak (geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const
	Return the peak value of the PSF image. More...
double	computeApertureFlux (double radius, geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const
	Compute the "flux" of the Psf model within a circular aperture of the given radius. More...
geom::ellipses::Quadrupole	computeShape (geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const
	Compute the ellipse corresponding to the second moments of the Psf. More...
boost::shared_ptr < math::Kernel const >	getLocalKernel (geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const
	Return a FixedKernel corresponding to the Psf image at the given point. More...
image::Color	getAverageColor () const
	Return the average Color of the stars used to construct the Psf. More...
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::daf::base::Persistable
	Persistable (void)
virtual	~Persistable (void)
template<class Archive >
void	serialize (Archive &, unsigned int const)
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 ()

Protected Member Functions
boost::shared_ptr < afw::detection::Psf::Image >	doComputeKernelImage (afw::geom::Point2D const &ccdXY, afw::image::Color const &color) const
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...
	CoaddPsf (afw::table::ExposureCatalog const &catalog, boost::shared_ptr< afw::image::Wcs const > coaddWcs, afw::geom::Point2D const &averagePosition, std::string const &warpingKernelName="lanczos3", int cacheSize=10000)
Protected Member Functions inherited from lsst::meas::algorithms::ImagePsf
	ImagePsf (bool isFixed=false)
virtual double	doComputeApertureFlux (double radius, afw::geom::Point2D const &position, afw::image::Color const &color) const
virtual afw::geom::ellipses::Quadrupole	doComputeShape (afw::geom::Point2D const &position, afw::image::Color const &color) const
Protected Member Functions inherited from lsst::afw::detection::Psf
	Psf (bool isFixed=false)
Protected Member Functions inherited from lsst::afw::table::io::Persistable
	Persistable ()
	Persistable (Persistable const &other)
void	operator= (Persistable const &other)

Private Attributes
afw::table::ExposureCatalog	_catalog
boost::shared_ptr < afw::image::Wcs const >	_coaddWcs
afw::table::Key< double >	_weightKey
afw::geom::Point2D	_averagePosition
std::string	_warpingKernelName
boost::shared_ptr < afw::math::WarpingControl const >	_warpingControl

Additional Inherited Members
Public Types inherited from lsst::afw::detection::Psf
enum	ImageOwnerEnum { COPY =0, INTERNAL =1 }
	Enum passed to computeImage and computeKernelImage to determine image ownership. More...
typedef boost::shared_ptr< Psf >	Ptr
typedef boost::shared_ptr < const Psf >	ConstPtr
typedef math::Kernel::Pixel	Pixel
	Pixel type of Image returned by computeImage. More...
typedef image::Image< Pixel >	Image
	Image type returned by computeImage. More...
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 Types inherited from lsst::daf::base::Persistable
typedef boost::shared_ptr < Persistable >	Ptr
Static Public Member Functions inherited from lsst::afw::table::io::PersistableFacade< CoaddPsf >
static boost::shared_ptr < CoaddPsf >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object. More...
static boost::shared_ptr < CoaddPsf >	readFits (std::string const &fileName, int hdu=0)
	Read an object from a regular FITS file. More...
static boost::shared_ptr < CoaddPsf >	readFits (fits::MemFileManager &manager, int hdu=0)
	Read an object from a FITS file in memory. More...
Static Public Member Functions inherited from lsst::afw::table::io::PersistableFacade< ImagePsf >
static boost::shared_ptr < ImagePsf >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object. More...
static boost::shared_ptr < ImagePsf >	readFits (std::string const &fileName, int hdu=0)
	Read an object from a regular FITS file. More...
static boost::shared_ptr < ImagePsf >	readFits (fits::MemFileManager &manager, int hdu=0)
	Read an object from a FITS file in memory. More...
Static Public Member Functions inherited from lsst::afw::detection::Psf
static boost::shared_ptr< Image >	recenterKernelImage (boost::shared_ptr< Image > im, geom::Point2D const &position, std::string const &warpAlgorithm="lanczos5", unsigned int warpBuffer=5)
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< Psf >
static boost::shared_ptr< Psf >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object. More...
static boost::shared_ptr< Psf >	readFits (std::string const &fileName, int hdu=0)
	Read an object from a regular FITS file. More...
static boost::shared_ptr< Psf >	readFits (fits::MemFileManager &manager, int hdu=0)
	Read an object from a FITS file in memory. More...
Protected Types inherited from lsst::afw::table::io::Persistable
typedef io::OutputArchiveHandle	OutputArchiveHandle

Detailed Description

CoaddPsf is the Psf derived to be used for non-PSF-matched Coadd images.

It incorporates the logic of James Jee's Stackfit algorithm for estimating the Psf of coadd by coadding the images of the Psf models of each input exposure.

Definition at line 45 of file CoaddPsf.h.

Constructor & Destructor Documentation

lsst::meas::algorithms::CoaddPsf::CoaddPsf ( afw::table::ExposureCatalog const &  catalog, afw::image::Wcs const &  coaddWcs, std::string const &  weightFieldName = "weight", std::string const &  warpingKernelName = "lanczos3", int  cacheSize = 10000  )

explicit

Main constructors for CoaddPsf.

The ExposureCatalog contains info about each visit/ccd in Coadd; this must be provided to the constructor, and cannot be changed.

Parameters

[in]	catalog	ExposureCatalog containing the id, bbox, wcs, psf and weight for each ccd/visit. This is usually the same catalog as the "ccds" catalog in the coadd Exposure's CoaddInputs.
[in]	coaddWcs	Wcs for the coadd.
[in]	weightFieldName	Field name that contains the weight of the exposure in the coadd; defaults to "weight".
[in]	warpingKernelName	Name of warping kernel
[in]	cacheSize	Warping kernel cache size

Definition at line 142 of file CoaddPsf.cc.

  :
    _coaddWcs(coaddWcs.clone()),
    _warpingKernelName(warpingKernelName),
    _warpingControl(boost::make_shared<afw::math::WarpingControl>(warpingKernelName, "", cacheSize))
{
    afw::table::SchemaMapper mapper(catalog.getSchema());
    mapper.addMinimalSchema(afw::table::ExposureTable::makeMinimalSchema(), true);

    // copy the field "goodpix", if available, for computeAveragePosition to use
    try {
        afw::table::Key<int> goodPixKey = catalog.getSchema()["goodpix"]; // auto does not work
        mapper.addMapping(goodPixKey, true);
    } catch (pex::exceptions::NotFoundError &) {}

    // copy the field specified by weightFieldName to field "weight"
    afw::table::Field<double> weightField = afw::table::Field<double>("weight", "Coadd weight");
    afw::table::Key<double> weightKey = catalog.getSchema()[weightFieldName];
    _weightKey = mapper.addMapping(weightKey, weightField);

    _catalog = afw::table::ExposureCatalog(mapper.getOutputSchema());
    for (afw::table::ExposureCatalog::const_iterator i = catalog.begin(); i != catalog.end(); ++i) {
         PTR(afw::table::ExposureRecord) record = _catalog.getTable()->makeRecord();
         record->assign(*i, mapper);
         _catalog.push_back(record);
    }
    _averagePosition = computeAveragePosition(_catalog, *_coaddWcs, _weightKey);
}

lsst::meas::algorithms::CoaddPsf::CoaddPsf ( afw::table::ExposureCatalog const &  catalog, boost::shared_ptr< afw::image::Wcs const >  coaddWcs, afw::geom::Point2D const &  averagePosition, std::string const &  warpingKernelName = "lanczos3", int  cacheSize = 10000  )

explicitprotected

Parameters

catalog	Unpersisted catalog
coaddWcs	WCS for the coadd
averagePosition	Default position for accessors
warpingKernelName	Warping kernel name
cacheSize	Kernel cache size

Definition at line 400 of file CoaddPsf.cc.

  :
    _catalog(catalog), _coaddWcs(coaddWcs), _weightKey(_catalog.getSchema()["weight"]),
    _averagePosition(averagePosition), _warpingKernelName(warpingKernelName),
    _warpingControl(new afw::math::WarpingControl(warpingKernelName, "", cacheSize))
{}

Member Function Documentation

boost::shared_ptr< afw::detection::Psf > lsst::meas::algorithms::CoaddPsf::clone ( void  ) const

virtual

Polymorphic deep copy. Usually unnecessary, as Psfs are immutable.

Implements lsst::afw::detection::Psf.

Definition at line 176 of file CoaddPsf.cc.

                                           {
    return boost::make_shared<CoaddPsf>(*this);
}

boost::shared_ptr< afw::detection::Psf::Image > lsst::meas::algorithms::CoaddPsf::doComputeKernelImage ( afw::geom::Point2D const &  position, afw::image::Color const &  color  ) const

protectedvirtual

These virtual member functions are private, not protected, because we only want derived classes to implement them, not call them; they should call the corresponding compute*Image member functions instead so as to let the Psf base class handle caching properly.

Derived classes are responsible for ensuring that returned images sum to one.

Implements lsst::afw::detection::Psf.

Definition at line 224 of file CoaddPsf.cc.

        {
    // Get the subset of expoures which contain our coordinate within their validPolygons.
    afw::table::ExposureCatalog subcat = _catalog.subsetContaining(ccdXY, *_coaddWcs, true);
    if (subcat.empty()) {
        throw LSST_EXCEPT(
            pex::exceptions::InvalidParameterError,
            (boost::format("Cannot compute CoaddPsf at point %s; no input images at that point.")
             % ccdXY).str()
        );
    }
    double weightSum = 0.0;

    // Read all the Psf images into a vector.  The code is set up so that this can be done in chunks,
    // with the image modified to accomodate
    // However, we currently read all of the images.
    std::vector<PTR(afw::image::Image<double>)> imgVector;
    std::vector<double> weightVector;

    for (afw::table::ExposureCatalog::const_iterator i = subcat.begin(); i != subcat.end(); ++i) {
        PTR(afw::geom::XYTransform) xytransform(
            new afw::image::XYTransformFromWcsPair(_coaddWcs, i->getWcs())
        );
        WarpedPsf warpedPsf = WarpedPsf(i->getPsf(), xytransform, _warpingControl);
        PTR(afw::image::Image<double>) componentImg = warpedPsf.computeKernelImage(ccdXY, color);
        imgVector.push_back(componentImg);
        weightSum += i->get(_weightKey);
        weightVector.push_back(i->get(_weightKey));
    }

    afw::geom::Box2I bbox = getOverallBBox(imgVector);

    // create a zero image of the right size to sum into
    PTR(afw::detection::Psf::Image) image = boost::make_shared<afw::detection::Psf::Image>(bbox);
    *image = 0.0;
    addToImage(image, imgVector, weightVector);
    *image /= weightSum;
    return image;
}

virtual afw::geom::Point2D lsst::meas::algorithms::CoaddPsf::getAveragePosition ( ) const

inlinevirtual

Return the average of the positions of the stars that went into this Psf.

For CoaddPsf, this is calculated as the weighted average of the average positions of all the component Psfs.

Reimplemented from lsst::afw::detection::Psf.

Definition at line 80 of file CoaddPsf.h.

{ return _averagePosition; }

afw::geom::Box2I lsst::meas::algorithms::CoaddPsf::getBBox

(

int

index

)

Get the bounding box (in component image Pixel coordinates) of the component image at index.

Parameters

[in]

index

Index of component for which the bounding box will be fetched.

Returns

Corresponding bounding box.

Exceptions

RangeError

Index of component is out of range.

Definition at line 305 of file CoaddPsf.cc.

                                        {
    if (index < 0 || index > getComponentCount()) {
        throw LSST_EXCEPT(pex::exceptions::RangeError, "index of CoaddPsf component out of range");
    }
    return _catalog[index].getBBox();
}

boost::shared_ptr< afw::image::Wcs const > lsst::meas::algorithms::CoaddPsf::getCoaddWcs ( )

inline

Return the Wcs of the coadd (defines the coordinate system of the Psf).

Definition at line 83 of file CoaddPsf.h.

{ return _coaddWcs; }

int lsst::meas::algorithms::CoaddPsf::getComponentCount

(

)

const

Return the number of component Psfs in this CoaddPsf.

Definition at line 266 of file CoaddPsf.cc.

                                      {
    return _catalog.size();
}

afw::table::RecordId lsst::meas::algorithms::CoaddPsf::getId

(

int

index

)

Get the exposure ID of the component image at index.

Parameters

[in]

index

Index of component for which the exposure ID will be fetched.

Returns

Corresponding exposure ID.

Exceptions

RangeError

Index of component is out of range.

Definition at line 298 of file CoaddPsf.cc.

                                          {
    if (index < 0 || index > getComponentCount()) {
        throw LSST_EXCEPT(pex::exceptions::RangeError, "index of CoaddPsf component out of range");
    }
    return _catalog[index].getId();
}

std::string lsst::meas::algorithms::CoaddPsf::getPersistenceName ( ) const

protectedvirtual

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.

Definition at line 384 of file CoaddPsf.cc.

{ return getCoaddPsfPersistenceName(); }

boost::shared_ptr< afw::detection::Psf const > lsst::meas::algorithms::CoaddPsf::getPsf

(

int

index

)

Get the Psf of the component image at index.

Parameters

[in]

index

Index of component for which the Psf will be fetched.

Returns

Corresponding Psf.

Exceptions

RangeError

Index of component is out of range.

Definition at line 270 of file CoaddPsf.cc.

                                                     {
    if (index < 0 || index > getComponentCount()) {
        throw LSST_EXCEPT(pex::exceptions::RangeError, "index of CoaddPsf component out of range");
    }
    return _catalog[index].getPsf();
}

std::string lsst::meas::algorithms::CoaddPsf::getPythonModule ( ) const

protectedvirtual

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 386 of file CoaddPsf.cc.

{ return "lsst.meas.algorithms"; }

boost::shared_ptr< afw::geom::polygon::Polygon const > lsst::meas::algorithms::CoaddPsf::getValidPolygon

(

int

index

)

Get the validPolygon (in component image Pixel coordinates) of the component image at index.

Parameters

[in]

index

Index of component for which the bounding box will be fetched.

Returns

Corresponding validPolygon.

Exceptions

RangeError

Index of component is out of range.

Definition at line 284 of file CoaddPsf.cc.

                                                                    {
    if (index < 0 || index > getComponentCount()) {
        throw LSST_EXCEPT(pex::exceptions::RangeError, "index of CoaddPsf component out of range");
    }
    return _catalog[index].getValidPolygon();
}

boost::shared_ptr< afw::image::Wcs const > lsst::meas::algorithms::CoaddPsf::getWcs

(

int

index

)

Get the Wcs of the component image at index.

Parameters

[in]

index

Index of component for which the Wcs will be fetched.

Returns

Corresponding Wcs.

Exceptions

RangeError

Index of component is out of range.

Definition at line 277 of file CoaddPsf.cc.

                                                 {
    if (index < 0 || index > getComponentCount()) {
        throw LSST_EXCEPT(pex::exceptions::RangeError, "index of CoaddPsf component out of range");
    }
    return _catalog[index].getWcs();
}

double lsst::meas::algorithms::CoaddPsf::getWeight

(

int

index

)

Get the weight of the component image at index.

Parameters

[in]

index

Index of component for which the weight will be fetched.

Returns

Corresponding weight.

Exceptions

RangeError

Index of component is out of range.

Definition at line 291 of file CoaddPsf.cc.

                                    {
    if (index < 0 || index > getComponentCount()) {
        throw LSST_EXCEPT(pex::exceptions::RangeError, "index of CoaddPsf component out of range");
    }
    return _catalog[index].get(_weightKey);
}

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

inlinevirtual

Return true if the CoaddPsf persistable (always true).

While it's actually possible to construct a CoaddPsf that isn't persistable (because its nested Psfs and Wcss are not persistable) in artificial situations, in realistic situations it's pretty much impossible, because persistence is a necessary part of how CoaddPsfs are built. And it's simpler and much faster if we just always return true, rather than loop over the elements and check each one.

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

Definition at line 151 of file CoaddPsf.h.

{ return true; }

void lsst::meas::algorithms::CoaddPsf::write ( OutputArchiveHandle &  handle ) const

protectedvirtual

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.

Definition at line 388 of file CoaddPsf.cc.

                                                       {
    CoaddPsfPersistenceHelper const & keys1 = CoaddPsfPersistenceHelper::get();
    tbl::BaseCatalog cat1 = handle.makeCatalog(keys1.schema);
    PTR(tbl::BaseRecord) record1 = cat1.addNew();
    record1->set(keys1.coaddWcs, handle.put(_coaddWcs));
    record1->set(keys1.cacheSize, _warpingControl->getCacheSize());
    record1->set(keys1.averagePosition, _averagePosition);
    record1->set(keys1.warpingKernelName, _warpingKernelName);
    handle.saveCatalog(cat1);
    _catalog.writeToArchive(handle, false);
}

Member Data Documentation

afw::geom::Point2D lsst::meas::algorithms::CoaddPsf::_averagePosition

private

Definition at line 186 of file CoaddPsf.h.

afw::table::ExposureCatalog lsst::meas::algorithms::CoaddPsf::_catalog

private

Definition at line 183 of file CoaddPsf.h.

boost::shared_ptr< afw::image::Wcs const> lsst::meas::algorithms::CoaddPsf::_coaddWcs

private

Definition at line 184 of file CoaddPsf.h.

boost::shared_ptr< afw::math::WarpingControl const> lsst::meas::algorithms::CoaddPsf::_warpingControl

private

Definition at line 188 of file CoaddPsf.h.

std::string lsst::meas::algorithms::CoaddPsf::_warpingKernelName

private

Definition at line 187 of file CoaddPsf.h.

afw::table::Key<double> lsst::meas::algorithms::CoaddPsf::_weightKey

private

Definition at line 185 of file CoaddPsf.h.

---

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

• /home/lsstsw/stack/Linux64/meas_algorithms/11.0-2-gb8b8ce7/include/lsst/meas/algorithms/CoaddPsf.h
• /home/lsstsw/stack/Linux64/meas_algorithms/11.0-2-gb8b8ce7/src/CoaddPsf.cc