LSST Applications  21.0.0-147-g0e635eb1+1acddb5be5,22.0.0+052faf71bd,22.0.0+1ea9a8b2b2,22.0.0+6312710a6c,22.0.0+729191ecac,22.0.0+7589c3a021,22.0.0+9f079a9461,22.0.1-1-g7d6de66+b8044ec9de,22.0.1-1-g87000a6+536b1ee016,22.0.1-1-g8e32f31+6312710a6c,22.0.1-10-gd060f87+016f7cdc03,22.0.1-12-g9c3108e+df145f6f68,22.0.1-16-g314fa6d+c825727ab8,22.0.1-19-g93a5c75+d23f2fb6d8,22.0.1-19-gb93eaa13+aab3ef7709,22.0.1-2-g8ef0a89+b8044ec9de,22.0.1-2-g92698f7+9f079a9461,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gac51dbf+052faf71bd,22.0.1-2-gb66926d+6312710a6c,22.0.1-2-gcb770ba+09e3807989,22.0.1-20-g32debb5+b8044ec9de,22.0.1-23-gc2439a9a+fb0756638e,22.0.1-3-g496fd5d+09117f784f,22.0.1-3-g59f966b+1e6ba2c031,22.0.1-3-g849a1b8+f8b568069f,22.0.1-3-gaaec9c0+c5c846a8b1,22.0.1-32-g5ddfab5d3+60ce4897b0,22.0.1-4-g037fbe1+64e601228d,22.0.1-4-g8623105+b8044ec9de,22.0.1-5-g096abc9+d18c45d440,22.0.1-5-g15c806e+57f5c03693,22.0.1-7-gba73697+57f5c03693,master-g6e05de7fdc+c1283a92b8,master-g72cdda8301+729191ecac,w.2021.39
LSST Data Management Base Package
FluxUtilities.cc
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 
27 
28 namespace lsst {
29 namespace meas {
30 namespace base {
31 
33  : instFlux(std::numeric_limits<meas::base::Flux>::quiet_NaN()),
34  instFluxErr(std::numeric_limits<meas::base::FluxErrElement>::quiet_NaN()) {}
35 
37  std::string const& doc) {
39  result._instFlux = schema.addField<meas::base::Flux>(schema.join(name, "instFlux"), doc, "count");
40  result._instFluxErr = schema.addField<meas::base::FluxErrElement>(
41  schema.join(name, "instFluxErr"), "1-sigma instFlux uncertainty", "count");
42  return result;
43 }
44 
46  FluxResult r;
47  r.instFlux = record.get(_instFlux);
48  r.instFluxErr = record.get(_instFluxErr);
49  return r;
50 }
51 
52 void FluxResultKey::set(afw::table::BaseRecord& record, FluxResult const& value) const {
53  record.set(_instFlux, value.instFlux);
54  record.set(_instFluxErr, value.instFluxErr);
55 }
56 
59  result._magKey = schema.addField<Mag>(schema.join(name, "mag"), "Magnitude");
60  result._magErrKey = schema.addField<MagErrElement>(schema.join(name, "magErr"), "Error on magnitude");
61  return result;
62 }
63 
65  MagResult result = {record.get(_magKey), record.get(_magErrKey)};
66  return result;
67 }
68 
69 void MagResultKey::set(afw::table::BaseRecord& record, MagResult const& magResult) const {
70  record.set(_magKey, magResult.mag);
71  record.set(_magErrKey, magResult.magErr);
72 }
73 
74 void MagResultKey::set(afw::table::BaseRecord& record, afw::image::Measurement const& magResult) const {
75  record.set(_magKey, magResult.value);
76  record.set(_magErrKey, magResult.error);
77 }
78 
80  : BaseTransform{name} {
81  // Map the flag through to the output
82  mapper.addMapping(mapper.getInputSchema().find<afw::table::Flag>(name + "_flag").key);
83 
84  // Add keys for the magnitude and associated error
85  _magKey = MagResultKey::addFields(mapper.editOutputSchema(), name);
86 }
87 
89  afw::table::BaseCatalog& outputCatalog, afw::geom::SkyWcs const& wcs,
90  afw::image::PhotoCalib const& photoCalib) const {
91  checkCatalogSize(inputCatalog, outputCatalog);
92  FluxResultKey instFluxKey(inputCatalog.getSchema()[_name]);
93  afw::table::SourceCatalog::const_iterator inSrc = inputCatalog.begin();
94  afw::table::BaseCatalog::iterator outSrc = outputCatalog.begin();
95  {
96  for (; inSrc != inputCatalog.end() && outSrc != outputCatalog.end(); ++inSrc, ++outSrc) {
97  FluxResult instFluxResult = instFluxKey.get(*inSrc);
98  _magKey.set(*outSrc,
99  photoCalib.instFluxToMagnitude(instFluxResult.instFlux, instFluxResult.instFluxErr));
100  }
101  }
102 }
103 
104 } // namespace base
105 } // namespace meas
106 } // namespace lsst
py::object result
Definition: _schema.cc:429
table::Key< std::string > name
Definition: Amplifier.cc:116
SchemaMapper * mapper
Definition: SchemaMapper.cc:71
table::Key< table::Array< std::uint8_t > > wcs
Definition: SkyWcs.cc:66
table::Schema schema
Definition: python.h:134
A 2-dimensional celestial WCS that transform pixels to ICRS RA/Dec, using the LSST standard for pixel...
Definition: SkyWcs.h:117
The photometric calibration of an exposure.
Definition: PhotoCalib.h:114
Base class for all records.
Definition: BaseRecord.h:31
void set(Key< T > const &key, U const &value)
Set value of a field for the given key.
Definition: BaseRecord.h:164
Field< T >::Value get(Key< T > const &key) const
Return the value of a field for the given key.
Definition: BaseRecord.h:151
Iterator class for CatalogT.
Definition: Catalog.h:40
iterator begin()
Iterator access.
Definition: Catalog.h:401
Defines the fields and offsets for a table.
Definition: Schema.h:51
A mapping between the keys of two Schemas, used to copy data between them.
Definition: SchemaMapper.h:21
typename Base::const_iterator const_iterator
Definition: SortedCatalog.h:50
Abstract base class for all C++ measurement transformations.
Definition: Transform.h:86
void checkCatalogSize(afw::table::BaseCatalog const &cat1, afw::table::BaseCatalog const &cat2) const
Ensure that catalogs have the same size.
Definition: Transform.h:102
A FunctorKey for FluxResult.
Definition: FluxUtilities.h:59
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...
virtual FluxResult get(afw::table::BaseRecord const &record) const
Get a FluxResult from the given record.
virtual void set(afw::table::BaseRecord &record, FluxResult const &other) const
Set a FluxResult in the given record.
virtual void operator()(afw::table::SourceCatalog const &inputCatalog, afw::table::BaseCatalog &outputCatalog, afw::geom::SkyWcs const &wcs, afw::image::PhotoCalib const &photoCalib) const
FluxTransform(std::string const &name, afw::table::SchemaMapper &mapper)
A FunctorKey for MagResult.
virtual void set(afw::table::BaseRecord &record, MagResult const &magResult) const
Set a MagResult in the given record.
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.
virtual MagResult get(afw::table::BaseRecord const &record) const
Get a MagResult from the given record.
This defines the base of measurement transformations.
double MagErrElement
Definition: constants.h:54
double FluxErrElement
Definition: constants.h:52
A base class for image defects.
STL namespace.
A value and its error.
Definition: PhotoCalib.h:51
A reusable result struct for instFlux measurements.
Definition: FluxUtilities.h:41
meas::base::Flux instFlux
Measured instFlux in DN.
Definition: FluxUtilities.h:42
meas::base::FluxErrElement instFluxErr
Standard deviation of instFlux in DN.
Definition: FluxUtilities.h:43
FluxResult()
Default constructor; initializes everything to NaN.
A reusable result struct for magnitudes.
Key< int > photoCalib
Definition: Exposure.cc:67