LSSTApplications  20.0.0
LSSTDataManagementBasePackage
GaussianFlux.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_GaussianFlux_h_INCLUDED
25 #define LSST_MEAS_BASE_GaussianFlux_h_INCLUDED
26 
27 #include "lsst/pex/config.h"
35 
36 namespace lsst {
37 namespace meas {
38 namespace base {
39 
44 public:
45  LSST_CONTROL_FIELD(background, double, "FIXME! NEVER DOCUMENTED!");
46 
53 };
54 
63 public:
64  // Structures and routines to manage flaghandler
65  static FlagDefinitionList const& getFlagDefinitions();
66  static FlagDefinition const FAILURE;
67 
71 
73 
74  virtual void measure(afw::table::SourceRecord& measRecord,
75  afw::image::Exposure<float> const& exposure) const;
76 
77  virtual void fail(afw::table::SourceRecord& measRecord, MeasurementError* error = nullptr) const;
78 
79 private:
80  Control _ctrl;
81  FluxResultKey _instFluxResultKey;
82  FlagHandler _flagHandler;
83  SafeCentroidExtractor _centroidExtractor;
84  SafeShapeExtractor _shapeExtractor;
85 };
86 
88 public:
92 };
93 
94 } // namespace base
95 } // namespace meas
96 } // namespace lsst
97 
98 #endif // !LSST_MEAS_BASE_GaussianFlux_h_INCLUDED
schema
table::Schema schema
Definition: Amplifier.cc:115
Transform.h
lsst::meas::base::SimpleAlgorithm
An abstract base classes for which the same implementation can be used for both SingleFrameAlgorithm ...
Definition: Algorithm.h:170
std::string
STL class.
CentroidUtilities.h
lsst::log.log.logContinued.error
def error(fmt, *args)
Definition: logContinued.py:210
lsst::meas::base::GaussianFluxAlgorithm::fail
virtual void fail(afw::table::SourceRecord &measRecord, MeasurementError *error=nullptr) const
Handle an exception thrown by the current algorithm by setting flags in the given record.
Definition: GaussianFlux.cc:65
lsst::meas::base::GaussianFluxAlgorithm::Control
GaussianFluxControl Control
A typedef to the Control object for this algorithm, defined above.
Definition: GaussianFlux.h:70
lsst::afw::table::SourceRecord
Record class that contains measurements made on a single exposure.
Definition: Source.h:80
lsst::afw::image::Exposure< float >
base
Definition: __init__.py:1
lsst::meas::base::GaussianFluxTransform::GaussianFluxTransform
GaussianFluxTransform(Control const &ctrl, std::string const &name, afw::table::SchemaMapper &mapper)
Definition: GaussianFlux.h:90
FluxUtilities.h
lsst::meas::base::MeasurementError
Exception to be thrown when a measurement algorithm experiences a known failure mode.
Definition: exceptions.h:48
lsst::afw::table::Schema
Defines the fields and offsets for a table.
Definition: Schema.h:50
InputUtilities.h
lsst::meas::base::SafeCentroidExtractor
Utility class for measurement algorithms that extracts a position from the Centroid slot and handles ...
Definition: InputUtilities.h:39
lsst::afw::geom.transform.transformContinued.name
string name
Definition: transformContinued.py:32
lsst::meas::base::SafeShapeExtractor
Utility class for measurement algorithms that extracts an ellipse from the Shape slot and handles err...
Definition: InputUtilities.h:90
lsst::meas::base::FluxResultKey
A FunctorKey for FluxResult.
Definition: FluxUtilities.h:59
lsst::meas::base::FlagDefinitionList
vector-type utility class to build a collection of FlagDefinitions
Definition: FlagHandler.h:60
lsst::meas::base::GaussianFluxAlgorithm::getFlagDefinitions
static FlagDefinitionList const & getFlagDefinitions()
Definition: GaussianFlux.cc:42
lsst::meas::base::GaussianFluxAlgorithm
A measurement algorithm that estimates instFlux using an elliptical Gaussian weight.
Definition: GaussianFlux.h:62
lsst::meas::base::GaussianFluxAlgorithm::measure
virtual void measure(afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure) const
Called to measure a single child source in an image.
Definition: GaussianFlux.cc:53
lsst::meas::base::FlagHandler
Utility class for handling flag fields that indicate the failure modes of an algorithm.
Definition: FlagHandler.h:148
lsst::afw::table::SchemaMapper
A mapping between the keys of two Schemas, used to copy data between them.
Definition: SchemaMapper.h:21
lsst::meas::base::FluxTransform
Base for instFlux measurement transformations.
Definition: FluxUtilities.h:187
lsst::meas::base::GaussianFluxAlgorithm::GaussianFluxAlgorithm
GaussianFluxAlgorithm(Control const &ctrl, std::string const &name, afw::table::Schema &schema)
Definition: GaussianFlux.cc:44
LSST_CONTROL_FIELD
#define LSST_CONTROL_FIELD(NAME, TYPE, DOC)
A preprocessor macro used to define fields in C++ "control object" structs.
Definition: config.h:43
Algorithm.h
lsst::meas::base::GaussianFluxTransform::Control
GaussianFluxControl Control
Definition: GaussianFlux.h:89
lsst::meas::base::GaussianFluxControl
A C++ control class to handle GaussianFluxAlgorithm's configuration.
Definition: GaussianFlux.h:43
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::meas::base::GaussianFluxTransform
Definition: GaussianFlux.h:87
lsst::meas::base::GaussianFluxAlgorithm::FAILURE
static FlagDefinition const FAILURE
Definition: GaussianFlux.h:66
lsst::meas::base::FlagDefinition
Simple class used to define and document flags The name and doc constitute the identity of the FlagDe...
Definition: FlagHandler.h:40
FlagHandler.h
mapper
SchemaMapper * mapper
Definition: SchemaMapper.cc:78
config.h
lsst::meas::base::GaussianFluxControl::background
double background
"FIXME! NEVER DOCUMENTED!" ;
Definition: GaussianFlux.h:45
Exposure.h
lsst::meas::base::GaussianFluxControl::GaussianFluxControl
GaussianFluxControl()
Default constructor.
Definition: GaussianFlux.h:52