lsst.meas.base  14.0-12-g233aa8e+1
PsfFlux.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_PsfFlux_h_INCLUDED
25 #define LSST_MEAS_BASE_PsfFlux_h_INCLUDED
26 
27 #include "lsst/pex/config.h"
33 
34 namespace lsst { namespace meas { namespace base {
35 
47 public:
48 
50  "Mask planes that indicate pixels that should be excluded from the fit");
51 
58 };
59 
69 public:
70 
71  // Structures and routines to manage flaghandler
72  static FlagDefinitionList const & getFlagDefinitions();
73  static FlagDefinition const FAILURE;
75  static FlagDefinition const EDGE;
76 
80 
81  PsfFluxAlgorithm(Control const & ctrl, std::string const & name, afw::table::Schema & schema,
82  std::string const & logName = "");
83 
84  virtual void measure(
85  afw::table::SourceRecord & measRecord,
86  afw::image::Exposure<float> const & exposure
87  ) const;
88 
89  virtual void fail(
90  afw::table::SourceRecord & measRecord,
91  MeasurementError * error=nullptr
92  ) const;
93 
94 private:
95 
96  Control _ctrl;
97  FluxResultKey _fluxResultKey;
98  FlagHandler _flagHandler;
99  SafeCentroidExtractor _centroidExtractor;
100 };
101 
103 public:
105  PsfFluxTransform(Control const & ctrl, std::string const & name, afw::table::SchemaMapper & mapper);
106 };
107 
108 }}} // namespace lsst::meas::base
109 
110 #endif // !LSST_MEAS_BASE_PsfFlux_h_INCLUDED
std::vector< std::string > badMaskPlanes
"Mask planes that indicate pixels that should be excluded from the fit" ;
Definition: PsfFlux.h:50
static FlagDefinition const NO_GOOD_PIXELS
Definition: PsfFlux.h:74
static FlagDefinition const EDGE
Definition: PsfFlux.h:75
Simple class used to define and document flags The name and doc constitute the identity of the FlagDe...
Definition: FlagHandler.h:38
This defines the base of measurement transformations.
A measurement algorithm that estimates flux using a linear least-squares fit with the Psf model...
Definition: PsfFlux.h:68
Utility class for measurement algorithms that extracts a position from the Centroid slot and handles ...
PsfFluxControl()
Default constructor.
Definition: PsfFlux.h:57
Exception to be thrown when a measurement algorithm experiences a known failure mode.
Definition: exceptions.h:48
#define LSST_CONTROL_FIELD(NAME, TYPE, DOC)
Base for flux measurement transformations.
STL class.
PsfFluxControl Control
A typedef to the Control object for this algorithm, defined above.
Definition: PsfFlux.h:79
Utility class for handling flag fields that indicate the failure modes of an algorithm.
Definition: FlagHandler.h:156
static FlagDefinition const FAILURE
Definition: PsfFlux.h:73
A FunctorKey for FluxResult.
Definition: FluxUtilities.h:56
An abstract base classes for which the same implementation can be used for both SingleFrameAlgorithm ...
Definition: Algorithm.h:184
vector-type utility class to build a collection of FlagDefinitions
Definition: FlagHandler.h:63
A C++ control class to handle PsfFluxAlgorithm&#39;s configuration.
Definition: PsfFlux.h:46