LSST Applications  21.0.0-147-g0e635eb1+1acddb5be5,22.0.0+052faf71bd,22.0.0+1ea9a8b2b2,22.0.0+6312710a6c,22.0.0+729191ecac,22.0.0+7589c3a021,22.0.0+9f079a9461,22.0.1-1-g7d6de66+b8044ec9de,22.0.1-1-g87000a6+536b1ee016,22.0.1-1-g8e32f31+6312710a6c,22.0.1-10-gd060f87+016f7cdc03,22.0.1-12-g9c3108e+df145f6f68,22.0.1-16-g314fa6d+c825727ab8,22.0.1-19-g93a5c75+d23f2fb6d8,22.0.1-19-gb93eaa13+aab3ef7709,22.0.1-2-g8ef0a89+b8044ec9de,22.0.1-2-g92698f7+9f079a9461,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gac51dbf+052faf71bd,22.0.1-2-gb66926d+6312710a6c,22.0.1-2-gcb770ba+09e3807989,22.0.1-20-g32debb5+b8044ec9de,22.0.1-23-gc2439a9a+fb0756638e,22.0.1-3-g496fd5d+09117f784f,22.0.1-3-g59f966b+1e6ba2c031,22.0.1-3-g849a1b8+f8b568069f,22.0.1-3-gaaec9c0+c5c846a8b1,22.0.1-32-g5ddfab5d3+60ce4897b0,22.0.1-4-g037fbe1+64e601228d,22.0.1-4-g8623105+b8044ec9de,22.0.1-5-g096abc9+d18c45d440,22.0.1-5-g15c806e+57f5c03693,22.0.1-7-gba73697+57f5c03693,master-g6e05de7fdc+c1283a92b8,master-g72cdda8301+729191ecac,w.2021.39
LSST Data Management Base Package
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Related Functions | List of all members
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:
lsst::afw::table::io::PersistableFacade< CoaddPsf > lsst::meas::algorithms::ImagePsf lsst::afw::table::io::PersistableFacade< ImagePsf > lsst::afw::detection::Psf lsst::afw::table::io::PersistableFacade< Psf > lsst::afw::typehandling::Storable lsst::afw::table::io::Persistable

Classes

class  Factory
 

Public Types

enum  ImageOwnerEnum { COPY = 0 , INTERNAL = 1 }
 Enum passed to computeImage and computeKernelImage to determine image ownership. More...
 
using Pixel = math::Kernel::Pixel
 Pixel type of Image returned by computeImage. More...
 
using Image = image::Image< Pixel >
 Image type returned by computeImage. More...
 

Public Member Functions

 CoaddPsf (afw::table::ExposureCatalog const &catalog, afw::geom::SkyWcs 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::geom::SkyWcs const &coaddWcs, CoaddPsfControl const &ctrl, std::string const &weightFieldName="weight")
 Constructor for CoaddPsf. More...
 
 CoaddPsf (afw::table::ExposureCatalog const &catalog, afw::geom::SkyWcs const &coaddWcs, geom::Point2D const &averagePosition, std::string const &warpingKernelName="lanczos3", int cacheSize=10000)
 
std::shared_ptr< afw::detection::Psfclone () const override
 Polymorphic deep copy. Usually unnecessary, as Psfs are immutable. More...
 
std::shared_ptr< afw::detection::Psfresized (int width, int height) const override
 Return a clone with specified kernel dimensions. More...
 
geom::Point2D getAveragePosition () const override
 Return the average of the positions of the stars that went into this Psf. More...
 
afw::geom::SkyWcs 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...
 
std::shared_ptr< afw::detection::Psf const > getPsf (int index)
 Get the Psf of the component image at index. More...
 
afw::geom::SkyWcs 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...
 
geom::Box2I getBBox (int index)
 Get the bounding box (in component image Pixel coordinates) of the component image at index. More...
 
std::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...
 
bool isPersistable () const noexcept override
 Return true if the CoaddPsf persistable (always true). More...
 
std::shared_ptr< typehandling::Storable > cloneStorable () const override
 Polymorphic deep-copy. More...
 
std::shared_ptr< ImagecomputeImage (lsst::geom::Point2D position, 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...
 
std::shared_ptr< ImagecomputeImage () const
 
std::shared_ptr< ImagecomputeKernelImage (lsst::geom::Point2D position, image::Color color=image::Color(), ImageOwnerEnum owner=COPY) const
 Return an Image of the PSF, in a form suitable for convolution. More...
 
std::shared_ptr< ImagecomputeKernelImage () const
 
double computePeak (lsst::geom::Point2D position, image::Color color=image::Color()) const
 Return the peak value of the PSF image. More...
 
double computePeak () const
 
double computeApertureFlux (double radius, lsst::geom::Point2D position, image::Color color=image::Color()) const
 Compute the "flux" of the Psf model within a circular aperture of the given radius. More...
 
double computeApertureFlux (double radius) const
 
geom::ellipses::Quadrupole computeShape (lsst::geom::Point2D position, image::Color color=image::Color()) const
 Compute the ellipse corresponding to the second moments of the Psf. More...
 
geom::ellipses::Quadrupole computeShape () const
 
std::shared_ptr< math::Kernel const > getLocalKernel (lsst::geom::Point2D position, image::Color color=image::Color()) const
 Return a FixedKernel corresponding to the Psf image at the given point. More...
 
std::shared_ptr< math::Kernel const > getLocalKernel () const
 
image::Color getAverageColor () const
 Return the average Color of the stars used to construct the Psf. More...
 
lsst::geom::Box2I computeBBox (lsst::geom::Point2D position, image::Color color=image::Color()) const
 Return the bounding box of the image returned by computeKernelImage() More...
 
lsst::geom::Box2I computeBBox () const
 
lsst::geom::Box2I computeImageBBox (lsst::geom::Point2D position, image::Color color=image::Color()) const
 Return the bounding box of the image returned by computeImage() More...
 
lsst::geom::Box2I computeImageBBox () const
 
lsst::geom::Box2I computeKernelBBox (lsst::geom::Point2D position, image::Color color=image::Color()) const
 Return the bounding box of the image returned by computeImage() More...
 
lsst::geom::Box2I computeKernelBBox () const
 
std::size_t getCacheCapacity () const
 Return the capacity of the caches. More...
 
void setCacheCapacity (std::size_t capacity)
 Set the capacity of the caches. More...
 
virtual std::string toString () const
 Create a string representation of this object (optional operation). More...
 
virtual std::size_t hash_value () const
 Return a hash of this object (optional operation). More...
 
virtual bool equals (Storable const &other) const noexcept
 Compare this object to another Storable. 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...
 

Static Public Member Functions

static std::shared_ptr< CoaddPsfreadFits (fits::Fits &fitsfile)
 Read an object from an already open FITS object. More...
 
static std::shared_ptr< CoaddPsfreadFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
 Read an object from a regular FITS file. More...
 
static std::shared_ptr< CoaddPsfreadFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 Read an object from a FITS file in memory. More...
 
static std::shared_ptr< CoaddPsfdynamicCast (std::shared_ptr< Persistable > const &ptr)
 Dynamically cast a shared_ptr. More...
 
static std::shared_ptr< ImagePsfreadFits (fits::Fits &fitsfile)
 Read an object from an already open FITS object. More...
 
static std::shared_ptr< ImagePsfreadFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
 Read an object from a regular FITS file. More...
 
static std::shared_ptr< ImagePsfreadFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 Read an object from a FITS file in memory. More...
 
static std::shared_ptr< PsfreadFits (fits::Fits &fitsfile)
 Read an object from an already open FITS object. More...
 
static std::shared_ptr< PsfreadFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
 Read an object from a regular FITS file. More...
 
static std::shared_ptr< PsfreadFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 Read an object from a FITS file in memory. More...
 
static std::shared_ptr< ImagePsfdynamicCast (std::shared_ptr< Persistable > const &ptr)
 Dynamically cast a shared_ptr. More...
 
static std::shared_ptr< PsfdynamicCast (std::shared_ptr< Persistable > const &ptr)
 Dynamically cast a shared_ptr. More...
 
static std::shared_ptr< ImagerecenterKernelImage (std::shared_ptr< Image > im, lsst::geom::Point2D const &position, std::string const &warpAlgorithm="lanczos5", unsigned int warpBuffer=5)
 Helper function for Psf::doComputeImage(): converts a kernel image (centered at (0,0) when xy0 is taken into account) to an image centered at position when xy0 is taken into account. More...
 

Protected Types

using OutputArchiveHandle = io::OutputArchiveHandle
 

Protected Member Functions

std::shared_ptr< afw::detection::Psf::ImagedoComputeKernelImage (geom::Point2D const &ccdXY, afw::image::Color const &color) const override
 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. More...
 
geom::Box2I doComputeBBox (geom::Point2D const &position, afw::image::Color const &color) const override
 
std::string getPersistenceName () const override
 Return the unique name used to persist this object and look up its factory. More...
 
std::string getPythonModule () const override
 Return the fully-qualified Python module that should be imported to guarantee that its factory is registered. More...
 
void write (OutputArchiveHandle &handle) const override
 Write the object to one or more catalogs. More...
 
virtual double doComputeApertureFlux (double radius, geom::Point2D const &position, afw::image::Color const &color) const
 
virtual afw::geom::ellipses::Quadrupole doComputeShape (geom::Point2D const &position, afw::image::Color const &color) const
 
virtual std::shared_ptr< ImagedoComputeImage (lsst::geom::Point2D const &position, image::Color const &color) const
 These virtual members are protected (rather than private) so that python-implemented derived classes may opt to use the default implementations. More...
 
virtual lsst::geom::Box2I doComputeImageBBox (lsst::geom::Point2D const &position, image::Color const &color) const
 

Static Protected Member Functions

template<class T >
static bool singleClassEquals (T const &lhs, Storable const &rhs)
 Test if a Storable is of a particular class and equal to another object. More...
 

Related Functions

(Note that these are not member functions.)

std::ostreamoperator<< (std::ostream &os, Storable const &storable)
 Output operator for Storable. More...
 

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 58 of file CoaddPsf.h.

Member Typedef Documentation

◆ Image

Image type returned by computeImage.

Definition at line 83 of file Psf.h.

◆ OutputArchiveHandle

using lsst::afw::table::io::Persistable::OutputArchiveHandle = io::OutputArchiveHandle
protectedinherited

Definition at line 108 of file Persistable.h.

◆ Pixel

using lsst::afw::detection::Psf::Pixel = math::Kernel::Pixel
inherited

Pixel type of Image returned by computeImage.

Definition at line 82 of file Psf.h.

Member Enumeration Documentation

◆ ImageOwnerEnum

Enum passed to computeImage and computeKernelImage to determine image ownership.

Enumerator
COPY 

The image will be copied before returning; caller will own it.

INTERNAL 

An internal image will be returned without copying.

The caller must not modify it, and it may be invalidated the next time a Psf member function is called with different color and/or position.

Definition at line 86 of file Psf.h.

86  {
87  COPY = 0,
88  INTERNAL = 1
92  };
@ COPY
The image will be copied before returning; caller will own it.
Definition: Psf.h:87
@ INTERNAL
An internal image will be returned without copying.
Definition: Psf.h:88

Constructor & Destructor Documentation

◆ CoaddPsf() [1/3]

lsst::meas::algorithms::CoaddPsf::CoaddPsf ( afw::table::ExposureCatalog const &  catalog,
afw::geom::SkyWcs 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]catalogExposureCatalog 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]coaddWcsWcs for the coadd.
[in]weightFieldNameField name that contains the weight of the exposure in the coadd; defaults to "weight".
[in]warpingKernelNameName of warping kernel
[in]cacheSizeWarping kernel cache size

Definition at line 141 of file CoaddPsf.cc.

143  : _coaddWcs(coaddWcs),
144  _warpingKernelName(warpingKernelName),
145  _warpingControl(std::make_shared<afw::math::WarpingControl>(warpingKernelName, "", cacheSize)) {
146  afw::table::SchemaMapper mapper(catalog.getSchema());
147  mapper.addMinimalSchema(afw::table::ExposureTable::makeMinimalSchema(), true);
148 
149  // copy the field "goodpix", if available, for computeAveragePosition to use
150  try {
151  afw::table::Key<int> goodPixKey = catalog.getSchema()["goodpix"]; // auto does not work
152  mapper.addMapping(goodPixKey, true);
153  } catch (pex::exceptions::NotFoundError &) {
154  }
155 
156  // copy the field specified by weightFieldName to field "weight"
157  afw::table::Field<double> weightField = afw::table::Field<double>("weight", "Coadd weight");
158  afw::table::Key<double> weightKey = catalog.getSchema()[weightFieldName];
159  _weightKey = mapper.addMapping(weightKey, weightField);
160 
161  _catalog = afw::table::ExposureCatalog(mapper.getOutputSchema());
162  for (afw::table::ExposureCatalog::const_iterator i = catalog.begin(); i != catalog.end(); ++i) {
163  std::shared_ptr<afw::table::ExposureRecord> record = _catalog.getTable()->makeRecord();
164  record->assign(*i, mapper);
165  _catalog.push_back(record);
166  }
167  _averagePosition = computeAveragePosition(_catalog, _coaddWcs, _weightKey);
168 }
SchemaMapper * mapper
Definition: SchemaMapper.cc:71
std::shared_ptr< Table > getTable() const
Return the table associated with the catalog.
Definition: Catalog.h:115
void push_back(Record const &r)
Add a copy of the given record to the end of the catalog.
Definition: Catalog.h:481
typename Base::const_iterator const_iterator
Definition: Exposure.h:319
static Schema makeMinimalSchema()
Return a minimal schema for Exposure tables and records.
Definition: Exposure.h:216
ExposureCatalogT< ExposureRecord > ExposureCatalog
Definition: Exposure.h:489
afw::table::Key< int > cacheSize
Definition: CoaddPsf.cc:348
afw::table::Key< int > coaddWcs
Definition: CoaddPsf.cc:347
afw::table::Key< std::string > warpingKernelName
Definition: CoaddPsf.cc:350

◆ CoaddPsf() [2/3]

lsst::meas::algorithms::CoaddPsf::CoaddPsf ( afw::table::ExposureCatalog const &  catalog,
afw::geom::SkyWcs 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]catalogExposureCatalog 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]coaddWcsWcs for the coadd.
[in]ctrlConfiguration options.
[in]weightFieldNameField name that contains the weight of the exposure in the coadd; defaults to "weight".

Definition at line 93 of file CoaddPsf.h.

95  : CoaddPsf(catalog, coaddWcs, weightFieldName, ctrl.warpingKernelName, ctrl.cacheSize) {}
CoaddPsf(afw::table::ExposureCatalog const &catalog, afw::geom::SkyWcs const &coaddWcs, std::string const &weightFieldName="weight", std::string const &warpingKernelName="lanczos3", int cacheSize=10000)
Main constructors for CoaddPsf.
Definition: CoaddPsf.cc:141
afw::table::Key< int > coaddWcs

◆ CoaddPsf() [3/3]

lsst::meas::algorithms::CoaddPsf::CoaddPsf ( afw::table::ExposureCatalog const &  catalog,
afw::geom::SkyWcs const &  coaddWcs,
geom::Point2D const &  averagePosition,
std::string const &  warpingKernelName = "lanczos3",
int  cacheSize = 10000 
)
explicit
Parameters
catalogUnpersisted catalog
coaddWcsWCS for the coadd
averagePositionDefault position for accessors
warpingKernelNameWarping kernel name
cacheSizeKernel cache size

Definition at line 170 of file CoaddPsf.cc.

172  : _catalog(catalog),
173  _coaddWcs(coaddWcs),
174  _weightKey(_catalog.getSchema()["weight"]),
175  _averagePosition(averagePosition),
176  _warpingKernelName(warpingKernelName),
177  _warpingControl(new afw::math::WarpingControl(warpingKernelName, "", cacheSize)) {}
Schema getSchema() const
Return the schema associated with the catalog's table.
Definition: Catalog.h:118
afw::table::PointKey< double > averagePosition
Definition: CoaddPsf.cc:349

Member Function Documentation

◆ clone()

std::shared_ptr< afw::detection::Psf > lsst::meas::algorithms::CoaddPsf::clone ( ) const
overridevirtual

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

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

Definition at line 179 of file CoaddPsf.cc.

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

◆ cloneStorable()

std::shared_ptr<typehandling::Storable> lsst::afw::detection::Psf::cloneStorable ( ) const
inlineoverridevirtualinherited

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

This method is an alias of clone that can be called from a reference to Storable.

Reimplemented from lsst::afw::typehandling::Storable.

Definition at line 116 of file Psf.h.

116 { return clone(); }
virtual std::shared_ptr< Psf > clone() const =0
Polymorphic deep-copy.

◆ computeApertureFlux() [1/2]

double Psf::computeApertureFlux ( double  radius) const
inherited

Definition at line 179 of file Psf.cc.

179  {
180  return computeApertureFlux(radius, makeNullPoint());
181 }
double computeApertureFlux(double radius, lsst::geom::Point2D position, image::Color color=image::Color()) const
Compute the "flux" of the Psf model within a circular aperture of the given radius.
Definition: Psf.cc:183

◆ computeApertureFlux() [2/2]

double Psf::computeApertureFlux ( double  radius,
lsst::geom::Point2D  position,
image::Color  color = image::Color() 
) const
inherited

Compute the "flux" of the Psf model within a circular aperture of the given radius.

Parameters
[in]radiusRadius of the aperture to measure.
[in]positionPosition at which to evaluate the PSF.
[in]colorColor of the source for which to evaluate the PSF; defaults to getAverageColor().

The flux is relative to a Psf image that has been normalized to unit integral, and the radius is in pixels.

Definition at line 183 of file Psf.cc.

183  {
184  if (isPointNull(position)) position = getAveragePosition();
185  if (color.isIndeterminate()) color = getAverageColor();
186  return doComputeApertureFlux(radius, position, color);
187 }
image::Color getAverageColor() const
Return the average Color of the stars used to construct the Psf.
Definition: Psf.h:274
virtual double doComputeApertureFlux(double radius, lsst::geom::Point2D const &position, image::Color const &color) const =0
virtual lsst::geom::Point2D getAveragePosition() const
Return the average position of the stars used to construct the Psf.
Definition: Psf.cc:211
bool isIndeterminate() const noexcept
Whether the color is the special value that indicates that it is unspecified.
Definition: Color.h:37

◆ computeBBox() [1/2]

lsst::geom::Box2I Psf::computeBBox ( ) const
inherited

Definition at line 135 of file Psf.cc.

135  {
136  return computeBBox(makeNullPoint());
137 }
lsst::geom::Box2I computeBBox() const
Definition: Psf.cc:135

◆ computeBBox() [2/2]

lsst::geom::Box2I Psf::computeBBox ( lsst::geom::Point2D  position,
image::Color  color = image::Color() 
) const
inherited

Return the bounding box of the image returned by computeKernelImage()

Parameters
[in]positionPosition at which to evaluate the PSF.
[in]colorColor of the source for which to evaluate the PSF; defaults to getAverageColor().

Definition at line 139 of file Psf.cc.

139  {
140  if (isPointNull(position)) position = getAveragePosition();
141  if (color.isIndeterminate()) color = getAverageColor();
142  return doComputeBBox(position, color);
143 }
virtual lsst::geom::Box2I doComputeBBox(lsst::geom::Point2D const &position, image::Color const &color) const =0

◆ computeImage() [1/2]

std::shared_ptr< Psf::Image > Psf::computeImage ( ) const
inherited

Definition at line 101 of file Psf.cc.

101  {
102  return computeImage(makeNullPoint());
103 }
std::shared_ptr< Image > computeImage() const
Definition: Psf.cc:101

◆ computeImage() [2/2]

std::shared_ptr< Psf::Image > Psf::computeImage ( lsst::geom::Point2D  position,
image::Color  color = image::Color(),
ImageOwnerEnum  owner = COPY 
) const
inherited

Return an Image of the PSF, in a form that can be compared directly with star images.

The specified position is a floating point number, and the resulting image will have a Psf centered on that point when the returned image's xy0 is taken into account.

The returned image is normalized to sum to unity.

Parameters
[in]positionPosition at which to evaluate the PSF.
[in]colorColor of the source for which to evaluate the PSF; defaults to getAverageColor().
[in]ownerWhether to copy the return value or return an internal image that must be handled with care (see ImageOwnerEnum).

The Psf class caches the most recent return value of computeImage, so repeated calls with the same arguments will be highly optimized.

Note
The real work is done in the virtual private member function Psf::doComputeImage; computeImage only handles caching and default arguments.

Definition at line 105 of file Psf.cc.

106  {
107  if (isPointNull(position)) position = getAveragePosition();
108  if (color.isIndeterminate()) color = getAverageColor();
109  std::shared_ptr<Psf::Image> result = (*_imageCache)(
110  detail::PsfCacheKey(position, color),
111  [this](detail::PsfCacheKey const &key) { return doComputeImage(key.position, key.color); });
112  if (owner == COPY) {
113  result = std::make_shared<Image>(*result, true);
114  }
115  return result;
116 }
py::object result
Definition: _schema.cc:429
virtual std::shared_ptr< Image > doComputeImage(lsst::geom::Point2D const &position, image::Color const &color) const
These virtual members are protected (rather than private) so that python-implemented derived classes ...
Definition: Psf.cc:199

◆ computeImageBBox() [1/2]

lsst::geom::Box2I Psf::computeImageBBox ( ) const
inherited

Definition at line 145 of file Psf.cc.

145  {
146  return computeImageBBox(makeNullPoint());
147 }
lsst::geom::Box2I computeImageBBox() const
Definition: Psf.cc:145

◆ computeImageBBox() [2/2]

lsst::geom::Box2I Psf::computeImageBBox ( lsst::geom::Point2D  position,
image::Color  color = image::Color() 
) const
inherited

Return the bounding box of the image returned by computeImage()

Parameters
[in]positionPosition at which to evaluate the PSF.
[in]colorColor of the source for which to evaluate the PSF; defaults to getAverageColor().

Definition at line 149 of file Psf.cc.

149  {
150  if (isPointNull(position)) position = getAveragePosition();
151  if (color.isIndeterminate()) color = getAverageColor();
152  return doComputeImageBBox(position, color);
153 }
virtual lsst::geom::Box2I doComputeImageBBox(lsst::geom::Point2D const &position, image::Color const &color) const
Definition: Psf.cc:205

◆ computeKernelBBox() [1/2]

lsst::geom::Box2I lsst::afw::detection::Psf::computeKernelBBox ( ) const
inlineinherited

Definition at line 332 of file Psf.h.

332  {
333  return computeBBox();
334  }

◆ computeKernelBBox() [2/2]

lsst::geom::Box2I lsst::afw::detection::Psf::computeKernelBBox ( lsst::geom::Point2D  position,
image::Color  color = image::Color() 
) const
inlineinherited

Return the bounding box of the image returned by computeImage()

Parameters
[in]positionPosition at which to evaluate the PSF.
[in]colorColor of the source for which to evaluate the PSF; defaults to getAverageColor(). Alias for computeBBox

Definition at line 323 of file Psf.h.

324  {
325  return computeBBox(position, color);
326  }

◆ computeKernelImage() [1/2]

std::shared_ptr< Psf::Image > Psf::computeKernelImage ( ) const
inherited

Definition at line 118 of file Psf.cc.

118  {
119  return computeKernelImage(makeNullPoint());
120 }
std::shared_ptr< Image > computeKernelImage() const
Definition: Psf.cc:118

◆ computeKernelImage() [2/2]

std::shared_ptr< Psf::Image > Psf::computeKernelImage ( lsst::geom::Point2D  position,
image::Color  color = image::Color(),
ImageOwnerEnum  owner = COPY 
) const
inherited

Return an Image of the PSF, in a form suitable for convolution.

While the position need not be an integer, the center of the PSF image returned by computeKernelImage will in the center of the center pixel of the image, which will be (0,0) when the Image's xy0 is taken into account; this is the same behavior as Kernel::computeImage().

The returned image is normalized to sum to unity.

Parameters
[in]positionPosition at which to evaluate the PSF.
[in]colorColor of the source for which to evaluate the PSF; defaults to getAverageColor().
[in]ownerWhether to copy the return value or return an internal image that must be handled with care (see ImageOwnerEnum).

The Psf class caches the most recent return value of computeKernelImage, so repeated calls with the same arguments will be highly optimized.

Note
The real work is done in the virtual private member function Psf::doComputeKernelImage; computeKernelImage only handles caching and default arguments.

Definition at line 122 of file Psf.cc.

123  {
124  if (_isFixed || isPointNull(position)) position = getAveragePosition();
125  if (_isFixed || color.isIndeterminate()) color = getAverageColor();
126  std::shared_ptr<Psf::Image> result = (*_kernelImageCache)(
127  detail::PsfCacheKey(position, color),
128  [this](detail::PsfCacheKey const &key) { return doComputeKernelImage(key.position, key.color); });
129  if (owner == COPY) {
130  result = std::make_shared<Image>(*result, true);
131  }
132  return result;
133 }
virtual std::shared_ptr< Image > doComputeKernelImage(lsst::geom::Point2D const &position, image::Color const &color) const =0
These virtual member functions are private, not protected, because we only want derived classes to im...

◆ computePeak() [1/2]

double Psf::computePeak ( ) const
inherited

Definition at line 168 of file Psf.cc.

168  {
169  return computePeak(makeNullPoint());
170 }
double computePeak() const
Definition: Psf.cc:168

◆ computePeak() [2/2]

double Psf::computePeak ( lsst::geom::Point2D  position,
image::Color  color = image::Color() 
) const
inherited

Return the peak value of the PSF image.

Parameters
[in]positionPosition at which to evaluate the PSF.
[in]colorColor of the source for which to evaluate the PSF; defaults to getAverageColor().

This calls computeKernelImage internally, but because this will usually be cached, it shouldn't be expensive (but be careful not to accidentally call it with no arguments when you actually want to call it with the same arguments just used to call computeImage or computeKernelImage).

Definition at line 172 of file Psf.cc.

172  {
173  if (isPointNull(position)) position = getAveragePosition();
174  if (color.isIndeterminate()) color = getAverageColor();
176  return (*image)(-image->getX0(), -image->getY0());
177 }
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.

◆ computeShape() [1/2]

geom::ellipses::Quadrupole Psf::computeShape ( ) const
inherited

Definition at line 189 of file Psf.cc.

189  {
190  return computeShape(makeNullPoint());
191 }
geom::ellipses::Quadrupole computeShape() const
Definition: Psf.cc:189

◆ computeShape() [2/2]

geom::ellipses::Quadrupole Psf::computeShape ( lsst::geom::Point2D  position,
image::Color  color = image::Color() 
) const
inherited

Compute the ellipse corresponding to the second moments of the Psf.

Parameters
[in]positionPosition at which to evaluate the PSF.
[in]colorColor of the source for which to evaluate the PSF; defaults to getAverageColor().

The algorithm used to compute the moments is up to the derived class, and hence this method should not be used when a particular algorithm or weight function is required.

Definition at line 193 of file Psf.cc.

193  {
194  if (isPointNull(position)) position = getAveragePosition();
195  if (color.isIndeterminate()) color = getAverageColor();
196  return doComputeShape(position, color);
197 }
virtual geom::ellipses::Quadrupole doComputeShape(lsst::geom::Point2D const &position, image::Color const &color) const =0

◆ doComputeApertureFlux()

double lsst::meas::algorithms::ImagePsf::doComputeApertureFlux ( double  radius,
geom::Point2D const &  position,
afw::image::Color const &  color 
) const
protectedvirtualinherited

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

Definition at line 45 of file ImagePsf.cc.

46  {
47  afw::image::Image<double> const& image(*computeKernelImage(position, color, INTERNAL));
48 
49  geom::Point2D const center(0.0, 0.0);
50  afw::geom::ellipses::Axes const axes(radius, radius);
51  base::ApertureFluxResult result = base::ApertureFluxAlgorithm::computeSincFlux(
52  image, afw::geom::ellipses::Ellipse(axes, center), base::ApertureFluxControl());
53  return result.instFlux;
54 }
afw::table::Key< afw::table::Array< ImagePixelT > > image
static Result computeSincFlux(afw::image::Image< T > const &image, afw::geom::ellipses::Ellipse const &ellipse, Control const &ctrl=Control())
Compute the instFlux (and optionally, uncertanties) within an aperture using Sinc photometry.

◆ doComputeBBox()

geom::Box2I lsst::meas::algorithms::CoaddPsf::doComputeBBox ( geom::Point2D const &  position,
afw::image::Color const &  color 
) const
overrideprotectedvirtual

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

Definition at line 224 of file CoaddPsf.cc.

224  {
225  afw::table::ExposureCatalog subcat = _catalog.subsetContaining(ccdXY, _coaddWcs, true);
226  if (subcat.empty()) {
227  throw LSST_EXCEPT(
228  pex::exceptions::InvalidParameterError,
229  (boost::format("Cannot compute BBox at point %s; no input images at that point.") % ccdXY)
230  .str());
231  }
232 
233  geom::Box2I ret;
234  for (auto const &exposureRecord : subcat) {
235  // compute transform from exposure pixels to coadd pixels
236  auto exposureToCoadd = afw::geom::makeWcsPairTransform(*exposureRecord.getWcs(), _coaddWcs);
237  WarpedPsf warpedPsf = WarpedPsf(exposureRecord.getPsf(), exposureToCoadd, _warpingControl);
238  geom::Box2I componentBBox = warpedPsf.computeBBox(ccdXY, color);
239  ret.include(componentBBox);
240  }
241 
242  return ret;
243 }
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
ExposureCatalogT subsetContaining(lsst::geom::SpherePoint const &coord, bool includeValidPolygon=false) const
Return a shallow subset of the catalog with only those records that contain the given point.
Definition: Exposure.cc:471
An integer coordinate rectangle.
Definition: Box.h:55
void include(Point2I const &point)
Expand this to ensure that this->contains(point).
Definition: Box.cc:152
std::shared_ptr< TransformPoint2ToPoint2 > makeWcsPairTransform(SkyWcs const &src, SkyWcs const &dst)
A Transform obtained by putting two SkyWcs objects "back to back".
Definition: SkyWcs.cc:146
def format(config, name=None, writeSourceLine=True, prefix="", verbose=False)
Definition: history.py:174

◆ doComputeImage()

std::shared_ptr< Psf::Image > Psf::doComputeImage ( lsst::geom::Point2D const &  position,
image::Color const &  color 
) const
protectedvirtualinherited

These virtual members are protected (rather than private) so that python-implemented derived classes may opt to use the default implementations.

C++ derived classes may override these methods, but should not call them. Derived classes should call the corresponding compute* 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.

Definition at line 199 of file Psf.cc.

200  {
201  std::shared_ptr<Psf::Image> im = computeKernelImage(position, color, COPY);
202  return recenterKernelImage(im, position);
203 }
static std::shared_ptr< Image > recenterKernelImage(std::shared_ptr< Image > im, lsst::geom::Point2D const &position, std::string const &warpAlgorithm="lanczos5", unsigned int warpBuffer=5)
Helper function for Psf::doComputeImage(): converts a kernel image (centered at (0,...
Definition: Psf.cc:85

◆ doComputeImageBBox()

lsst::geom::Box2I Psf::doComputeImageBBox ( lsst::geom::Point2D const &  position,
image::Color const &  color 
) const
protectedvirtualinherited

Definition at line 205 of file Psf.cc.

206  {
207  std::shared_ptr<Psf::Image> im = computeImage(position, color, INTERNAL);
208  return im->getBBox();
209 }

◆ doComputeKernelImage()

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

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

246  {
247  // Get the subset of expoures which contain our coordinate within their validPolygons.
248  afw::table::ExposureCatalog subcat = _catalog.subsetContaining(ccdXY, _coaddWcs, true);
249  if (subcat.empty()) {
250  throw LSST_EXCEPT(
251  pex::exceptions::InvalidParameterError,
252  (boost::format("Cannot compute CoaddPsf at point %s; no input images at that point.") % ccdXY)
253  .str());
254  }
255  double weightSum = 0.0;
256 
257  // Read all the Psf images into a vector. The code is set up so that this can be done in chunks,
258  // with the image modified to accomodate
259  // However, we currently read all of the images.
261  std::vector<double> weightVector;
262 
263  for (auto const &exposureRecord : subcat) {
264  // compute transform from exposure pixels to coadd pixels
265  auto exposureToCoadd = afw::geom::makeWcsPairTransform(*exposureRecord.getWcs(), _coaddWcs);
267  try {
268  WarpedPsf warpedPsf = WarpedPsf(exposureRecord.getPsf(), exposureToCoadd, _warpingControl);
269  componentImg = warpedPsf.computeKernelImage(ccdXY, color);
270  } catch (pex::exceptions::RangeError &exc) {
271  LSST_EXCEPT_ADD(exc, (boost::format("Computing WarpedPsf kernel image for id=%d") %
272  exposureRecord.getId())
273  .str());
274  throw exc;
275  }
276  imgVector.push_back(componentImg);
277  weightSum += exposureRecord.get(_weightKey);
278  weightVector.push_back(exposureRecord.get(_weightKey));
279  }
280 
281  geom::Box2I bbox = getOverallBBox(imgVector);
282 
283  // create a zero image of the right size to sum into
284  std::shared_ptr<afw::detection::Psf::Image> image = std::make_shared<afw::detection::Psf::Image>(bbox);
285  *image = 0.0;
286  addToImage(image, imgVector, weightVector);
287  *image /= weightSum;
288  return image;
289 }
AmpInfoBoxKey bbox
Definition: Amplifier.cc:117
#define LSST_EXCEPT_ADD(e, m)
Add the current location and a message to an existing exception before rethrowing it.
Definition: Exception.h:54
void addToImage(std::shared_ptr< afw::image::Image< double >> image, std::vector< std::shared_ptr< afw::image::Image< double >>> const &imgVector, std::vector< double > const &weightVector)
Definition: CoaddPsf.cc:201
geom::Box2I getOverallBBox(std::vector< std::shared_ptr< afw::image::Image< double >>> const &imgVector)
Definition: CoaddPsf.cc:188
T push_back(T... args)

◆ doComputeShape()

afw::geom::ellipses::Quadrupole lsst::meas::algorithms::ImagePsf::doComputeShape ( geom::Point2D const &  position,
afw::image::Color const &  color 
) const
protectedvirtualinherited

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

Definition at line 56 of file ImagePsf.cc.

57  {
60  *image, geom::Point2D(0.0, 0.0) // image has origin at the center
61  )
62  .getShape();
63 }
static Result computeAdaptiveMoments(ImageT const &image, geom::Point2D const &position, bool negative=false, Control const &ctrl=Control())
Compute the adaptive Gaussian-weighted moments of an image.
Shape const getShape() const
Return an afw::geom::ellipses object corresponding to xx, yy, xy.

◆ dynamicCast() [1/3]

Dynamically cast a shared_ptr.

Dynamically cast a shared pointer and raise on failure.

You must provide an explicit template instantiation in the .cc file for each class that inherits from PersistableFacade. Designed to work around RTTI issues on macOS with hidden symbols;

Exceptions
lsst::pex::exceptions::LogicErrorif the cast fails

param[in] ptr The pointer to be cast.

Returns
The cast pointer.
Exceptions
lsst::pex::exceptions::TypeErrorIf the dynamic cast fails.

Definition at line 218 of file Persistable.cc.

18  {
19  auto result = std::dynamic_pointer_cast<T>(ptr);
20  if (!result) {
21  throw LSST_EXCEPT(pex::exceptions::TypeError, "Dynamic pointer cast failed");
22  }
23  return result;
24 }
uint64_t * ptr
Definition: RangeSet.cc:88

◆ dynamicCast() [2/3]

Dynamically cast a shared_ptr.

Dynamically cast a shared pointer and raise on failure.

You must provide an explicit template instantiation in the .cc file for each class that inherits from PersistableFacade. Designed to work around RTTI issues on macOS with hidden symbols;

Exceptions
lsst::pex::exceptions::LogicErrorif the cast fails

param[in] ptr The pointer to be cast.

Returns
The cast pointer.
Exceptions
lsst::pex::exceptions::TypeErrorIf the dynamic cast fails.

Definition at line 218 of file Persistable.cc.

18  {
19  auto result = std::dynamic_pointer_cast<T>(ptr);
20  if (!result) {
21  throw LSST_EXCEPT(pex::exceptions::TypeError, "Dynamic pointer cast failed");
22  }
23  return result;
24 }

◆ dynamicCast() [3/3]

Dynamically cast a shared_ptr.

Dynamically cast a shared pointer and raise on failure.

You must provide an explicit template instantiation in the .cc file for each class that inherits from PersistableFacade. Designed to work around RTTI issues on macOS with hidden symbols;

Exceptions
lsst::pex::exceptions::LogicErrorif the cast fails

param[in] ptr The pointer to be cast.

Returns
The cast pointer.
Exceptions
lsst::pex::exceptions::TypeErrorIf the dynamic cast fails.

Definition at line 218 of file Persistable.cc.

18  {
19  auto result = std::dynamic_pointer_cast<T>(ptr);
20  if (!result) {
21  throw LSST_EXCEPT(pex::exceptions::TypeError, "Dynamic pointer cast failed");
22  }
23  return result;
24 }

◆ equals()

bool lsst::afw::typehandling::Storable::equals ( Storable const &  other) const
virtualnoexceptinherited

Compare this object to another Storable.

Subclasses that implement equality comparison must override this method to give results consistent with operator== for all inputs that are accepted by both.

Returns
This implementation returns whether the two objects are the same.
Warning
This method compares an object to any type of Storable, although cross-class comparisons should usually return false. If cross-class comparisons are valid, implementers should take care that they are symmetric and will give the same result no matter what the compile-time types of the left- and right-hand sides are.
See also
singleClassEquals
Note
When called on Python classes, this method delegates to __eq__ if it exists.

Reimplemented in lsst::afw::image::VisitInfo, lsst::afw::image::PhotoCalib, lsst::afw::geom::SkyWcs, lsst::afw::geom::polygon::Polygon, and lsst::afw::typehandling::StorableHelper< Base >.

Definition at line 48 of file Storable.cc.

48 { return this == &other; }

◆ getAverageColor()

image::Color lsst::afw::detection::Psf::getAverageColor ( ) const
inlineinherited

Return the average Color of the stars used to construct the Psf.

This is also the Color used to return an image if you don't specify a Color.

Definition at line 274 of file Psf.h.

274 { return image::Color(); }
Describe the colour of a source.
Definition: Color.h:26

◆ getAveragePosition()

geom::Point2D lsst::meas::algorithms::CoaddPsf::getAveragePosition ( ) const
inlineoverridevirtual

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 115 of file CoaddPsf.h.

115 { return _averagePosition; }

◆ getBBox()

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]indexIndex of component for which the bounding box will be fetched.
Returns
Corresponding bounding box.
Exceptions
RangeErrorIndex of component is out of range.

Definition at line 328 of file CoaddPsf.cc.

328  {
329  if (index < 0 || index >= getComponentCount()) {
330  throw LSST_EXCEPT(pex::exceptions::RangeError, "index of CoaddPsf component out of range");
331  }
332  return _catalog[index].getBBox();
333 }
int getComponentCount() const
Return the number of component Psfs in this CoaddPsf.
Definition: CoaddPsf.cc:291

◆ getCacheCapacity()

std::size_t Psf::getCacheCapacity ( ) const
inherited

Return the capacity of the caches.

Both the image and kernel image caches have the same capacity.

Definition at line 213 of file Psf.cc.

213 { return _kernelImageCache->capacity(); }

◆ getCoaddWcs()

afw::geom::SkyWcs lsst::meas::algorithms::CoaddPsf::getCoaddWcs ( )
inline

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

Definition at line 118 of file CoaddPsf.h.

118 { return _coaddWcs; }

◆ getComponentCount()

int lsst::meas::algorithms::CoaddPsf::getComponentCount ( ) const

Return the number of component Psfs in this CoaddPsf.

Definition at line 291 of file CoaddPsf.cc.

291 { return _catalog.size(); }
size_type size() const
Return the number of elements in the catalog.
Definition: Catalog.h:413

◆ getId()

afw::table::RecordId lsst::meas::algorithms::CoaddPsf::getId ( int  index)

Get the exposure ID of the component image at index.

Parameters
[in]indexIndex of component for which the exposure ID will be fetched.
Returns
Corresponding exposure ID.
Exceptions
RangeErrorIndex of component is out of range.

Definition at line 321 of file CoaddPsf.cc.

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

◆ getLocalKernel() [1/2]

std::shared_ptr< math::Kernel const > Psf::getLocalKernel ( ) const
inherited

Definition at line 155 of file Psf.cc.

155  {
156  return getLocalKernel(makeNullPoint());
157 }
std::shared_ptr< math::Kernel const > getLocalKernel() const
Definition: Psf.cc:155

◆ getLocalKernel() [2/2]

std::shared_ptr< math::Kernel const > Psf::getLocalKernel ( lsst::geom::Point2D  position,
image::Color  color = image::Color() 
) const
inherited

Return a FixedKernel corresponding to the Psf image at the given point.

Parameters
[in]positionPosition at which to evaluate the PSF.
[in]colorColor of the source for which to evaluate the PSF; defaults to getAverageColor().

This is implemented by calling computeKernelImage, and is simply provided for convenience.

Definition at line 159 of file Psf.cc.

160  {
161  if (isPointNull(position)) position = getAveragePosition();
162  if (color.isIndeterminate()) color = getAverageColor();
163  // FixedKernel ctor will deep copy image, so we can use INTERNAL.
165  return std::make_shared<math::FixedKernel>(*image);
166 }

◆ getPersistenceName()

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

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

425 { return getCoaddPsfPersistenceName(); }

◆ getPsf()

std::shared_ptr< afw::detection::Psf const > lsst::meas::algorithms::CoaddPsf::getPsf ( int  index)

Get the Psf of the component image at index.

Parameters
[in]indexIndex of component for which the Psf will be fetched.
Returns
Corresponding Psf.
Exceptions
RangeErrorIndex of component is out of range.

Definition at line 293 of file CoaddPsf.cc.

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

◆ getPythonModule()

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

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

427 { return "lsst.meas.algorithms"; }

◆ getValidPolygon()

std::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]indexIndex of component for which the bounding box will be fetched.
Returns
Corresponding validPolygon.
Exceptions
RangeErrorIndex of component is out of range.

Definition at line 307 of file CoaddPsf.cc.

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

◆ getWcs()

afw::geom::SkyWcs lsst::meas::algorithms::CoaddPsf::getWcs ( int  index)

Get the Wcs of the component image at index.

Parameters
[in]indexIndex of component for which the Wcs will be fetched.
Returns
Corresponding Wcs.
Exceptions
RangeErrorIndex of component is out of range.

Definition at line 300 of file CoaddPsf.cc.

300  {
301  if (index < 0 || index >= getComponentCount()) {
302  throw LSST_EXCEPT(pex::exceptions::RangeError, "index of CoaddPsf component out of range");
303  }
304  return *_catalog[index].getWcs();
305 }

◆ getWeight()

double lsst::meas::algorithms::CoaddPsf::getWeight ( int  index)

Get the weight of the component image at index.

Parameters
[in]indexIndex of component for which the weight will be fetched.
Returns
Corresponding weight.
Exceptions
RangeErrorIndex of component is out of range.

Definition at line 314 of file CoaddPsf.cc.

314  {
315  if (index < 0 || index >= getComponentCount()) {
316  throw LSST_EXCEPT(pex::exceptions::RangeError, "index of CoaddPsf component out of range");
317  }
318  return _catalog[index].get(_weightKey);
319 }
std::shared_ptr< RecordT > const get(size_type i) const
Return a pointer to the record at index i.
Definition: Catalog.h:464

◆ hash_value()

std::size_t lsst::afw::typehandling::Storable::hash_value ( ) const
virtualinherited

Return a hash of this object (optional operation).

Exceptions
UnsupportedOperationExceptionThrown if this object is not hashable.
Note
C++ subclass authors are responsible for any associated specializations of std::hash.
When called on Python classes, this method delegates to __hash__ if it exists.

Reimplemented in lsst::afw::typehandling::StorableHelper< Base >, lsst::afw::image::VisitInfo, lsst::afw::image::FilterLabel, and lsst::afw::geom::polygon::Polygon.

Definition at line 44 of file Storable.cc.

44  {
45  throw LSST_EXCEPT(UnsupportedOperationException, "Hashes are not supported.");
46 }

◆ isPersistable()

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

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 186 of file CoaddPsf.h.

186 { return true; }

◆ readFits() [1/9]

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

Read an object from an already open FITS object.

Parameters
[in]fitsfileFITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

183  {
184  return dynamicCast(Persistable::_readFits(fitsfile));
185  }
static std::shared_ptr< CoaddPsf > dynamicCast(std::shared_ptr< Persistable > const &ptr)
Dynamically cast a shared_ptr.
Definition: Persistable.cc:18

◆ readFits() [2/9]

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

Read an object from an already open FITS object.

Parameters
[in]fitsfileFITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

183  {
184  return dynamicCast(Persistable::_readFits(fitsfile));
185  }

◆ readFits() [3/9]

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

Read an object from an already open FITS object.

Parameters
[in]fitsfileFITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

183  {
184  return dynamicCast(Persistable::_readFits(fitsfile));
185  }

◆ readFits() [4/9]

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

Read an object from a FITS file in memory.

Parameters
[in]managerManager for the memory to read from.
[in]hduHDU 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.

205  {
206  return dynamicCast(Persistable::_readFits(manager, hdu));
207  }

◆ readFits() [5/9]

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

Read an object from a FITS file in memory.

Parameters
[in]managerManager for the memory to read from.
[in]hduHDU 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.

205  {
206  return dynamicCast(Persistable::_readFits(manager, hdu));
207  }

◆ readFits() [6/9]

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

Read an object from a FITS file in memory.

Parameters
[in]managerManager for the memory to read from.
[in]hduHDU 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.

205  {
206  return dynamicCast(Persistable::_readFits(manager, hdu));
207  }

◆ readFits() [7/9]

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

Read an object from a regular FITS file.

Parameters
[in]fileNameName of the file to read.
[in]hduHDU 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.

194  {
195  return dynamicCast(Persistable::_readFits(fileName, hdu));
196  }

◆ readFits() [8/9]

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

Read an object from a regular FITS file.

Parameters
[in]fileNameName of the file to read.
[in]hduHDU 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.

194  {
195  return dynamicCast(Persistable::_readFits(fileName, hdu));
196  }

◆ readFits() [9/9]

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

Read an object from a regular FITS file.

Parameters
[in]fileNameName of the file to read.
[in]hduHDU 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.

194  {
195  return dynamicCast(Persistable::_readFits(fileName, hdu));
196  }

◆ recenterKernelImage()

std::shared_ptr< image::Image< double > > Psf::recenterKernelImage ( std::shared_ptr< Image im,
lsst::geom::Point2D const &  position,
std::string const &  warpAlgorithm = "lanczos5",
unsigned int  warpBuffer = 5 
)
staticinherited

Helper function for Psf::doComputeImage(): converts a kernel image (centered at (0,0) when xy0 is taken into account) to an image centered at position when xy0 is taken into account.

warpAlgorithm is passed to afw::math::makeWarpingKernel() and can be "nearest", "bilinear", or "lanczosN"

warpBuffer zero-pads the image before recentering. Recommended value is 1 for bilinear, N for lanczosN (note that it would be cleaner to infer this value from the warping algorithm but this would require mild API changes; same issue occurs in e.g. afw::math::offsetImage()).

The point with integer coordinates (0,0) in the source image (with xy0 taken into account) corresponds to the point position in the destination image. If position is not integer-valued then we will need to fractionally shift the image using interpolation.

Note: if fractional recentering is performed, then a new image will be allocated and returned. If not, then the original image will be returned (after setting XY0).

Definition at line 85 of file Psf.cc.

88  {
89  // "ir" : (integer, residual)
90  std::pair<int, double> const irX = image::positionToIndex(position.getX(), true);
91  std::pair<int, double> const irY = image::positionToIndex(position.getY(), true);
92 
93  if (irX.second != 0.0 || irY.second != 0.0) {
94  im = math::offsetImage(*im, irX.second, irY.second, warpAlgorithm, warpBuffer);
95  }
96 
97  im->setXY0(irX.first + im->getX0(), irY.first + im->getY0());
98  return im;
99 }
int positionToIndex(double pos)
Convert image position to nearest integer index.
Definition: ImageUtils.h:69
std::shared_ptr< ImageT > offsetImage(ImageT const &image, float dx, float dy, std::string const &algorithmName="lanczos5", unsigned int buffer=0)
Return an image offset by (dx, dy) using the specified algorithm.
Definition: offsetImage.cc:41

◆ resized()

std::shared_ptr< afw::detection::Psf > lsst::meas::algorithms::CoaddPsf::resized ( int  width,
int  height 
) const
overridevirtual

Return a clone with specified kernel dimensions.

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

Definition at line 181 of file CoaddPsf.cc.

181  {
182  // Not implemented for WarpedPsf
183  throw LSST_EXCEPT(pex::exceptions::LogicError, "Not Implemented");
184 }

◆ setCacheCapacity()

void Psf::setCacheCapacity ( std::size_t  capacity)
inherited

Set the capacity of the caches.

Both the image and kernel image caches will be set to this capacity.

Definition at line 215 of file Psf.cc.

215  {
216  _imageCache->reserve(capacity);
217  _kernelImageCache->reserve(capacity);
218 }

◆ singleClassEquals()

template<class T >
static bool lsst::afw::typehandling::Storable::singleClassEquals ( T const &  lhs,
Storable const &  rhs 
)
inlinestaticprotectedinherited

Test if a Storable is of a particular class and equal to another object.

This method template simplifies implementations of equals that delegate to operator== without supporting cross-class comparisons.

Template Parameters
TThe class expected of the two objects to be compared.
Parameters
lhs,rhsThe objects to compare. Note that rhs need not be a T, while lhs must be.
Returns
true if rhs is a T and lhs == rhs; false otherwise.
Exception Safety
Provides the same level of exception safety as operator==. Most implementations of operator== do not throw.
Note
This method template calls operator== with both arguments of compile-time type T const&. Its use is not recommended if there would be any ambiguity as to which operator== gets picked by overload resolution.

This method template is typically called from equals as:

bool MyType::equals(Storable const& other) const noexcept {
    return singleClassEquals(*this, other);
}

Definition at line 151 of file Storable.h.

151  {
152  auto typedRhs = dynamic_cast<T const*>(&rhs);
153  if (typedRhs != nullptr) {
154  return lhs == *typedRhs;
155  } else {
156  return false;
157  }
158  }

◆ toString()

std::string lsst::afw::typehandling::Storable::toString ( ) const
virtualinherited

Create a string representation of this object (optional operation).

Exceptions
UnsupportedOperationExceptionThrown if this object does not have a string representation.
Note
When called on Python classes, this method delegates to __repr__.

Reimplemented in lsst::afw::typehandling::StorableHelper< Base >, lsst::afw::image::VisitInfo, lsst::afw::image::PhotoCalib, lsst::afw::image::FilterLabel, lsst::afw::geom::SkyWcs, and lsst::afw::geom::polygon::Polygon.

Definition at line 40 of file Storable.cc.

40  {
41  throw LSST_EXCEPT(UnsupportedOperationException, "No string representation available.");
42 }

◆ write()

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

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

429  {
430  CoaddPsfPersistenceHelper const &keys1 = CoaddPsfPersistenceHelper::get();
431  afw::table::BaseCatalog cat1 = handle.makeCatalog(keys1.schema);
432  std::shared_ptr<afw::table::BaseRecord> record1 = cat1.addNew();
433  auto coaddWcsPtr = std::make_shared<afw::geom::SkyWcs>(_coaddWcs);
434  record1->set(keys1.coaddWcs, handle.put(coaddWcsPtr));
435  record1->set(keys1.cacheSize, _warpingControl->getCacheSize());
436  record1->set(keys1.averagePosition, _averagePosition);
437  record1->set(keys1.warpingKernelName, _warpingKernelName);
438  handle.saveCatalog(cat1);
439  _catalog.writeToArchive(handle, false);
440 }
void writeToArchive(io::OutputArchiveHandle &handle, bool ignoreUnpersistable=true) const
Convenience output function for Persistables that contain an ExposureCatalog.
Definition: Exposure.cc:444
CatalogT< BaseRecord > BaseCatalog
Definition: fwd.h:72

◆ writeFits() [1/3]

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

Write the object to an already-open FITS object.

Parameters
[in]fitsfileOpen FITS object to write to.

Definition at line 18 of file Persistable.cc.

18  {
19  OutputArchive archive;
20  archive.put(this);
21  archive.writeFits(fitsfile);
22 }

◆ 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]managerName of the file to write to.
[in]modeIf "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

Definition at line 29 of file Persistable.cc.

29  {
30  fits::Fits fitsfile(manager, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
31  writeFits(fitsfile);
32 }
void writeFits(std::string const &fileName, std::string const &mode="w") const
Write the object to a regular FITS file.
Definition: Persistable.cc:24

◆ writeFits() [3/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]fileNameName of the file to write to.
[in]modeIf "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

Definition at line 24 of file Persistable.cc.

24  {
25  fits::Fits fitsfile(fileName, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
26  writeFits(fitsfile);
27 }

Friends And Related Function Documentation

◆ operator<<()

std::ostream & operator<< ( std::ostream os,
Storable const &  storable 
)
related

Output operator for Storable.

Parameters
osthe desired output stream
storablethe object to print
Returns
a reference to os
Exceptions
UnsupportedOperationExceptionThrown if storable does not have an implementation of Storable::toString.

Definition at line 174 of file Storable.h.

174  {
175  return os << storable.toString();
176 }
std::ostream * os
Definition: Schema.cc:557

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