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
FunctorKeys.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 
24 #ifndef LSST_AFW_MATH_SHAPELETS_FunctorKeys_h_INCLUDED
25 #define LSST_AFW_MATH_SHAPELETS_FunctorKeys_h_INCLUDED
26 
29 #include "lsst/afw/table/arrays.h"
32 
33 namespace lsst { namespace shapelet {
34 
45 class ShapeletFunctionKey : public afw::table::FunctorKey< ShapeletFunction > {
46 public:
47 
65  std::string const & name,
66  std::string const & doc,
67  std::string const & ellipseUnit,
68  std::string const & coeffUnit,
69  int order,
70  BasisTypeEnum basisType=HERMITE
71  );
72 
74  ShapeletFunctionKey() : _ellipseKey(), _coefficientsKey(), _order(-1), _basisType(HERMITE) {}
75 
78  afw::table::EllipseKey const & ellipse,
80  BasisTypeEnum basisType=HERMITE
81  ) :
82  _ellipseKey(ellipse),
83  _coefficientsKey(coefficients),
85  _basisType(basisType)
86  {}
87 
98  _ellipseKey(s), _coefficientsKey(s),
99  _order(computeOrder(_coefficientsKey.getSize())),
100  _basisType(basisType)
101  {}
102 
104  virtual ShapeletFunction get(afw::table::BaseRecord const & record) const;
105 
107  virtual void set(afw::table::BaseRecord & record, ShapeletFunction const & value) const;
108 
110  bool operator==(ShapeletFunctionKey const & other) const {
112  return _order == other._order && _ellipseKey == other._ellipseKey
113  && _coefficientsKey == other._coefficientsKey;
114  }
115  bool operator!=(ShapeletFunctionKey const & other) const { return !(*this == other); }
117 
119  bool isValid() const { return _ellipseKey.isValid() && _coefficientsKey.isValid(); }
120 
122  afw::table::EllipseKey const & getEllipse() const { return _ellipseKey; }
123 
125  afw::table::ArrayKey<double> const & getCoefficients() const { return _coefficientsKey; }
126 
128  int getOrder() const { return _order; }
129 
131  BasisTypeEnum getBasisType() const { return _basisType; }
132 
133 private:
134  afw::table::EllipseKey _ellipseKey;
135  afw::table::ArrayKey<double> _coefficientsKey;
136  int _order;
137  BasisTypeEnum _basisType;
138 };
139 
140 
161 class MultiShapeletFunctionKey : public afw::table::FunctorKey< MultiShapeletFunction > {
162 public:
163 
181  std::string const & name,
182  std::string const & doc,
183  std::string const & ellipseUnit,
184  std::string const & coeffUnit,
185  std::vector<int> const & orders,
186  BasisTypeEnum basisType=HERMITE
187  );
188 
191 
194  _components(components)
195  {}
196 
207 
209  virtual MultiShapeletFunction get(afw::table::BaseRecord const & record) const;
210 
212  virtual void set(afw::table::BaseRecord & record, MultiShapeletFunction const & value) const;
213 
215  bool operator==(MultiShapeletFunctionKey const & other) const;
217  bool operator!=(MultiShapeletFunctionKey const & other) const { return !(*this == other); }
219 
221  bool isValid() const;
222 
224  std::shared_ptr<ShapeletFunctionKey> operator[](int n) { return _components[n]; }
225 
227  std::shared_ptr<ShapeletFunctionKey const> operator[](int n) const { return _components[n]; }
228 
229 private:
231 };
232 
233 }} // namespace lsst::shapelet
234 
235 #endif // !defined(LSST_AFW_MATH_SHAPELETS_FunctorKeys_h_INCLUDED)
table::Key< std::string > name
Definition: Amplifier.cc:116
ndarray::Array< double const, 2, 2 > coefficients
table::Key< table::Array< int > > components
table::Schema schema
Definition: python.h:134
bool isValid() const noexcept
Return True if the FunctorKey contains valid scalar keys.
Definition: arrays.h:137
Base class for all records.
Definition: BaseRecord.h:31
A FunctorKey used to get or set a geom::ellipses::Ellipse from an (xx,yy,xy,x,y) tuple of Keys.
Definition: aggregates.h:360
bool isValid() const noexcept
Return True if all the constituent Keys are valid.
Definition: aggregates.h:418
Convenience base class that combines the OutputFunctorKey and InputFunctorKey.
Definition: FunctorKey.h:74
Defines the fields and offsets for a table.
Definition: Schema.h:51
A proxy type for name lookups in a Schema.
Definition: Schema.h:367
A multi-scale shapelet function.
Class that maps MultiShapeletFunction objects to fields in afw::table objects.
Definition: FunctorKeys.h:161
bool operator!=(MultiShapeletFunctionKey const &other) const
Definition: FunctorKeys.h:217
MultiShapeletFunctionKey(afw::table::SubSchema const &s, BasisTypeEnum basisType=HERMITE)
Construct from a subschema, assuming the necesary subfields.
MultiShapeletFunctionKey()
Default constructor; instance will not be usuable unless subsequently assigned to.
Definition: FunctorKeys.h:190
std::shared_ptr< ShapeletFunctionKey const > operator[](int n) const
Return a FunctorKey to the nth component.
Definition: FunctorKeys.h:227
bool operator==(MultiShapeletFunctionKey const &other) const
Compare the FunctorKey for equality with another, using the underlying Ixx, Iyy, Ixy Keys.
MultiShapeletFunctionKey(std::vector< std::shared_ptr< ShapeletFunctionKey >> const &components)
Construct from individual Keys/FunctorKeys.
Definition: FunctorKeys.h:193
virtual void set(afw::table::BaseRecord &record, MultiShapeletFunction const &value) const
Set a MultiShapeletFunction in the given record.
static MultiShapeletFunctionKey addFields(afw::table::Schema &schema, std::string const &name, std::string const &doc, std::string const &ellipseUnit, std::string const &coeffUnit, std::vector< int > const &orders, BasisTypeEnum basisType=HERMITE)
Add the necessary fields for saving a ShapeletFunction to a Schema.
virtual MultiShapeletFunction get(afw::table::BaseRecord const &record) const
Get a MultiShapeletFunction from the given record.
bool isValid() const
Return True if all the constituent Keys are valid.
std::shared_ptr< ShapeletFunctionKey > operator[](int n)
Return a FunctorKey to the nth component.
Definition: FunctorKeys.h:224
A 2-d function defined by an expansion onto a Gauss-Laguerre or Gauss-Hermite basis.
Class that maps ShapeletFunction objects to fields in afw::table objects.
Definition: FunctorKeys.h:45
bool isValid() const
Return True if all the constituent Keys are valid.
Definition: FunctorKeys.h:119
ShapeletFunctionKey(afw::table::SubSchema const &s, BasisTypeEnum basisType=HERMITE)
Construct from a subschema, assuming the necesary subfields.
Definition: FunctorKeys.h:97
virtual void set(afw::table::BaseRecord &record, ShapeletFunction const &value) const
Set a ShapeletFunction in the given record.
static ShapeletFunctionKey addFields(afw::table::Schema &schema, std::string const &name, std::string const &doc, std::string const &ellipseUnit, std::string const &coeffUnit, int order, BasisTypeEnum basisType=HERMITE)
Add the necessary fields for saving a ShapeletFunction to a Schema.
bool operator==(ShapeletFunctionKey const &other) const
Compare the FunctorKey for equality with another, using the underlying Ixx, Iyy, Ixy Keys.
Definition: FunctorKeys.h:111
int getOrder() const
Return the shapelet order.
Definition: FunctorKeys.h:128
ShapeletFunctionKey(afw::table::EllipseKey const &ellipse, afw::table::ArrayKey< double > const &coefficients, BasisTypeEnum basisType=HERMITE)
Construct from individual Keys/FunctorKeys.
Definition: FunctorKeys.h:77
afw::table::EllipseKey const & getEllipse() const
Return a FunctorKey that extracts just the Ellipse.
Definition: FunctorKeys.h:122
bool operator!=(ShapeletFunctionKey const &other) const
Definition: FunctorKeys.h:115
ShapeletFunctionKey()
Default constructor; instance will not be usuable unless subsequently assigned to.
Definition: FunctorKeys.h:74
BasisTypeEnum getBasisType() const
Return the type of the shapelet basis.
Definition: FunctorKeys.h:131
afw::table::ArrayKey< double > const & getCoefficients() const
Return a FunctorKey that extracts just the coefficients.
Definition: FunctorKeys.h:125
virtual ShapeletFunction get(afw::table::BaseRecord const &record) const
Get a ShapeletFunction from the given record.
int computeOrder(int size)
Infer the order of a shapelet expansion from the number of coefficients.
Definition: constants.h:104
@ HERMITE
Cartesian shapelets or Gauss-Hermite functions, as defined in Refregier, 2003.
Definition: constants.h:53
A base class for image defects.
table::Key< int > order