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
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
28namespace lsst {
29namespace meas {
30namespace 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) {
38 FluxResultKey result;
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
52void FluxResultKey::set(afw::table::BaseRecord& record, FluxResult const& value) const {
53 record.set(_instFlux, value.instFlux);
54 record.set(_instFluxErr, value.instFluxErr);
55}
56
58 os << "instFlux=" << result.instFlux << ", instFluxErr=" << result.instFluxErr;
59 return os;
60}
61
63 MagResultKey result;
64 result._magKey = schema.addField<Mag>(schema.join(name, "mag"), "Magnitude");
65 result._magErrKey = schema.addField<MagErrElement>(schema.join(name, "magErr"), "Error on magnitude");
66 return result;
67}
68
70 MagResult result = {record.get(_magKey), record.get(_magErrKey)};
71 return result;
72}
73
74void MagResultKey::set(afw::table::BaseRecord& record, MagResult const& magResult) const {
75 record.set(_magKey, magResult.mag);
76 record.set(_magErrKey, magResult.magErr);
77}
78
80 record.set(_magKey, magResult.value);
81 record.set(_magErrKey, magResult.error);
82}
83
85 : BaseTransform{name} {
86 // Map the flag through to the output
87 mapper.addMapping(mapper.getInputSchema().find<afw::table::Flag>(name + "_flag").key);
88
89 // Add keys for the magnitude and associated error
90 _magKey = MagResultKey::addFields(mapper.editOutputSchema(), name);
91}
92
94 afw::table::BaseCatalog& outputCatalog, afw::geom::SkyWcs const& wcs,
95 afw::image::PhotoCalib const& photoCalib) const {
96 checkCatalogSize(inputCatalog, outputCatalog);
97 FluxResultKey instFluxKey(inputCatalog.getSchema()[_name]);
98 afw::table::SourceCatalog::const_iterator inSrc = inputCatalog.begin();
99 afw::table::BaseCatalog::iterator outSrc = outputCatalog.begin();
100 {
101 for (; inSrc != inputCatalog.end() && outSrc != outputCatalog.end(); ++inSrc, ++outSrc) {
102 FluxResult instFluxResult = instFluxKey.get(*inSrc);
103 _magKey.set(*outSrc,
104 photoCalib.instFluxToMagnitude(instFluxResult.instFlux, instFluxResult.instFluxErr));
105 }
106 }
107}
108
109} // namespace base
110} // namespace meas
111} // namespace lsst
A 2-dimensional celestial WCS that transform pixels to ICRS RA/Dec, using the LSST standard for pixel...
Definition SkyWcs.h:118
The photometric calibration of an exposure.
Definition PhotoCalib.h:114
Base class for all records.
Definition BaseRecord.h:31
Field< T >::Value get(Key< T > const &key) const
Return the value of a field for the given key.
Definition BaseRecord.h:151
void set(Key< T > const &key, U const &value)
Set value of a field for the given key.
Definition BaseRecord.h:164
CatalogIterator< typename Internal::iterator > iterator
Definition Catalog.h:110
iterator begin()
Iterator access.
Definition Catalog.h:401
Defines the fields and offsets for a table.
Definition Schema.h:51
SchemaItem< T > find(std::string const &name) const
Find a SchemaItem in the Schema by name.
Definition Schema.cc:467
A mapping between the keys of two Schemas, used to copy data between them.
Key< T > addMapping(Key< T > const &inputKey, bool doReplace=false)
Add a new field to the output Schema that is a copy of a field in the input Schema.
Schema & editOutputSchema()
Return a reference to the output schema that allows it to be modified in place.
Schema const getInputSchema() const
Return the input schema (copy-on-write).
typename Base::const_iterator const_iterator
void checkCatalogSize(afw::table::BaseCatalog const &cat1, afw::table::BaseCatalog const &cat2) const
Ensure that catalogs have the same size.
Definition Transform.h:102
BaseTransform(std::string const &name)
Definition Transform.h:88
A FunctorKey for FluxResult.
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...
FluxResultKey()
Default constructor; instance will not be usuable unless subsequently assigned to.
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)
virtual void set(afw::table::BaseRecord &record, MagResult const &magResult) const
Set a MagResult in the given record.
MagResultKey()
Default constructor; instance will not be usuable unless subsequently assigned to.
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.
CatalogT< BaseRecord > BaseCatalog
Definition fwd.h:72
double MagErrElement
Definition constants.h:54
std::ostream & operator<<(std::ostream &os, CentroidResult const &result)
double FluxErrElement
Definition constants.h:52
STL namespace.
A value and its error.
Definition PhotoCalib.h:51
A reusable result struct for instFlux measurements.
meas::base::Flux instFlux
Measured instFlux in DN.
meas::base::FluxErrElement instFluxErr
Standard deviation of instFlux in DN.
FluxResult()
Default constructor; initializes everything to NaN.
A reusable result struct for magnitudes.