LSSTApplications
10.0-2-g4f67435,11.0.rc2+1,11.0.rc2+12,11.0.rc2+3,11.0.rc2+4,11.0.rc2+5,11.0.rc2+6,11.0.rc2+7,11.0.rc2+8
LSSTDataManagementBasePackage
|
Represent a PSF as a circularly symmetrical double Gaussian. More...
#include <SingleGaussianPsf.h>
Public Member Functions | |
SingleGaussianPsf (int width, int height, double sigma) | |
Constructor for a SingleGaussianPsf. More... | |
virtual boost::shared_ptr < afw::detection::Psf > | clone () const |
Polymorphic deep copy; should usually unnecessary because Psfs are immutable. More... | |
double | getSigma () const |
Return the radius of the Gaussian. More... | |
virtual bool | isPersistable () const |
Whether the Psf is persistable; always true. More... | |
Public Member Functions inherited from lsst::meas::algorithms::KernelPsf | |
KernelPsf (afw::math::Kernel const &kernel, afw::geom::Point2D const &averagePosition=afw::geom::Point2D()) | |
Construct a KernelPsf with a clone of the given kernel. More... | |
boost::shared_ptr < afw::math::Kernel const > | getKernel () const |
Return the Kernel used to define this Psf. More... | |
virtual afw::geom::Point2D | getAveragePosition () const |
Return average position of stars; used as default position. 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 | |
virtual std::string | getPersistenceName () const |
Return the unique name used to persist this object and look up its factory. More... | |
virtual void | write (OutputArchiveHandle &handle) const |
Write the object to one or more catalogs. More... | |
Protected Member Functions inherited from lsst::meas::algorithms::KernelPsf | |
KernelPsf (boost::shared_ptr< afw::math::Kernel > kernel, afw::geom::Point2D const &averagePosition=afw::geom::Point2D()) | |
Construct a KernelPsf with the given kernel; it should not be modified afterwards. More... | |
virtual std::string | getPythonModule () const |
Return the fully-qualified Python module that should be imported to guarantee that its factory is registered. More... | |
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 Member Functions | |
template<class Archive > | |
void | serialize (Archive &, unsigned int const) |
Private Attributes | |
double | _sigma |
Width of Gaussian. More... | |
Friends | |
class | boost::serialization::access |
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< SingleGaussianPsf > | |
static boost::shared_ptr < SingleGaussianPsf > | readFits (fits::Fits &fitsfile) |
Read an object from an already open FITS object. More... | |
static boost::shared_ptr < SingleGaussianPsf > | readFits (std::string const &fileName, int hdu=0) |
Read an object from a regular FITS file. More... | |
static boost::shared_ptr < SingleGaussianPsf > | 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< KernelPsf > | |
static boost::shared_ptr < KernelPsf > | readFits (fits::Fits &fitsfile) |
Read an object from an already open FITS object. More... | |
static boost::shared_ptr < KernelPsf > | readFits (std::string const &fileName, int hdu=0) |
Read an object from a regular FITS file. More... | |
static boost::shared_ptr < KernelPsf > | 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 |
Represent a PSF as a circularly symmetrical double Gaussian.
Definition at line 37 of file SingleGaussianPsf.h.
|
explicit |
Constructor for a SingleGaussianPsf.
[in] | width | Number of columns in realizations of the PSF at a point. |
[in] | height | Number of rows in realizations of the PSF at a point. |
[in] | sigma | Radius of the Gaussian. |
Additional arguments are historical and ignored, and maybe be removed in the future.
|
virtual |
Polymorphic deep copy; should usually unnecessary because Psfs are immutable.
Reimplemented from lsst::meas::algorithms::KernelPsf.
|
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::meas::algorithms::KernelPsf.
|
inline |
Return the radius of the Gaussian.
Definition at line 55 of file SingleGaussianPsf.h.
|
inlinevirtual |
Whether the Psf is persistable; always true.
Reimplemented from lsst::meas::algorithms::KernelPsf.
Definition at line 58 of file SingleGaussianPsf.h.
|
inlineprivate |
Definition at line 72 of file SingleGaussianPsf.h.
|
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::meas::algorithms::KernelPsf.
|
friend |
Definition at line 70 of file SingleGaussianPsf.h.
|
private |
Width of Gaussian.
Definition at line 67 of file SingleGaussianPsf.h.