LSST Applications g04e9c324dd+8c5ae1fdc5,g134cb467dc+1b3060144d,g18429d2f64+f642bf4753,g199a45376c+0ba108daf9,g1fd858c14a+2dcf163641,g262e1987ae+7b8c96d2ca,g29ae962dfc+3bd6ecb08a,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53e1a9e7c5,g4595892280+fef73a337f,g47891489e3+2efcf17695,g4d44eb3520+642b70b07e,g53246c7159+8c5ae1fdc5,g67b6fd64d1+2efcf17695,g67fd3c3899+b70e05ef52,g74acd417e5+317eb4c7d4,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+2efcf17695,g8d7436a09f+3be3c13596,g8ea07a8fe4+9f5ccc88ac,g90f42f885a+a4e7b16d9b,g97be763408+ad77d7208f,g9dd6db0277+b70e05ef52,ga681d05dcb+a3f46e7fff,gabf8522325+735880ea63,gac2eed3f23+2efcf17695,gb89ab40317+2efcf17695,gbf99507273+8c5ae1fdc5,gd8ff7fe66e+b70e05ef52,gdab6d2f7ff+317eb4c7d4,gdc713202bf+b70e05ef52,gdfd2d52018+b10e285e0f,ge365c994fd+310e8507c4,ge410e46f29+2efcf17695,geaed405ab2+562b3308c0,gffca2db377+8c5ae1fdc5,w.2025.35
LSST Data Management Base Package
Loading...
Searching...
No Matches
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
32
33namespace lsst { namespace shapelet {
34
45class ShapeletFunctionKey : public afw::table::FunctorKey< ShapeletFunction > {
46public:
47
64 afw::table::Schema & schema,
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,
79 afw::table::ArrayKey<double> const & coefficients,
80 BasisTypeEnum basisType=HERMITE
81 ) :
82 _ellipseKey(ellipse),
83 _coefficientsKey(coefficients),
84 _order(computeOrder(coefficients.getSize())),
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
111 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
133private:
134 afw::table::EllipseKey _ellipseKey;
135 afw::table::ArrayKey<double> _coefficientsKey;
136 int _order;
137 BasisTypeEnum _basisType;
138};
139
140
161class MultiShapeletFunctionKey : public afw::table::FunctorKey< MultiShapeletFunction > {
162public:
163
180 afw::table::Schema & schema,
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
216 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
229private:
231};
232
233}} // namespace lsst::shapelet
234
235#endif // !defined(LSST_AFW_MATH_SHAPELETS_FunctorKeys_h_INCLUDED)
A FunctorKey used to get or set a ndarray::Array from a sequence of scalar Keys.
Definition arrays.h:45
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:447
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.
bool operator!=(MultiShapeletFunctionKey const &other) const
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.
std::shared_ptr< ShapeletFunctionKey > operator[](int n)
Return a FunctorKey to the nth component.
std::shared_ptr< ShapeletFunctionKey const > operator[](int n) const
Return a FunctorKey to the nth component.
bool operator==(MultiShapeletFunctionKey const &other) const
Compare the FunctorKey for equality with another, using the underlying Ixx, Iyy, Ixy Keys.
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.
MultiShapeletFunctionKey(std::vector< std::shared_ptr< ShapeletFunctionKey > > const &components)
Construct from individual Keys/FunctorKeys.
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.
A 2-d function defined by an expansion onto a Gauss-Laguerre or Gauss-Hermite basis.
bool isValid() const
Return True if all the constituent Keys are valid.
ShapeletFunctionKey(afw::table::SubSchema const &s, BasisTypeEnum basisType=HERMITE)
Construct from a subschema, assuming the necesary subfields.
Definition FunctorKeys.h:97
afw::table::ArrayKey< double > const & getCoefficients() const
Return a FunctorKey that extracts just the coefficients.
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.
int getOrder() const
Return the shapelet order.
afw::table::EllipseKey const & getEllipse() const
Return a FunctorKey that extracts just the Ellipse.
ShapeletFunctionKey(afw::table::EllipseKey const &ellipse, afw::table::ArrayKey< double > const &coefficients, BasisTypeEnum basisType=HERMITE)
Construct from individual Keys/FunctorKeys.
Definition FunctorKeys.h:77
bool operator!=(ShapeletFunctionKey const &other) const
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.
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