lsst.meas.base  20.0.0-3-g750bffe+f7c3f762b4
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
schema
table::Schema schema
CatalogT< BaseRecord >::end
iterator end()
lsst::afw::image::Measurement::error
double const error
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::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::afw::table::BaseRecord::get
Field< T >::Value get(Key< T > const &key) const
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
FluxUtilities.h
lsst::afw::table::Schema
lsst::afw::table::SortedCatalogT::const_iterator
Base::const_iterator const_iterator
lsst::meas::base::MagResultKey
A FunctorKey for MagResult.
Definition: FluxUtilities.h:138
lsst::afw::geom::SkyWcs
name
string name
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::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
result
std::unique_ptr< SchemaItem< U > > result
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
lsst::meas::base::BaseTransform::_name
std::string _name
Definition: Transform.h:107
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::meas::base::BaseTransform::checkCatalogSize
void checkCatalogSize(afw::table::BaseCatalog const &cat1, afw::table::BaseCatalog const &cat2) const
Ensure that catalogs have the same size.
Definition: Transform.h:102
lsst::afw::table::BaseRecord
CatalogT< BaseRecord >::iterator
CatalogIterator< typename Internal::iterator > iterator
lsst::afw::table::SchemaMapper
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::afw::image::PhotoCalib
BaseRecord.h
lsst
Transform.h
lsst::meas::base::Flux
double Flux
Definition: constants.h:51
photoCalib
Key< int > photoCalib
lsst::meas::base::FluxResult::FluxResult
FluxResult()
Default constructor; initializes everything to NaN.
Definition: FluxUtilities.cc:32
lsst::afw::image::Measurement::value
double const value
lsst::afw::image::Measurement
std
STL namespace.
mapper
SchemaMapper * mapper
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
lsst::afw::table::BaseRecord::set
void set(Key< T > const &key, U const &value)
lsst::meas::base::BaseTransform
Abstract base class for all C++ measurement transformations.
Definition: Transform.h:86
CatalogT< BaseRecord >::begin
iterator begin()
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::MagResult
A reusable result struct for magnitudes.
Definition: FluxUtilities.h:127
CatalogT< BaseRecord >
lsst::afw::table::SortedCatalogT