LSST Applications g04c3c9f7ca+2075667efa,g1e125bf412+5f448d5fcf,g2079a07aa2+3e9fd84d81,g2305ad1205+b635cf1488,g2bbee38e9b+6c6beb4891,g337abbeb29+6c6beb4891,g33d1c0ed96+6c6beb4891,g3a166c0a6a+6c6beb4891,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+42f171e1e6,g5c3423f6d4+d536b04327,g607f77f49a+d536b04327,g6f43f06aed+ca1339dc19,g858d7b2824+d536b04327,g8ee334c5b4+d7f9608c2f,g9963eaa53e+b3dc1655d3,g998f4353bf+d536b04327,g99cad8db69+8ef2408349,g9ddcbc5298+9a081db1e4,ga1e77700b3+2cbb763275,gadfd92a7e4+aec2f3b930,gae0086650b+585e252eca,gb0e22166c9+0e73c8378f,gb3b7280ab2+cb5fdb229e,gbb8dafda3b+a327199e22,gc120e1dc64+88074880ea,gc28159a63d+6c6beb4891,gcdd4ae20e8+bd241b2308,gcde1bda545+903e937d91,gcf0d15dbbd+bd241b2308,gdaeeff99f8+f9a426f77a,gddc38dedce+585e252eca,ge79ae78c31+6c6beb4891,gfbcc870c63+b310236976,w.2024.23
LSST Data Management Base Package
Loading...
Searching...
No Matches
Algorithm.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_MEAS_BASE_Algorithm_h_INCLUDED
25#define LSST_MEAS_BASE_Algorithm_h_INCLUDED
26
27#include "lsst/log/Log.h"
28
29#include "lsst/afw/table/fwd.h"
34
35namespace lsst {
36namespace meas {
37namespace base {
38
45public:
62 virtual void fail(afw::table::SourceRecord& measRecord, MeasurementError* error = nullptr) const = 0;
63
64 virtual ~BaseAlgorithm() = default;
65
66 std::string getLogName() const { return _logName; }
67
68protected:
70};
71
82class SingleFrameAlgorithm : public virtual BaseAlgorithm {
83public:
92 virtual void measure(afw::table::SourceRecord& measRecord,
93 afw::image::Exposure<float> const& exposure) const = 0;
94
105 virtual void measureN(afw::table::SourceCatalog const& measCat,
106 afw::image::Exposure<float> const& exposure) const;
107};
108
127class ForcedAlgorithm : public virtual BaseAlgorithm {
128public:
137 virtual void measureForced(afw::table::SourceRecord& measRecord,
138 afw::image::Exposure<float> const& exposure,
139 afw::table::SourceRecord const& refRecord,
140 afw::geom::SkyWcs const& refWcs) const = 0;
141
153 afw::image::Exposure<float> const& exposure,
154 afw::table::SourceCatalog const& refRecord,
155 afw::geom::SkyWcs const& refWcs) const;
156};
157
171public:
173 afw::image::Exposure<float> const& exposure,
174 afw::table::SourceRecord const& refRecord,
175 afw::geom::SkyWcs const& refWcs) const override {
176 measure(measRecord, exposure);
177 }
178
180 afw::image::Exposure<float> const& exposure,
181 afw::table::SourceCatalog const& refRecord,
182 afw::geom::SkyWcs const& refWcs) const override {
183 measureN(measCat, exposure);
184 }
185};
186
187} // namespace base
188} // namespace meas
189} // namespace lsst
190
191#endif // !LSST_MEAS_BASE_Algorithm_h_INCLUDED
LSST DM logging module built on log4cxx.
A 2-dimensional celestial WCS that transform pixels to ICRS RA/Dec, using the LSST standard for pixel...
Definition SkyWcs.h:117
A class to contain the data, WCS, and other information needed to describe an image of the sky.
Definition Exposure.h:72
Record class that contains measurements made on a single exposure.
Definition Source.h:78
Ultimate abstract base class for all C++ measurement algorithms.
Definition Algorithm.h:44
virtual ~BaseAlgorithm()=default
virtual void fail(afw::table::SourceRecord &measRecord, MeasurementError *error=nullptr) const =0
Handle an exception thrown by the current algorithm by setting flags in the given record.
std::string getLogName() const
Definition Algorithm.h:66
Base class for algorithms that measure the properties of sources on one image, using previous measure...
Definition Algorithm.h:127
virtual void measureForced(afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure, afw::table::SourceRecord const &refRecord, afw::geom::SkyWcs const &refWcs) const =0
Called to measure a single child source in an image.
virtual void measureNForced(afw::table::SourceCatalog const &measCat, afw::image::Exposure< float > const &exposure, afw::table::SourceCatalog const &refRecord, afw::geom::SkyWcs const &refWcs) const
Called to simultaneously measure all children in a deblend family, in a single image.
Definition Algorithm.cc:36
Exception to be thrown when a measurement algorithm experiences a known failure mode.
Definition exceptions.h:48
An abstract base classes for which the same implementation can be used for both SingleFrameAlgorithm ...
Definition Algorithm.h:170
void measureNForced(afw::table::SourceCatalog const &measCat, afw::image::Exposure< float > const &exposure, afw::table::SourceCatalog const &refRecord, afw::geom::SkyWcs const &refWcs) const override
Called to simultaneously measure all children in a deblend family, in a single image.
Definition Algorithm.h:179
void measureForced(afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure, afw::table::SourceRecord const &refRecord, afw::geom::SkyWcs const &refWcs) const override
Called to measure a single child source in an image.
Definition Algorithm.h:172
Base class for algorithms that measure the properties of sources on single image.
Definition Algorithm.h:82
virtual void measure(afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure) const =0
Called to measure a single child source in an image.
virtual void measureN(afw::table::SourceCatalog const &measCat, afw::image::Exposure< float > const &exposure) const
Called to simultaneously measure all children in a deblend family, in a single image.
Definition Algorithm.cc:31