LSST Applications g013ef56533+7c9321ec0f,g042eb84c57+c6cfa41bc3,g199a45376c+0ba108daf9,g1fd858c14a+fcad0d0313,g210f2d0738+c0f94c6586,g262e1987ae+a7e710680e,g29ae962dfc+fb55f2edb0,g2ac17093b6+61d6563b1e,g2b1d02342f+df6f932764,g2cef7863aa+aef1011c0b,g2f7ad74990+c0f94c6586,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53cf87ae69,g47891489e3+4316d04fff,g511e8cfd20+baa56acf6c,g53246c7159+8c5ae1fdc5,g54cd7ddccb+fd7ad03fde,g64539dfbff+c0f94c6586,g67b6fd64d1+4316d04fff,g67fd3c3899+c0f94c6586,g6985122a63+4316d04fff,g74acd417e5+ca833bee28,g786e29fd12+668abc6043,g81db2e9a8d+b2ec8e584f,g87389fa792+8856018cbb,g89139ef638+4316d04fff,g8d7436a09f+0a24083b20,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+11eb8fd5b8,gbf99507273+8c5ae1fdc5,gcdda8b9158+e4c84c9d5c,gce8aa8abaa+8c5ae1fdc5,gd7ef33dd92+4316d04fff,gdab6d2f7ff+ca833bee28,ge410e46f29+4316d04fff,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.40
LSST Data Management Base Package
Loading...
Searching...
No Matches
_peak.cc
Go to the documentation of this file.
1/*
2 * This file is part of afw.
3 *
4 * Developed for the LSST Data Management System.
5 * This product includes software developed by the LSST Project
6 * (https://www.lsst.org).
7 * See the COPYRIGHT file at the top-level directory of this distribution
8 * for details of code ownership.
9 *
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation, either version 3 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 */
23
24#include "pybind11/pybind11.h"
25
26#include <memory>
27#include <sstream>
28
30
36
37namespace py = pybind11;
38using namespace py::literals;
39
40namespace lsst {
41namespace afw {
42namespace detection {
43
44namespace {
45
46using PyPeakRecord = py::classh<PeakRecord, table::BaseRecord>;
47using PyPeakTable = py::classh<PeakTable, table::BaseTable>;
48
52void declarePeakRecord(PyPeakRecord &cls) {
53 cls.def("getTable", &PeakRecord::getTable);
54 cls.def_property_readonly("table", &PeakRecord::getTable);
55 cls.def("getId", &PeakRecord::getId);
56 cls.def("setId", &PeakRecord::setId);
57 cls.def("getIx", &PeakRecord::getIx);
58 cls.def("getIy", &PeakRecord::getIy);
59 cls.def("setIx", &PeakRecord::setIx);
60 cls.def("setIy", &PeakRecord::setIy);
61 cls.def("getI", &PeakRecord::getI);
62 cls.def("getCentroid", (lsst::geom::Point2I(PeakRecord::*)(bool) const) & PeakRecord::getCentroid);
63 cls.def("getCentroid", (lsst::geom::Point2D(PeakRecord::*)() const) & PeakRecord::getCentroid);
64 cls.def("getFx", &PeakRecord::getFx);
65 cls.def("getFy", &PeakRecord::getFy);
66 cls.def("setFx", &PeakRecord::setFx);
67 cls.def("setFy", &PeakRecord::setFy);
68 cls.def("getF", &PeakRecord::getF);
69 cls.def("getPeakValue", &PeakRecord::getPeakValue);
70 cls.def("setPeakValue", &PeakRecord::setPeakValue);
71 cpputils::python::addOutputOp(cls, "__str__");
72 cpputils::python::addOutputOp(cls, "__repr__");
73}
74
78void declarePeakTable(PyPeakTable &cls) {
79 cls.def_static("make", &PeakTable::make, "schema"_a, "forceNew"_a = false);
80 cls.def_static("makeMinimalSchema", &PeakTable::makeMinimalSchema);
81 cls.def_static("checkSchema", &PeakTable::checkSchema, "schema"_a);
82 cls.def("getIdFactory", (std::shared_ptr<table::IdFactory>(PeakTable::*)()) & PeakTable::getIdFactory);
83 cls.def("setIdFactory", &PeakTable::setIdFactory, "factory"_a);
84 cls.def_static("getIdKey", &PeakTable::getIdKey);
85 cls.def_static("getIxKey", &PeakTable::getIxKey);
86 cls.def_static("getIyKey", &PeakTable::getIyKey);
87 cls.def_static("getFxKey", &PeakTable::getFxKey);
88 cls.def_static("getFyKey", &PeakTable::getFyKey);
89 cls.def_static("getPeakValueKey", &PeakTable::getPeakValueKey);
90 cls.def("clone", &PeakTable::clone);
91 cls.def("makeRecord", &PeakTable::makeRecord);
92 cls.def("copyRecord", (std::shared_ptr<PeakRecord>(PeakTable::*)(afw::table::BaseRecord const &)) &
94 cls.def("copyRecord", (std::shared_ptr<PeakRecord>(PeakTable::*)(afw::table::BaseRecord const &,
95 afw::table::SchemaMapper const &)) &
97}
98
99} // namespace
100
102 wrappers.addInheritanceDependency("lsst.afw.table");
103
104 auto clsPeakRecord = wrappers.wrapType(PyPeakRecord(wrappers.module, "PeakRecord"),
105 [](auto &mod, auto &cls) { declarePeakRecord(cls); });
106 auto clsPeakTable = wrappers.wrapType(PyPeakTable(wrappers.module, "PeakTable"),
107 [](auto &mod, auto &cls) { declarePeakTable(cls); });
108
109 auto clsPeakColumnView = table::python::declareColumnView<PeakRecord>(wrappers, "Peak");
110 auto clsPeakCatalog = table::python::declareCatalog<PeakRecord>(wrappers, "Peak");
111
112 clsPeakRecord.attr("Table") = clsPeakTable;
113 clsPeakRecord.attr("ColumnView") = clsPeakColumnView;
114 clsPeakRecord.attr("Catalog") = clsPeakCatalog;
115 clsPeakTable.attr("Record") = clsPeakRecord;
116 clsPeakTable.attr("ColumnView") = clsPeakColumnView;
117 clsPeakTable.attr("Catalog") = clsPeakCatalog;
118 clsPeakCatalog.attr("Record") = clsPeakRecord;
119 clsPeakCatalog.attr("Table") = clsPeakTable;
120 clsPeakCatalog.attr("ColumnView") = clsPeakColumnView;
121}
122
123} // namespace detection
124} // namespace afw
125} // namespace lsst
Record class that represents a peak in a Footprint.
Definition Peak.h:42
lsst::geom::Point2I getI() const
Definition Peak.h:81
lsst::geom::Point2I getCentroid(bool) const
Definition Peak.h:82
std::shared_ptr< PeakTable const > getTable() const
Definition Peak.h:68
lsst::geom::Point2D getF() const
Definition Peak.h:88
void setPeakValue(float peakValue)
Definition Peak.h:241
void setId(afw::table::RecordId id)
Definition Peak.h:228
afw::table::RecordId getId() const
Convenience accessors for the keys in the minimal schema.
Definition Peak.h:227
Table class for Peaks in Footprints.
Definition Peak.h:102
std::shared_ptr< PeakRecord > copyRecord(afw::table::BaseRecord const &other)
Deep-copy a record, requiring that it have the same schema as this table.
Definition Peak.h:179
static afw::table::Key< afw::table::RecordId > getIdKey()
Get keys for standard fields shared by all peaks.
Definition Peak.h:164
static afw::table::Schema makeMinimalSchema()
Return a minimal schema for Peak tables and records.
Definition Peak.h:137
static afw::table::Key< float > getPeakValueKey()
Definition Peak.h:169
static afw::table::Key< float > getFyKey()
Definition Peak.h:168
std::shared_ptr< PeakRecord > makeRecord()
Default-construct an associated record.
Definition Peak.h:176
std::shared_ptr< PeakTable > clone() const
Return a polymorphic deep copy of the table.
Definition Peak.h:173
std::shared_ptr< afw::table::IdFactory > getIdFactory()
Return the object that generates IDs for the table (may be null).
Definition Peak.h:150
static std::shared_ptr< PeakTable > make(afw::table::Schema const &schema, bool forceNew=false)
Obtain a table that can be used to create records with given schema.
Definition Peak.cc:96
static afw::table::Key< int > getIxKey()
Definition Peak.h:165
void setIdFactory(std::shared_ptr< afw::table::IdFactory > f)
Switch to a new IdFactory – object that generates IDs for the table (may be null).
Definition Peak.h:156
static afw::table::Key< float > getFxKey()
Definition Peak.h:167
static afw::table::Key< int > getIyKey()
Definition Peak.h:166
static bool checkSchema(afw::table::Schema const &other)
Return true if the given schema is a valid PeakTable schema.
Definition Peak.h:145
A helper class for subdividing pybind11 module across multiple translation units (i....
Definition python.h:242
void addInheritanceDependency(std::string const &name)
Indicate an external module that provides a base class for a subsequent addType call.
Definition python.h:343
PyType wrapType(PyType cls, ClassWrapperCallback function, bool setModuleName=true)
Add a type (class or enum) wrapper, deferring method and other attribute definitions until finish() i...
Definition python.h:391
pybind11::module module
The module object passed to the PYBIND11_MODULE block that contains this WrapperCollection.
Definition python.h:448
void wrapPeak(WrapperCollection &)
Definition _peak.cc:101
PyCatalog< Record > declareCatalog(cpputils::python::WrapperCollection &wrappers, std::string const &name, bool isBase=false)
Wrap an instantiation of lsst::afw::table::CatalogT<Record>.
Definition catalog.h:276
PyColumnView< Record > declareColumnView(cpputils::python::WrapperCollection &wrappers, std::string const &name, bool isBase=false)
Declare member and static functions for a given instantiation of lsst::afw::table::ColumnViewT<Record...
Definition columnView.h:52
void addOutputOp(PyClass &cls, std::string const &method)
Add __str__ or __repr__ method implemented by operator<<.
Definition python.h:87
Point< double, 2 > Point2D
Definition Point.h:324
Point< int, 2 > Point2I
Definition Point.h:321