LSSTApplications  20.0.0
LSSTDataManagementBasePackage
NaiveCentroid.cc
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 #include "ndarray/eigen.h"
24 #include "lsst/afw/table/Source.h"
26 
27 namespace lsst {
28 namespace meas {
29 namespace base {
30 namespace {
31 FlagDefinitionList flagDefinitions;
32 } // namespace
33 
34 FlagDefinition const NaiveCentroidAlgorithm::FAILURE = flagDefinitions.addFailureFlag();
35 FlagDefinition const NaiveCentroidAlgorithm::NO_COUNTS =
36  flagDefinitions.add("flag_noCounts", "Object to be centroided has no counts");
37 FlagDefinition const NaiveCentroidAlgorithm::EDGE =
38  flagDefinitions.add("flag_edge", "Object too close to edge");
39 
41 
44  : _ctrl(ctrl),
45  _centroidKey(CentroidResultKey::addFields(schema, name, "centroid from Naive Centroid algorithm",
47  _flagHandler(FlagHandler::addFields(schema, name, getFlagDefinitions())),
48  _centroidExtractor(schema, name, true),
49  _centroidChecker(schema, name, ctrl.doFootprintCheck, ctrl.maxDistToPeak) {}
50 
52  afw::image::Exposure<float> const& exposure) const {
53  geom::Point2D center = _centroidExtractor(measRecord, _flagHandler);
55  result.x = center.getX();
56  result.y = center.getY();
57  measRecord.set(_centroidKey, result); // better than NaN
58 
59  typedef afw::image::Image<float> ImageT;
60  ImageT const& image = *exposure.getMaskedImage().getImage();
61 
62  int x = center.getX(); // FIXME: this is different from GaussianCentroid and SdssCentroid here,
63  int y = center.getY(); // and probably shouldn't be.
64 
65  x -= image.getX0(); // work in image Pixel coordinates
66  y -= image.getY0();
67 
68  if (x < 1 || x >= image.getWidth() - 1 || y < 1 || y >= image.getHeight() - 1) {
70  }
71 
72  ImageT::xy_locator im = image.xy_at(x, y);
73 
74  double const sum = (im(-1, 1) + im(0, 1) + im(1, 1) + im(-1, 0) + im(0, 0) + im(1, 0) + im(-1, -1) +
75  im(0, -1) + im(1, -1)) -
76  9 * _ctrl.background;
77 
78  if (sum == 0.0) {
80  }
81 
82  double const sum_x = -im(-1, 1) + im(1, 1) + -im(-1, 0) + im(1, 0) + -im(-1, -1) + im(1, -1);
83  double const sum_y = (im(-1, 1) + im(0, 1) + im(1, 1)) - (im(-1, -1) + im(0, -1) + im(1, -1));
84 
85  result.x = afw::image::indexToPosition(x + image.getX0()) + sum_x / sum;
86  result.y = afw::image::indexToPosition(y + image.getY0()) + sum_y / sum;
87  measRecord.set(_centroidKey, result);
88  _centroidChecker(measRecord);
89 }
90 
92  _flagHandler.handleFailure(measRecord, error);
93 }
94 
100  if (flag == NaiveCentroidAlgorithm::FAILURE) continue;
101  if (mapper.getInputSchema().getNames().count(mapper.getInputSchema().join(name, flag.name)) == 0)
102  continue;
104  mapper.getInputSchema().find<afw::table::Flag>(name + "_" + flag.name).key;
105  mapper.addMapping(key);
106  }
107 }
108 
109 } // namespace base
110 } // namespace meas
111 } // namespace lsst
y
int y
Definition: SpanSet.cc:49
schema
table::Schema schema
Definition: Amplifier.cc:115
lsst::meas::base::NaiveCentroidControl::background
double background
"Value to subtract from the image pixel values" ;
Definition: NaiveCentroid.h:46
lsst::afw::image
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.
Definition: imageAlgorithm.dox:1
lsst::meas::base::FlagDefinition::number
std::size_t number
Definition: FlagHandler.h:54
std::string
STL class.
lsst::log.log.logContinued.error
def error(fmt, *args)
Definition: logContinued.py:210
lsst::meas::base::FlagHandler::handleFailure
void handleFailure(afw::table::BaseRecord &record, MeasurementError const *error=nullptr) const
Handle an expected or unexpected Exception thrown by a measurement algorithm.
Definition: FlagHandler.cc:76
lsst::afw::table::SourceRecord
Record class that contains measurements made on a single exposure.
Definition: Source.h:80
lsst::meas::base::NO_UNCERTAINTY
@ NO_UNCERTAINTY
Algorithm provides no uncertainy information at all.
Definition: constants.h:44
lsst::afw::image::Exposure< float >
base
Definition: __init__.py:1
lsst::meas::base::NaiveCentroidAlgorithm::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: NaiveCentroid.cc:91
lsst::meas::base::FlagDefinition::doc
std::string doc
Definition: FlagHandler.h:53
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
lsst::afw::image::indexToPosition
double indexToPosition(double ind)
Convert image index to image position.
Definition: ImageUtils.h:55
lsst::meas::base::CentroidResultKey
A FunctorKey for CentroidResult.
Definition: CentroidUtilities.h:88
lsst::afw::geom.transform.transformContinued.name
string name
Definition: transformContinued.py:32
lsst::meas::base::CentroidTransform
Base for centroid measurement transformations.
Definition: CentroidUtilities.h:168
lsst::meas::base::FlagDefinition::name
std::string name
Definition: FlagHandler.h:52
lsst::meas::base::NaiveCentroidAlgorithm::EDGE
static FlagDefinition const EDGE
Definition: NaiveCentroid.h:73
lsst::meas::base::CentroidResult
A reusable struct for centroid measurements.
Definition: CentroidUtilities.h:41
lsst::afw::image::Exposure::getMaskedImage
MaskedImageT getMaskedImage()
Return the MaskedImage.
Definition: Exposure.h:228
lsst::meas::base::FlagDefinitionList
vector-type utility class to build a collection of FlagDefinitions
Definition: FlagHandler.h:60
lsst::meas::base::NaiveCentroidTransform::NaiveCentroidTransform
NaiveCentroidTransform(Control const &ctrl, std::string const &name, afw::table::SchemaMapper &mapper)
Definition: NaiveCentroid.cc:95
lsst::meas::base::FlagHandler
Utility class for handling flag fields that indicate the failure modes of an algorithm.
Definition: FlagHandler.h:148
x
double x
Definition: ChebyshevBoundedField.cc:277
lsst::afw::table::SchemaMapper
A mapping between the keys of two Schemas, used to copy data between them.
Definition: SchemaMapper.h:21
lsst::afw::table::Key< afw::table::Flag >
result
py::object result
Definition: _schema.cc:429
lsst::meas::base::NaiveCentroidAlgorithm::NaiveCentroidAlgorithm
NaiveCentroidAlgorithm(Control const &ctrl, std::string const &name, afw::table::Schema &schema)
Definition: NaiveCentroid.cc:42
Source.h
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
LSST_EXCEPT
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
lsst::meas::base::FlagDefinitionList::size
std::size_t size() const
return the current size (number of defined elements) of the collection
Definition: FlagHandler.h:125
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
lsst::meas::base::NaiveCentroidControl
A C++ control class to handle NaiveCentroidAlgorithm's configuration.
Definition: NaiveCentroid.h:44
key
Key< U > key
Definition: Schema.cc:281
lsst::geom::Point< double, 2 >
mapper
SchemaMapper * mapper
Definition: SchemaMapper.cc:78
lsst::afw::image::MaskedImage::getImage
ImagePtr getImage() const
Return a (shared_ptr to) the MaskedImage's image.
Definition: MaskedImage.h:1057
std::size_t
lsst::meas::base::NaiveCentroidAlgorithm::getFlagDefinitions
static FlagDefinitionList const & getFlagDefinitions()
Definition: NaiveCentroid.cc:40
lsst::afw::table::BaseRecord::set
void set(Key< T > const &key, U const &value)
Set value of a field for the given key.
Definition: BaseRecord.h:164
lsst::meas::base::NaiveCentroidAlgorithm::NO_COUNTS
static FlagDefinition const NO_COUNTS
Definition: NaiveCentroid.h:72
lsst::afw::image::Image< float >
lsst::meas::base::NaiveCentroidAlgorithm::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: NaiveCentroid.cc:51
NaiveCentroid.h
lsst::meas::base::NaiveCentroidAlgorithm::FAILURE
static FlagDefinition const FAILURE
Definition: NaiveCentroid.h:71