LSSTApplications  17.0+11,17.0+34,17.0+56,17.0+57,17.0+59,17.0+7,17.0-1-g377950a+33,17.0.1-1-g114240f+2,17.0.1-1-g4d4fbc4+28,17.0.1-1-g55520dc+49,17.0.1-1-g5f4ed7e+52,17.0.1-1-g6dd7d69+17,17.0.1-1-g8de6c91+11,17.0.1-1-gb9095d2+7,17.0.1-1-ge9fec5e+5,17.0.1-1-gf4e0155+55,17.0.1-1-gfc65f5f+50,17.0.1-1-gfc6fb1f+20,17.0.1-10-g87f9f3f+1,17.0.1-11-ge9de802+16,17.0.1-16-ga14f7d5c+4,17.0.1-17-gc79d625+1,17.0.1-17-gdae4c4a+8,17.0.1-2-g26618f5+29,17.0.1-2-g54f2ebc+9,17.0.1-2-gf403422+1,17.0.1-20-g2ca2f74+6,17.0.1-23-gf3eadeb7+1,17.0.1-3-g7e86b59+39,17.0.1-3-gb5ca14a,17.0.1-3-gd08d533+40,17.0.1-30-g596af8797,17.0.1-4-g59d126d+4,17.0.1-4-gc69c472+5,17.0.1-6-g5afd9b9+4,17.0.1-7-g35889ee+1,17.0.1-7-gc7c8782+18,17.0.1-9-gc4bbfb2+3,w.2019.22
LSSTDataManagementBasePackage
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 
29 #include "lsst/afw/table/Catalog.h"
31 
32 namespace lsst {
33 namespace afw {
34 namespace detection {
35 
36 class PeakRecord;
37 class PeakTable;
38 
43 public:
44  typedef PeakTable Table;
48 
59  BaseRecord(token, std::move(data))
60  {}
61 
62  ~PeakRecord() override = default;
63  PeakRecord(PeakRecord const&) = delete;
64  PeakRecord(PeakRecord&&) = delete;
65  PeakRecord& operator=(PeakRecord const&) = delete;
66  PeakRecord& operator=(PeakRecord&&) = delete;
67 
70  }
71 
75  void setId(afw::table::RecordId id);
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 
95 private:
96  friend class PeakTable;
97 };
98 
103 public:
108 
109  ~PeakTable() override;
110  PeakTable& operator=(PeakTable const&) = delete;
111  PeakTable& operator=(PeakTable&&) = 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 
174 
177 
181  }
182 
187  }
188 
189 protected:
191 
192  PeakTable(PeakTable const& other);
193  PeakTable(PeakTable&& other);
194 
195  std::shared_ptr<afw::table::BaseTable> _clone() const override;
196 
197  std::shared_ptr<afw::table::BaseRecord> _makeRecord() override;
198 
199 private:
200  // Struct that holds the minimal schema and the special keys we've added to it.
201  struct MinimalSchema {
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 
230 inline int PeakRecord::getIx() const { return get(PeakTable::getIxKey()); }
231 inline int PeakRecord::getIy() const { return get(PeakTable::getIyKey()); }
232 inline void PeakRecord::setIx(int ix) { set(PeakTable::getIxKey(), ix); }
233 inline void PeakRecord::setIy(int iy) { set(PeakTable::getIyKey(), iy); }
234 
235 inline float PeakRecord::getFx() const { return get(PeakTable::getFxKey()); }
236 inline float PeakRecord::getFy() const { return get(PeakTable::getFyKey()); }
237 inline void PeakRecord::setFx(float fx) { set(PeakTable::getFxKey(), fx); }
238 inline void PeakRecord::setFy(float fy) { set(PeakTable::getFyKey(), fy); }
239 
240 inline float PeakRecord::getPeakValue() const { return get(PeakTable::getPeakValueKey()); }
241 inline 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
Defines the fields and offsets for a table.
Definition: Schema.h:50
static afw::table::Key< float > getFxKey()
Get keys for standard fields shared by all peaks.
Definition: Peak.h:167
int getIy() const
Convenience accessors for the keys in the minimal schema.
Definition: Peak.h:231
Writer object for FITS binary tables.
Definition: FitsWriter.h:25
friend std::ostream & operator<<(std::ostream &os, BaseRecord const &record)
Write the record&#39;s content out, one field on each line.
Definition: BaseRecord.cc:159
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< PeakRecord > makeRecord()
Default-construct an associated record.
Definition: Peak.h:176
Helper struct that contains the information passed from BaseTable to BaseRecord at construction...
Definition: BaseTable.h:32
static afw::table::Schema makeMinimalSchema()
Return a minimal schema for Peak tables and records.
Definition: Peak.h:137
std::shared_ptr< PeakTable > clone() const
Return a polymorphic deep copy of the table.
Definition: Peak.h:173
A mapping between the keys of two Schemas, used to copy data between them.
Definition: SchemaMapper.h:21
afw::table::CatalogT< PeakRecord > Catalog
Definition: Peak.h:46
afw::table::CatalogT< Record const > ConstCatalog
Definition: Peak.h:107
Table class for Peaks in Footprints.
Definition: Peak.h:102
STL namespace.
lsst::geom::Point2I getI() const
Convenience accessors for the keys in the minimal schema.
Definition: Peak.h:81
PeakRecord & operator=(PeakRecord const &)=delete
table::Key< int > id
Definition: Detector.cc:166
A simple struct that combines the two arguments that must be passed to most cfitsio routines and cont...
Definition: fits.h:297
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:125
static afw::table::Key< float > getPeakValueKey()
Get keys for standard fields shared by all peaks.
Definition: Peak.h:169
float getPeakValue() const
Convenience accessors for the keys in the minimal schema.
Definition: Peak.h:240
std::shared_ptr< PeakTable const > getTable() const
Definition: Peak.h:68
Point< double, 2 > Point2D
Definition: Point.h:324
void setId(afw::table::RecordId id)
Convenience accessors for the keys in the minimal schema.
Definition: Peak.h:228
afw::table::RecordId getId() const
Convenience accessors for the keys in the minimal schema.
Definition: Peak.h:227
static afw::table::Key< float > getFyKey()
Get keys for standard fields shared by all peaks.
Definition: Peak.h:168
void setIy(int iy)
Convenience accessors for the keys in the minimal schema.
Definition: Peak.h:233
afw::table::CatalogT< PeakRecord const > ConstCatalog
Definition: Peak.h:47
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
afw::table::CatalogT< PeakRecord const > ConstPeakCatalog
Definition: Peak.h:245
void setFy(float fy)
Convenience accessors for the keys in the minimal schema.
Definition: Peak.h:238
A base class for image defects.
afw::table::CatalogT< PeakRecord > PeakCatalog
Definition: Peak.h:244
char * data
Definition: BaseRecord.cc:62
afw::table::CatalogT< Record > Catalog
Definition: Peak.h:106
int contains(Schema const &other, int flags=EQUAL_KEYS) const
Test whether the given schema is a subset of this.
Definition: Schema.cc:679
afw::table::ColumnViewT< PeakRecord > PeakColumnView
Definition: Peak.h:243
PeakRecord(ConstructionToken const &token, table::detail::RecordData &&data)
Constructor used by PeakTable.
Definition: Peak.h:58
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
table::Schema schema
Definition: Camera.cc:161
static afw::table::Key< afw::table::RecordId > getIdKey()
Get keys for standard fields shared by all peaks.
Definition: Peak.h:164
T static_pointer_cast(T... args)
int getIx() const
Convenience accessors for the keys in the minimal schema.
Definition: Peak.h:230
Point< int, 2 > Point2I
Definition: Point.h:321
std::shared_ptr< BaseTable const > getTable() const
Return the table this record is associated with.
Definition: BaseRecord.h:83
static bool checkSchema(afw::table::Schema const &other)
Return true if the given schema is a valid PeakTable schema.
Definition: Peak.h:145
afw::table::ColumnViewT< PeakRecord > ColumnView
Definition: Peak.h:105
Base class for all records.
Definition: BaseRecord.h:31
BaseRecord(ConstructionToken const &, detail::RecordData &&data)
Construct a record with uninitialized data.
Definition: BaseRecord.cc:144
A class used as a handle to a particular field in a table.
Definition: fwd.h:45
~PeakRecord() override=default
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< int > getIyKey()
Get keys for standard fields shared by all peaks.
Definition: Peak.h:166
lsst::geom::Point2I getCentroid(bool) const
Convenience accessors for the keys in the minimal schema.
Definition: Peak.h:82
void setPeakValue(float peakValue)
Convenience accessors for the keys in the minimal schema.
Definition: Peak.h:241
void setIx(int ix)
Convenience accessors for the keys in the minimal schema.
Definition: Peak.h:232
ItemVariant const * other
Definition: Schema.cc:56
lsst::geom::Point2D getF() const
Convenience accessors for the keys in the minimal schema.
Definition: Peak.h:88
void setFx(float fx)
Convenience accessors for the keys in the minimal schema.
Definition: Peak.h:237
Record class that represents a peak in a Footprint.
Definition: Peak.h:42
lsst::geom::Point2D getCentroid() const
Convenience accessors for the keys in the minimal schema.
Definition: Peak.h:89
STL class.
afw::table::ColumnViewT< PeakRecord > ColumnView
Definition: Peak.h:45
float getFy() const
Convenience accessors for the keys in the minimal schema.
Definition: Peak.h:236
Base class for all tables.
Definition: BaseTable.h:61
std::ostream * os
Definition: Schema.cc:746
SchemaMapper * mapper
Definition: SchemaMapper.cc:78
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 afw::table::Key< int > getIxKey()
Get keys for standard fields shared by all peaks.
Definition: Peak.h:165
float getFx() const
Convenience accessors for the keys in the minimal schema.
Definition: Peak.h:235