PsfTrampoline< Base > Class Template Reference

"Trampoline" for Psf to let it be used as a base class in Python. More...

#include <python.h>

Inheritance diagram for PsfTrampoline< Base >:

Public Types
using	Image = typename Base::Image

Public Member Functions
template<typename... Args>
	PsfTrampoline (Args... args)
	Delegating constructor for wrapped class.
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

Detailed Description

template<typename Base = Psf>
class PsfTrampoline< Base >

"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.

Template Parameters

Base	the exact (most specific) class being wrapped

See also

pybind11 documentation

Definition at line 50 of file python.h.

Member Typedef Documentation

Image

template<typename Base = Psf>

using lsst::afw::detection::PsfTrampoline< Base >::Image = typename Base::Image

Definition at line 52 of file python.h.

Constructor & Destructor Documentation

PsfTrampoline()

template<typename Base = Psf>

template<typename... Args>

lsst::afw::detection::PsfTrampoline< Base >::PsfTrampoline ( Args... args )

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.

Template Parameters

Args	Variadic type specification

Parameters

...args

Arguments to forward to the Base class constructor.

Definition at line 1 of file python.h.

: StorableHelper<Base>(args...) {}

Member Function Documentation

clone()

template<typename Base = Psf>

std::shared_ptr< Psf > lsst::afw::detection::PsfTrampoline< Base >::clone ( ) const

inlineoverride

Definition at line 69 of file python.h.

                                              {
        /* __deepcopy__ takes an optional dict, but PYBIND11_OVERLOAD_* won't
         * compile unless you give it arguments that work for the C++ method
         */
        PYBIND11_OVERLOAD_PURE_NAME(std::shared_ptr<Psf>, Base, "__deepcopy__", clone,);
    }

doComputeApertureFlux()

template<typename Base = Psf>

double lsst::afw::detection::PsfTrampoline< Base >::doComputeApertureFlux ( double radius, lsst::geom::Point2D const & position, image::Color const & color ) const

inlineoverride

Definition at line 112 of file python.h.

                     {
        PYBIND11_OVERLOAD_PURE_NAME(
            double, Base, "_doComputeApertureFlux", doComputeApertureFlux, radius, position, color
        );
    }

doComputeBBox()

template<typename Base = Psf>

lsst::geom::Box2I lsst::afw::detection::PsfTrampoline< Base >::doComputeBBox ( lsst::geom::Point2D const & position, image::Color const & color ) const

inlineoverride

Definition at line 130 of file python.h.

                     {
        PYBIND11_OVERLOAD_PURE_NAME(
            lsst::geom::Box2I, Base, "_doComputeBBox", doComputeBBox, position, color
        );
    }

doComputeImage()

template<typename Base = Psf>

std::shared_ptr< Image > lsst::afw::detection::PsfTrampoline< Base >::doComputeImage ( lsst::geom::Point2D const & position, image::Color const & color ) const

inlineoverride

Definition at line 85 of file python.h.

                     {
        PYBIND11_OVERLOAD_NAME(
            std::shared_ptr<Image>, Base, "_doComputeImage", doComputeImage, position, color
        );
    }

doComputeImageBBox()

template<typename Base = Psf>

lsst::geom::Box2I lsst::afw::detection::PsfTrampoline< Base >::doComputeImageBBox ( lsst::geom::Point2D const & position, image::Color const & color ) const

inlineoverride

Definition at line 94 of file python.h.

                     {
        PYBIND11_OVERLOAD_NAME(
            lsst::geom::Box2I, Base, "_doComputeImageBBox", doComputeImageBBox, position, color
        );
    }

doComputeKernelImage()

template<typename Base = Psf>

std::shared_ptr< Image > lsst::afw::detection::PsfTrampoline< Base >::doComputeKernelImage ( lsst::geom::Point2D const & position, image::Color const & color ) const

inlineoverride

Definition at line 103 of file python.h.

                     {
        PYBIND11_OVERLOAD_PURE_NAME(
            std::shared_ptr<Image>, Base, "_doComputeKernelImage", doComputeKernelImage, position, color
        );
    }

doComputeShape()

template<typename Base = Psf>

geom::ellipses::Quadrupole lsst::afw::detection::PsfTrampoline< Base >::doComputeShape ( lsst::geom::Point2D const & position, image::Color const & color ) const

inlineoverride

Definition at line 121 of file python.h.

                     {
        PYBIND11_OVERLOAD_PURE_NAME(
            geom::ellipses::Quadrupole, Base, "_doComputeShape", doComputeShape, position, color
        );
    }

getAveragePosition()

template<typename Base = Psf>

lsst::geom::Point2D lsst::afw::detection::PsfTrampoline< Base >::getAveragePosition ( ) const

inlineoverride

Definition at line 80 of file python.h.

                                                        {
        PYBIND11_OVERLOAD(lsst::geom::Point2D, Base, getAveragePosition,);
    }

resized()

template<typename Base = Psf>

std::shared_ptr< Psf > lsst::afw::detection::PsfTrampoline< Base >::resized ( int width, int height ) const

inlineoverride

Definition at line 76 of file python.h.

                                                                     {
        PYBIND11_OVERLOAD_PURE(std::shared_ptr<Psf>, Base, resized, width, height);
    }

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-10.0.0/Linux64/afw/g8048e755c2+a1301e4c20/include/lsst/afw/detection/python.h