lsst.meas.base 22.0.1-26-g26961ef+33fe4e121a
NaiveCentroid.h
Go to the documentation of this file.
1// -*- lsst-c++ -*-
2/*
3 * LSST Data Management System
4 * Copyright 2008-2013 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_NaiveCentroid_h_INCLUDED
25#define LSST_MEAS_BASE_NaiveCentroid_h_INCLUDED
26
27#include <stdio.h>
28#include <execinfo.h>
29#include <signal.h>
30#include <stdlib.h>
31#include <unistd.h>
32#include "lsst/pex/config.h"
37
38namespace lsst {
39namespace meas {
40namespace base {
45public:
46 LSST_CONTROL_FIELD(background, double, "Value to subtract from the image pixel values");
47 LSST_CONTROL_FIELD(doFootprintCheck, bool, "Do check that the centroid is contained in footprint.");
48 LSST_CONTROL_FIELD(maxDistToPeak, double,
49 "If set > 0, Centroid Check also checks distance from footprint peak.");
50
57};
58
68public:
69 // Structures and routines to manage flaghandler
71 static FlagDefinition const FAILURE;
73 static FlagDefinition const EDGE;
74
76
77 NaiveCentroidAlgorithm(Control const& ctrl, std::string const& name, afw::table::Schema& schema);
78
79 virtual void measure(afw::table::SourceRecord& measRecord,
80 afw::image::Exposure<float> const& exposure) const;
81
82 virtual void fail(afw::table::SourceRecord& measRecord, MeasurementError* error = nullptr) const;
83
84private:
85 Control _ctrl;
86 CentroidResultKey _centroidKey;
87 FlagHandler _flagHandler;
88 SafeCentroidExtractor _centroidExtractor;
89 CentroidChecker _centroidChecker;
90};
91
93public:
95
96 NaiveCentroidTransform(Control const& ctrl, std::string const& name, afw::table::SchemaMapper& mapper);
97};
98
99} // namespace base
100} // namespace meas
101} // namespace lsst
102
103#endif // !LSST_MEAS_BASE_NaiveCentroid_h_INCLUDED
A FunctorKey for CentroidResult.
Base for centroid measurement transformations.
vector-type utility class to build a collection of FlagDefinitions
Definition: FlagHandler.h:60
Utility class for handling flag fields that indicate the failure modes of an algorithm.
Definition: FlagHandler.h:148
Exception to be thrown when a measurement algorithm experiences a known failure mode.
Definition: exceptions.h:48
A class that calculates a centroid as a simple unweighted first moment of the 3x3 region around a pix...
Definition: NaiveCentroid.h:67
static FlagDefinition const NO_COUNTS
Definition: NaiveCentroid.h:72
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.
virtual void measure(afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure) const
Called to measure a single child source in an image.
static FlagDefinition const FAILURE
Definition: NaiveCentroid.h:71
NaiveCentroidAlgorithm(Control const &ctrl, std::string const &name, afw::table::Schema &schema)
static FlagDefinition const EDGE
Definition: NaiveCentroid.h:73
static FlagDefinitionList const & getFlagDefinitions()
A C++ control class to handle NaiveCentroidAlgorithm's configuration.
Definition: NaiveCentroid.h:44
NaiveCentroidControl()
Default constructor.
Definition: NaiveCentroid.h:56
double maxDistToPeak
"If set > 0, Centroid Check also checks distance from footprint peak." ;
Definition: NaiveCentroid.h:49
bool doFootprintCheck
"Do check that the centroid is contained in footprint." ;
Definition: NaiveCentroid.h:47
double background
"Value to subtract from the image pixel values" ;
Definition: NaiveCentroid.h:46
NaiveCentroidTransform(Control const &ctrl, std::string const &name, afw::table::SchemaMapper &mapper)
Utility class for measurement algorithms that extracts a position from the Centroid slot and handles ...
An abstract base classes for which the same implementation can be used for both SingleFrameAlgorithm ...
Definition: Algorithm.h:170
Simple class used to define and document flags The name and doc constitute the identity of the FlagDe...
Definition: FlagHandler.h:40