CoaddPsf is the Psf derived to be used for non-PSF-matched Coadd images.
More...
#include <CoaddPsf.h>
|
| 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...
|
|
| CoaddPsf (afw::table::ExposureCatalog const &catalog, afw::image::Wcs const &coaddWcs, CoaddPsfControl const &ctrl, std::string const &weightFieldName="weight") |
| Constructor for CoaddPsf. More...
|
|
virtual boost::shared_ptr< afw::detection::Psf > | clone () const |
| Polymorphic deep copy. Usually unnecessary, as Psfs are immutable. More...
|
|
virtual boost::shared_ptr< afw::detection::Psf > | resized (int width, int height) const |
| Return a clone with specified kernel dimensions. 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) |
| Get the Psf of the component image at index. More...
|
|
boost::shared_ptr< afw::image::Wcs const > | getWcs (int index) |
| Get the Wcs of the component image at index. More...
|
|
double | getWeight (int index) |
| Get the weight of the component image at index. More...
|
|
afw::table::RecordId | getId (int index) |
| Get the exposure ID of the component image at index. More...
|
|
afw::geom::Box2I | getBBox (int index) |
| Get the bounding box (in component image Pixel coordinates) of the component image at index. More...
|
|
boost::shared_ptr< afw::geom::polygon::Polygon const > | getValidPolygon (int index) |
| Get the validPolygon (in component image Pixel coordinates) of the component image at index. More...
|
|
virtual bool | isPersistable () const |
| Return true if the CoaddPsf persistable (always true). More...
|
|
|
boost::shared_ptr< afw::detection::Psf::Image > | doComputeKernelImage (afw::geom::Point2D const &ccdXY, afw::image::Color const &color) const |
|
virtual afw::geom::Box2I | doComputeBBox (afw::geom::Point2D const &position, afw::image::Color const &color) const |
|
virtual std::string | getPersistenceName () const |
|
virtual std::string | getPythonModule () const |
|
virtual void | write (OutputArchiveHandle &handle) const |
|
| 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) |
|
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 |
|
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 58 of file CoaddPsf.h.
◆ CoaddPsf() [1/3]
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.
◆ CoaddPsf() [2/3]
lsst::meas::algorithms::CoaddPsf::CoaddPsf |
( |
afw::table::ExposureCatalog const & |
catalog, |
|
|
afw::image::Wcs const & |
coaddWcs, |
|
|
CoaddPsfControl const & |
ctrl, |
|
|
std::string const & |
weightFieldName = "weight" |
|
) |
| |
|
inline |
Constructor 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] | ctrl | Configuration options. |
[in] | weightFieldName | Field name that contains the weight of the exposure in the coadd; defaults to "weight". |
Definition at line 98 of file CoaddPsf.h.
◆ CoaddPsf() [3/3]
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 457 of file CoaddPsf.cc.
◆ clone()
boost::shared_ptr< afw::detection::Psf > lsst::meas::algorithms::CoaddPsf::clone |
( |
| ) |
const |
|
virtual |
Polymorphic deep copy. Usually unnecessary, as Psfs are immutable.
Definition at line 176 of file CoaddPsf.cc.
◆ doComputeApertureFlux()
double lsst::meas::algorithms::ImagePsf::doComputeApertureFlux |
( |
double |
radius, |
|
|
afw::geom::Point2D const & |
position, |
|
|
afw::image::Color const & |
color |
|
) |
| const |
|
protectedvirtualinherited |
◆ doComputeBBox()
afw::geom::Box2I lsst::meas::algorithms::CoaddPsf::doComputeBBox |
( |
afw::geom::Point2D const & |
position, |
|
|
afw::image::Color const & |
color |
|
) |
| const |
|
protectedvirtual |
◆ doComputeKernelImage()
boost::shared_ptr< afw::detection::Psf::Image > lsst::meas::algorithms::CoaddPsf::doComputeKernelImage |
( |
afw::geom::Point2D const & |
ccdXY, |
|
|
afw::image::Color const & |
color |
|
) |
| const |
|
protected |
◆ doComputeShape()
afw::geom::ellipses::Quadrupole lsst::meas::algorithms::ImagePsf::doComputeShape |
( |
afw::geom::Point2D const & |
position, |
|
|
afw::image::Color const & |
color |
|
) |
| const |
|
protectedvirtualinherited |
◆ getAveragePosition()
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.
Definition at line 116 of file CoaddPsf.h.
◆ getBBox()
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 333 of file CoaddPsf.cc.
◆ getCoaddWcs()
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 119 of file CoaddPsf.h.
◆ getComponentCount()
int lsst::meas::algorithms::CoaddPsf::getComponentCount |
( |
| ) |
const |
◆ getId()
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 326 of file CoaddPsf.cc.
◆ getPersistenceName()
std::string lsst::meas::algorithms::CoaddPsf::getPersistenceName |
( |
| ) |
const |
|
protectedvirtual |
◆ getPsf()
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 298 of file CoaddPsf.cc.
◆ getPythonModule()
std::string lsst::meas::algorithms::CoaddPsf::getPythonModule |
( |
| ) |
const |
|
protectedvirtual |
◆ getValidPolygon()
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 312 of file CoaddPsf.cc.
◆ getWcs()
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 305 of file CoaddPsf.cc.
◆ getWeight()
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 319 of file CoaddPsf.cc.
◆ isPersistable()
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.
Definition at line 187 of file CoaddPsf.h.
◆ resized()
boost::shared_ptr< afw::detection::Psf > lsst::meas::algorithms::CoaddPsf::resized |
( |
int |
width, |
|
|
int |
height |
|
) |
| const |
|
virtual |
Return a clone with specified kernel dimensions.
Definition at line 180 of file CoaddPsf.cc.
◆ write()
void lsst::meas::algorithms::CoaddPsf::write |
( |
OutputArchiveHandle & |
handle | ) |
const |
|
protectedvirtual |
The documentation for this class was generated from the following files: