LSST Applications
21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
|
"Trampoline" for Psf to let it be used as a base class in Python. More...
#include <python.h>
Public Types | |
using | Image = typename Base::Image |
Public Member Functions | |
template<typename... Args> | |
PsfTrampoline (Args... args) | |
Delegating constructor for wrapped class. More... | |
std::shared_ptr< Psf > | clone () const override |
std::shared_ptr< Psf > | resized (int width, int height) const override |
lsst::geom::Point2D | getAveragePosition () const override |
std::shared_ptr< Image > | doComputeImage (lsst::geom::Point2D const &position, image::Color const &color) const override |
lsst::geom::Box2I | doComputeImageBBox (lsst::geom::Point2D const &position, image::Color const &color) const override |
std::shared_ptr< Image > | doComputeKernelImage (lsst::geom::Point2D const &position, image::Color const &color) const override |
double | doComputeApertureFlux (double radius, lsst::geom::Point2D const &position, image::Color const &color) const override |
geom::ellipses::Quadrupole | doComputeShape (lsst::geom::Point2D const &position, image::Color const &color) const override |
lsst::geom::Box2I | doComputeBBox (lsst::geom::Point2D const &position, image::Color const &color) const override |
std::shared_ptr< Storable > | cloneStorable () const override |
Create a new object that is a copy of this one (optional operation). More... | |
std::string | toString () const override |
Create a string representation of this object (optional operation). More... | |
std::size_t | hash_value () const override |
Return a hash of this object (optional operation). More... | |
bool | equals (Storable const &other) const noexcept override |
Compare this object to another Storable. More... | |
bool | isPersistable () const noexcept override |
Return true if this particular object can be persisted using afw::table::io. More... | |
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 (table::io::OutputArchiveHandle &handle) const override |
Write the object to one or more catalogs. 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... | |
Protected Types | |
using | OutputArchiveHandle = io::OutputArchiveHandle |
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::ostream & | operator<< (std::ostream &os, Storable const &storable) |
Output operator for Storable. More... | |
"Trampoline" for Psf to let it be used as a base class in Python.
Subclasses of Psf that are wrapped in pybind11 should have a similar helper that subclasses PsfTrampoline<subclass>
. This helper can be skipped if the subclass neither adds any virtual methods nor implements any abstract methods.
Base | the exact (most specific) class being wrapped |
using lsst::afw::detection::PsfTrampoline< Base >::Image = typename Base::Image |
|
protectedinherited |
Definition at line 108 of file Persistable.h.
|
inlineexplicit |
Delegating constructor for wrapped class.
While we would like to simply inherit base class constructors, when doing so, we cannot change their access specifiers. One consequence is that it's not possible to use inheritance to expose a protected constructor to python. The alternative, used here, is to create a new public constructor that delegates to the base class public or protected constructor with the same signature.
Args | Variadic type specification |
...args | Arguments to forward to the Base class constructor. |
Definition at line 1 of file python.h.
|
inlineoverride |
Definition at line 69 of file python.h.
|
inlineoverridevirtualinherited |
Create a new object that is a copy of this one (optional operation).
This operation is required for Storables that are stored in GenericMap by value, but not for those stored by shared pointer.
UnsupportedOperationException | Thrown if this object is not cloneable. |
clone
operation, the two should behave identically except for the formal return type.__deepcopy__
if it exists. Reimplemented from lsst::afw::typehandling::Storable.
Definition at line 73 of file python.h.
|
inlineoverride |
Definition at line 112 of file python.h.
|
inlineoverride |
Definition at line 130 of file python.h.
|
inlineoverride |
Definition at line 85 of file python.h.
|
inlineoverride |
Definition at line 94 of file python.h.
|
inlineoverride |
Definition at line 103 of file python.h.
|
inlineoverride |
Definition at line 121 of file python.h.
|
inlineoverridevirtualnoexceptinherited |
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.
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.__eq__
if it exists. Reimplemented from lsst::afw::typehandling::Storable.
Definition at line 88 of file python.h.
|
inlineoverride |
Definition at line 80 of file python.h.
|
inlineoverridevirtualinherited |
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 98 of file python.h.
|
inlineoverridevirtualinherited |
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 104 of file python.h.
|
inlineoverridevirtualinherited |
Return a hash of this object (optional operation).
UnsupportedOperationException | Thrown if this object is not hashable. |
__hash__
if it exists. Reimplemented from lsst::afw::typehandling::Storable.
Definition at line 84 of file python.h.
|
inlineoverridevirtualnoexceptinherited |
Return true if this particular object can be persisted using afw::table::io.
Reimplemented from lsst::afw::table::io::Persistable.
Definition at line 92 of file python.h.
|
inlineoverride |
Definition at line 76 of file python.h.
|
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.
T | The class expected of the two objects to be compared. |
lhs,rhs | The objects to compare. Note that rhs need not be a T , while lhs must be. |
true
if rhs
is a T
and lhs == rhs
; false
otherwise.operator==
. Most implementations of operator==
do not throw.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.
|
inlineoverridevirtualinherited |
Create a string representation of this object (optional operation).
UnsupportedOperationException | Thrown if this object does not have a string representation. |
__repr__
. Reimplemented from lsst::afw::typehandling::Storable.
Definition at line 80 of file python.h.
|
overridevirtualinherited |
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 193 of file python.h.
|
inherited |
Write the object to an already-open FITS object.
[in] | fitsfile | Open FITS object to write to. |
Definition at line 18 of file Persistable.cc.
|
inherited |
Write the object to a FITS image in memory.
[in] | manager | Name of the file to write to. |
[in] | mode | If "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file. |
Definition at line 29 of file Persistable.cc.
|
inherited |
Write the object to a regular FITS file.
[in] | fileName | Name of the file to write to. |
[in] | mode | If "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file. |
Definition at line 24 of file Persistable.cc.
|
related |
Output operator for Storable.
os | the desired output stream |
storable | the object to print |
os
UnsupportedOperationException | Thrown if storable does not have an implementation of Storable::toString. |
Definition at line 174 of file Storable.h.