LSST Applications g04c3c9f7ca+2075667efa,g1e125bf412+5f448d5fcf,g2079a07aa2+3e9fd84d81,g2305ad1205+b635cf1488,g2bbee38e9b+6c6beb4891,g337abbeb29+6c6beb4891,g33d1c0ed96+6c6beb4891,g3a166c0a6a+6c6beb4891,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+42f171e1e6,g5c3423f6d4+d536b04327,g607f77f49a+d536b04327,g6f43f06aed+ca1339dc19,g858d7b2824+d536b04327,g8ee334c5b4+d7f9608c2f,g9963eaa53e+b3dc1655d3,g998f4353bf+d536b04327,g99cad8db69+8ef2408349,g9ddcbc5298+9a081db1e4,ga1e77700b3+2cbb763275,gadfd92a7e4+aec2f3b930,gae0086650b+585e252eca,gb0e22166c9+0e73c8378f,gb3b7280ab2+cb5fdb229e,gbb8dafda3b+a327199e22,gc120e1dc64+88074880ea,gc28159a63d+6c6beb4891,gcdd4ae20e8+bd241b2308,gcde1bda545+903e937d91,gcf0d15dbbd+bd241b2308,gdaeeff99f8+f9a426f77a,gddc38dedce+585e252eca,ge79ae78c31+6c6beb4891,gfbcc870c63+b310236976,w.2024.23
LSST Data Management Base Package
Loading...
Searching...
No Matches
Peak.h
Go to the documentation of this file.
1// -*- lsst-c++ -*-
2/*
3 * LSST Data Management System
4 * Copyright 2008-2014 LSST Corporation.
5 *
6 * This product includes software developed by the
7 * LSST Project (http://www.lsst.org/).
8 *
9 * This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the LSST License Statement and
20 * the GNU General Public License along with this program. If not,
21 * see <http://www.lsstcorp.org/LegalNotices/>.
22 */
23#ifndef AFW_DETECTION_Peak_h_INCLUDED
24#define AFW_DETECTION_Peak_h_INCLUDED
25
31
32namespace lsst {
33namespace afw {
34namespace detection {
35
36class PeakRecord;
37class PeakTable;
38
43public:
48
59 BaseRecord(token, std::move(data))
60 {}
61
62 ~PeakRecord() override = default;
63 PeakRecord(PeakRecord const&) = delete;
65 PeakRecord& operator=(PeakRecord const&) = delete;
67
69 return std::static_pointer_cast<PeakTable const>(afw::table::BaseRecord::getTable());
70 }
71
73
76
77 int getIx() const;
78 int getIy() const;
79 void setIx(int ix);
80 void setIy(int iy);
82 lsst::geom::Point2I getCentroid(bool) const { return getI(); }
83
84 float getFx() const;
85 float getFy() const;
86 void setFx(float fx);
87 void setFy(float fy);
89 lsst::geom::Point2D getCentroid() const { return getF(); }
90
91 float getPeakValue() const;
92 void setPeakValue(float peakValue);
94
95private:
96 friend class PeakTable;
97};
98
103public:
108
109 ~PeakTable() override;
110 PeakTable& operator=(PeakTable const&) = delete;
112
128 static std::shared_ptr<PeakTable> make(afw::table::Schema const& schema, bool forceNew = false);
129
137 static afw::table::Schema makeMinimalSchema() { return getMinimalSchema().schema; }
138
145 static bool checkSchema(afw::table::Schema const& other) {
146 return other.contains(getMinimalSchema().schema);
147 }
148
151
154
157
159
164 static afw::table::Key<afw::table::RecordId> getIdKey() { return getMinimalSchema().id; }
165 static afw::table::Key<int> getIxKey() { return getMinimalSchema().ix; }
166 static afw::table::Key<int> getIyKey() { return getMinimalSchema().iy; }
167 static afw::table::Key<float> getFxKey() { return getMinimalSchema().fx; }
168 static afw::table::Key<float> getFyKey() { return getMinimalSchema().fy; }
169 static afw::table::Key<float> getPeakValueKey() { return getMinimalSchema().peakValue; }
171
173 std::shared_ptr<PeakTable> clone() const { return std::static_pointer_cast<PeakTable>(_clone()); }
174
176 std::shared_ptr<PeakRecord> makeRecord() { return std::static_pointer_cast<PeakRecord>(_makeRecord()); }
177
180 return std::static_pointer_cast<PeakRecord>(afw::table::BaseTable::copyRecord(other));
181 }
182
186 return std::static_pointer_cast<PeakRecord>(afw::table::BaseTable::copyRecord(other, mapper));
187 }
188
189protected:
191
192 PeakTable(PeakTable const& other);
193 PeakTable(PeakTable&& other);
194
196
198
199private:
200 // Struct that holds the minimal schema and the special keys we've added to it.
201 struct MinimalSchema {
202 afw::table::Schema schema;
208 afw::table::Key<float> peakValue;
209
210 MinimalSchema();
211 };
212
213 // Return the singleton minimal schema.
214 static MinimalSchema& getMinimalSchema();
215
217
218 // Return a writer object that knows how to save in FITS format. See also FitsWriter.
220 int flags) const override;
221
222 std::shared_ptr<afw::table::IdFactory> _idFactory; // generates IDs for new records
223};
224
226
229
230inline int PeakRecord::getIx() const { return get(PeakTable::getIxKey()); }
231inline int PeakRecord::getIy() const { return get(PeakTable::getIyKey()); }
232inline void PeakRecord::setIx(int ix) { set(PeakTable::getIxKey(), ix); }
233inline void PeakRecord::setIy(int iy) { set(PeakTable::getIyKey(), iy); }
234
235inline float PeakRecord::getFx() const { return get(PeakTable::getFxKey()); }
236inline float PeakRecord::getFy() const { return get(PeakTable::getFyKey()); }
237inline void PeakRecord::setFx(float fx) { set(PeakTable::getFxKey(), fx); }
238inline void PeakRecord::setFy(float fy) { set(PeakTable::getFyKey(), fy); }
239
240inline float PeakRecord::getPeakValue() const { return get(PeakTable::getPeakValueKey()); }
241inline void PeakRecord::setPeakValue(float peakValue) { set(PeakTable::getPeakValueKey(), peakValue); }
242
246} // namespace detection
247} // namespace afw
248} // namespace lsst
249
250#endif // !AFW_DETECTION_Peak_h_INCLUDED
char * data
Definition BaseRecord.cc:61
SchemaMapper * mapper
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
PeakRecord(ConstructionToken const &token, table::detail::RecordData &&data)
Constructor used by PeakTable.
Definition Peak.h:58
lsst::geom::Point2D getCentroid() const
Definition Peak.h:89
std::shared_ptr< PeakTable const > getTable() const
Definition Peak.h:68
PeakRecord & operator=(PeakRecord &&)=delete
lsst::geom::Point2D getF() const
Definition Peak.h:88
PeakRecord(PeakRecord const &)=delete
void setPeakValue(float peakValue)
Definition Peak.h:241
PeakRecord(PeakRecord &&)=delete
PeakRecord & operator=(PeakRecord const &)=delete
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
~PeakRecord() override=default
Table class for Peaks in Footprints.
Definition Peak.h:102
std::shared_ptr< afw::table::BaseTable > _clone() const override
Clone implementation with noncovariant return types.
Definition Peak.cc:160
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
PeakTable(afw::table::Schema const &schema, std::shared_ptr< afw::table::IdFactory > const &idFactory)
Definition Peak.cc:130
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
PeakTable & operator=(PeakTable &&)=delete
static afw::table::Key< float > getPeakValueKey()
Definition Peak.h:169
static afw::table::Key< float > getFyKey()
Definition Peak.h:168
std::shared_ptr< afw::table::BaseRecord > _makeRecord() override
Default-construct an associated record (protected implementation).
Definition Peak.cc:164
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
PeakTable & operator=(PeakTable const &)=delete
std::shared_ptr< afw::table::IdFactory > getIdFactory()
Return the object that generates IDs for the table (may be null).
Definition Peak.h:150
std::shared_ptr< afw::table::io::FitsWriter > makeFitsWriter(fits::Fits *fitsfile, int flags) const override
Definition Peak.cc:156
std::shared_ptr< afw::table::IdFactory const > getIdFactory() const
Return the object that generates IDs for the table (may be null).
Definition Peak.h:153
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
std::shared_ptr< PeakRecord > copyRecord(afw::table::BaseRecord const &other, afw::table::SchemaMapper const &mapper)
Deep-copy a record, requiring that it have the same schema as this table.
Definition Peak.h:184
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 simple struct that combines the two arguments that must be passed to most cfitsio routines and cont...
Definition fits.h:308
Tag types used to declare specialized field types.
Definition misc.h:31
Base class for all records.
Definition BaseRecord.h:31
Field< T >::Value get(Key< T > const &key) const
Return the value of a field for the given key.
Definition BaseRecord.h:151
std::shared_ptr< BaseTable const > getTable() const
Return the table this record is associated with.
Definition BaseRecord.h:83
Base class for all tables.
Definition BaseTable.h:61
std::shared_ptr< BaseRecord > copyRecord(BaseRecord const &input)
Deep-copy a record, requiring that it have the same schema as this table.
Definition BaseTable.cc:126
Defines the fields and offsets for a table.
Definition Schema.h:51
int contains(Schema const &other, int flags=EQUAL_KEYS) const
Test whether the given schema is a subset of this.
Definition Schema.cc:490
A mapping between the keys of two Schemas, used to copy data between them.
Writer object for FITS binary tables.
Definition FitsWriter.h:25
daf::base::PropertySet * set
Definition fits.cc:931
std::ostream & operator<<(std::ostream &os, Footprint const &rhs)
Print a Footprint to the stream.
Definition Footprint.cc:443
Point< double, 2 > Point2D
Definition Point.h:324
Point< int, 2 > Point2I
Definition Point.h:321
STL namespace.
Helper struct that contains the information passed from BaseTable to BaseRecord at construction.
Definition BaseTable.h:32