LSSTApplications  20.0.0
LSSTDataManagementBasePackage
FluxUtilities.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 /*
3  * LSST Data Management System
4  * Copyright 2008-2015 AURA/LSST.
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_MEAS_BASE_FluxUtilities_h_INCLUDED
25 #define LSST_MEAS_BASE_FluxUtilities_h_INCLUDED
26 
29 #include "lsst/afw/geom/SkyWcs.h"
32 #include "lsst/afw/table/Schema.h"
33 
34 namespace lsst {
35 namespace meas {
36 namespace base {
37 
41 struct FluxResult {
44 
46  FluxResult();
47 
49  explicit FluxResult(meas::base::Flux instFlux_, meas::base::FluxErrElement instFluxErr_)
50  : instFlux(instFlux_), instFluxErr(instFluxErr_) {}
51 };
52 
59 class FluxResultKey : public afw::table::FunctorKey<FluxResult> {
60 public:
73  std::string const& doc);
74 
76  FluxResultKey() : _instFlux(), _instFluxErr() {}
77 
80  afw::table::Key<meas::base::Flux> const& instFlux, // namespace qualification to unconfuse swig
82  : _instFlux(instFlux), _instFluxErr(instFluxErr) {}
83 
94  : _instFlux(s["instFlux"]), _instFluxErr(s["instFluxErr"]) {}
95 
97  virtual FluxResult get(afw::table::BaseRecord const& record) const;
98 
100  virtual void set(afw::table::BaseRecord& record, FluxResult const& other) const;
101 
103  bool operator==(FluxResultKey const& other) const {
105  return _instFlux == other._instFlux && _instFluxErr == other._instFluxErr;
106  }
107  bool operator!=(FluxResultKey const& other) const { return !(*this == other); }
109 
111  bool isValid() const { return _instFlux.isValid() && _instFluxErr.isValid(); }
112 
114  afw::table::Key<meas::base::Flux> getInstFlux() const { return _instFlux; }
115 
117  afw::table::Key<FluxErrElement> getInstFluxErr() const { return _instFluxErr; }
118 
119 private:
121  afw::table::Key<FluxErrElement> _instFluxErr;
122 };
123 
127 struct MagResult {
130 };
131 
138 class MagResultKey : public afw::table::FunctorKey<MagResult> {
139 public:
148 
150  MagResultKey() : _magKey(), _magErrKey() {}
151 
160  MagResultKey(afw::table::SubSchema const& s) : _magKey(s["mag"]), _magErrKey(s["magErr"]) {}
161 
163  virtual MagResult get(afw::table::BaseRecord const& record) const;
164 
166  virtual void set(afw::table::BaseRecord& record, MagResult const& magResult) const;
167 
169  virtual void set(afw::table::BaseRecord& record, afw::image::Measurement const& magnitude) const;
170 
171 private:
172  afw::table::Key<Mag> _magKey;
174 };
175 
187 class FluxTransform : public BaseTransform {
188 public:
190 
191  /*
192  * @brief Perform transformation from inputCatalog to outputCatalog.
193  *
194  * @param[in] inputCatalog Source of data to be transformed
195  * @param[in,out] outputCatalog Container for transformed results
196  * @param[in] wcs World coordinate system under which transformation will take place
197  * @param[in] photoCalib Photometric calibration under which transformation will take place
198  * @throws LengthError Catalog sizes do not match
199  */
200  virtual void operator()(afw::table::SourceCatalog const& inputCatalog,
201  afw::table::BaseCatalog& outputCatalog, afw::geom::SkyWcs const& wcs,
202  afw::image::PhotoCalib const& photoCalib) const;
203 
204 private:
205  MagResultKey _magKey;
206 };
207 
208 } // namespace base
209 } // namespace meas
210 } // namespace lsst
211 
212 #endif // !LSST_MEAS_BASE_FluxUtilities_h_INCLUDED
schema
table::Schema schema
Definition: Amplifier.cc:115
lsst::meas::base::FluxResult::FluxResult
FluxResult(meas::base::Flux instFlux_, meas::base::FluxErrElement instFluxErr_)
Constructor from instFlux and its uncertainty.
Definition: FluxUtilities.h:49
Transform.h
std::string
STL class.
lsst::meas::base::FluxResult::instFlux
meas::base::Flux instFlux
Measured instFlux in DN.
Definition: FluxUtilities.h:42
lsst::meas::base::MagResultKey::set
virtual void set(afw::table::BaseRecord &record, MagResult const &magResult) const
Set a MagResult in the given record.
Definition: FluxUtilities.cc:69
lsst::meas::base::FluxResultKey::getInstFlux
afw::table::Key< meas::base::Flux > getInstFlux() const
Return the underlying instFlux Key.
Definition: FluxUtilities.h:114
lsst::meas::base::FluxErrElement
double FluxErrElement
Definition: constants.h:52
lsst::meas::base::FluxResult
A reusable result struct for instFlux measurements.
Definition: FluxUtilities.h:41
lsst::meas::base::FluxResultKey::get
virtual FluxResult get(afw::table::BaseRecord const &record) const
Get a FluxResult from the given record.
Definition: FluxUtilities.cc:45
lsst::meas::base::MagResultKey::get
virtual MagResult get(afw::table::BaseRecord const &record) const
Get a MagResult from the given record.
Definition: FluxUtilities.cc:64
base
Definition: __init__.py:1
wcs
table::Key< table::Array< std::uint8_t > > wcs
Definition: SkyWcs.cc:71
lsst::afw::table::FunctorKey
Convenience base class that combines the OutputFunctorKey and InputFunctorKey.
Definition: FunctorKey.h:74
SkyWcs.h
lsst::afw::table::Schema
Defines the fields and offsets for a table.
Definition: Schema.h:50
lsst::meas::base::MagResultKey
A FunctorKey for MagResult.
Definition: FluxUtilities.h:138
lsst::afw::geom::SkyWcs
A 2-dimensional celestial WCS that transform pixels to ICRS RA/Dec, using the LSST standard for pixel...
Definition: SkyWcs.h:117
lsst::afw::geom.transform.transformContinued.name
string name
Definition: transformContinued.py:32
lsst::meas::base::Mag
double Mag
Definition: constants.h:53
lsst::meas::base::FluxResultKey
A FunctorKey for FluxResult.
Definition: FluxUtilities.h:59
lsst::meas::base::FluxResultKey::isValid
bool isValid() const
Return True if both the instFlux and instFluxErr Keys are valid.
Definition: FluxUtilities.h:111
lsst::meas::base::MagResult::mag
Mag mag
Definition: FluxUtilities.h:128
lsst::meas::base::FluxResult::instFluxErr
meas::base::FluxErrElement instFluxErr
Standard deviation of instFlux in DN.
Definition: FluxUtilities.h:43
lsst::meas::base::FluxResultKey::FluxResultKey
FluxResultKey()
Default constructor; instance will not be usuable unless subsequently assigned to.
Definition: FluxUtilities.h:76
lsst::meas::base::FluxTransform::FluxTransform
FluxTransform(std::string const &name, afw::table::SchemaMapper &mapper)
Definition: FluxUtilities.cc:79
lsst::meas::base::MagResult::magErr
MagErrElement magErr
Definition: FluxUtilities.h:129
FunctorKey.h
lsst::meas::base::MagErrElement
double MagErrElement
Definition: constants.h:54
lsst::meas::base::FluxResultKey::set
virtual void set(afw::table::BaseRecord &record, FluxResult const &other) const
Set a FluxResult in the given record.
Definition: FluxUtilities.cc:52
lsst::afw::table._source.SourceCatalog
Definition: _source.py:33
other
ItemVariant const * other
Definition: Schema.cc:56
lsst::afw::table::BaseRecord
Base class for all records.
Definition: BaseRecord.h:31
lsst::afw::table::SchemaMapper
A mapping between the keys of two Schemas, used to copy data between them.
Definition: SchemaMapper.h:21
lsst::meas::base::MagResultKey::addFields
static MagResultKey addFields(afw::table::Schema &schema, std::string const &name)
Add a pair of _mag, _magErr fields to a Schema, and return a MagResultKey that points to them.
Definition: FluxUtilities.cc:57
lsst::meas::base::MagResultKey::MagResultKey
MagResultKey()
Default constructor; instance will not be usuable unless subsequently assigned to.
Definition: FluxUtilities.h:150
lsst::afw::table::Key< meas::base::Flux >
lsst::afw::table::Key::isValid
bool isValid() const noexcept
Return true if the key was initialized to valid offset.
Definition: Key.h:97
lsst::meas::base::FluxTransform
Base for instFlux measurement transformations.
Definition: FluxUtilities.h:187
lsst::afw::image::PhotoCalib
The photometric calibration of an exposure.
Definition: PhotoCalib.h:114
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::meas::base::Flux
double Flux
Definition: constants.h:51
photoCalib
Key< int > photoCalib
Definition: Exposure.cc:67
lsst::meas::base::FluxResult::FluxResult
FluxResult()
Default constructor; initializes everything to NaN.
Definition: FluxUtilities.cc:32
lsst::meas::base::FluxResultKey::operator!=
bool operator!=(FluxResultKey const &other) const
Definition: FluxUtilities.h:107
lsst::afw::image::Measurement
A value and its error.
Definition: PhotoCalib.h:51
PhotoCalib.h
Implementation of the Photometric Calibration class.
lsst::afw::table::SubSchema
A proxy type for name lookups in a Schema.
Definition: Schema.h:357
lsst::meas::base::MagResultKey::MagResultKey
MagResultKey(afw::table::SubSchema const &s)
Construct from a subschema, assuming mag and magErr subfields.
Definition: FluxUtilities.h:160
mapper
SchemaMapper * mapper
Definition: SchemaMapper.cc:78
constants.h
lsst::meas::base::FluxResultKey::addFields
static FluxResultKey addFields(afw::table::Schema &schema, std::string const &name, std::string const &doc)
Add a pair of _instFlux, _instFluxErr fields to a Schema, and return a FluxResultKey that points to t...
Definition: FluxUtilities.cc:36
Schema.h
lsst::meas::base::FluxResultKey::operator==
bool operator==(FluxResultKey const &other) const
Compare the FunctorKey for equality with another, using the underlying instFlux and instFluxErr Keys.
Definition: FluxUtilities.h:104
lsst::meas::base::BaseTransform
Abstract base class for all C++ measurement transformations.
Definition: Transform.h:86
lsst::meas::base::FluxTransform::operator()
virtual void operator()(afw::table::SourceCatalog const &inputCatalog, afw::table::BaseCatalog &outputCatalog, afw::geom::SkyWcs const &wcs, afw::image::PhotoCalib const &photoCalib) const
Definition: FluxUtilities.cc:88
lsst::meas::base::FluxResultKey::FluxResultKey
FluxResultKey(afw::table::Key< meas::base::Flux > const &instFlux, afw::table::Key< meas::base::FluxErrElement > const &instFluxErr)
Construct from a pair of Keys.
Definition: FluxUtilities.h:79
lsst::meas::base::MagResult
A reusable result struct for magnitudes.
Definition: FluxUtilities.h:127
lsst::afw::table::CatalogT< BaseRecord >
lsst::meas::base::FluxResultKey::FluxResultKey
FluxResultKey(afw::table::SubSchema const &s)
Construct from a subschema, assuming instFlux and instFluxErr subfields.
Definition: FluxUtilities.h:93
lsst::meas::base::FluxResultKey::getInstFluxErr
afw::table::Key< FluxErrElement > getInstFluxErr() const
Return the underlying instFluxErr Key.
Definition: FluxUtilities.h:117