LSST Applications g063fba187b+fee0456c91,g0f08755f38+ea96e5a5a3,g1653933729+a8ce1bb630,g168dd56ebc+a8ce1bb630,g1a2382251a+90257ff92a,g20f6ffc8e0+ea96e5a5a3,g217e2c1bcf+937a289c59,g28da252d5a+daa7da44eb,g2bbee38e9b+253935c60e,g2bc492864f+253935c60e,g3156d2b45e+6e55a43351,g32e5bea42b+31359a2a7a,g347aa1857d+253935c60e,g35bb328faa+a8ce1bb630,g3a166c0a6a+253935c60e,g3b1af351f3+a8ce1bb630,g3e281a1b8c+c5dd892a6c,g414038480c+416496e02f,g41af890bb2+afe91b1188,g599934f4f4+0db33f7991,g7af13505b9+e36de7bce6,g80478fca09+da231ba887,g82479be7b0+a4516e59e3,g858d7b2824+ea96e5a5a3,g89c8672015+f4add4ffd5,g9125e01d80+a8ce1bb630,ga5288a1d22+bc6ab8dfbd,gb58c049af0+d64f4d3760,gc28159a63d+253935c60e,gcab2d0539d+3f2b72788c,gcf0d15dbbd+4ea9c45075,gda6a2b7d83+4ea9c45075,gdaeeff99f8+1711a396fd,ge79ae78c31+253935c60e,gef2f8181fd+3031e3cf99,gf0baf85859+c1f95f4921,gfa517265be+ea96e5a5a3,gfa999e8aa5+17cd334064,w.2024.50
LSST Data Management Base Package
Loading...
Searching...
No Matches
CoaddBoundedField.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_ALGORITHMS_CoaddBoundedField_h_INCLUDED
25#define LSST_MEAS_ALGORITHMS_CoaddBoundedField_h_INCLUDED
26
27#include "lsst/geom/Box.h"
31
32namespace lsst {
33namespace meas {
34namespace algorithms {
35
58
59class CoaddBoundedField : public afw::table::io::PersistableFacade<CoaddBoundedField>,
61public:
64
66 ElementVector const& elements);
67
69 ElementVector const& elements, double default_);
70
72 double evaluate(geom::Point2D const& position) const override;
73
76
78 double getDefault() const { return _default; };
79
81 ElementVector getElements() const { return _elements; };
82
84 bool getThrowOnMissing() const { return _throwOnMissing; };
85
89 virtual bool isPersistable() const noexcept override { return true; }
90
91 // Factory used to read CoaddPsf from an InputArchive; defined only in the source file.
92 class Factory;
93
94 std::shared_ptr<afw::math::BoundedField> operator*(double const scale) const override;
95
97 bool operator==(BoundedField const& rhs) const override;
98
99protected:
100 // See afw::table::io::Persistable::getPersistenceName
101 std::string getPersistenceName() const override;
102
103 // See afw::table::io::Persistable::getPythonModule
104 std::string getPythonModule() const override;
105
106 // See afw::table::io::Persistable::write
107 void write(OutputArchiveHandle& handle) const override;
108
109private:
110 bool _throwOnMissing; // instead of using _default, raise an exception
111 double _default; // when none of the elements contribute at a point, return this value
112 std::shared_ptr<afw::geom::SkyWcs const> _coaddWcs; // coordinate system this field is defined in
113 ElementVector _elements; // vector of constituent fields being coadded
114
115 std::string toString() const override {
117 os << "CoaddBoundedField with " << _elements.size() << " elements, default " << _default;
118 return os.str();
119 }
120};
121
122} // namespace algorithms
123} // namespace meas
124} // namespace lsst
125
126#endif // !LSST_MEAS_ALGORITHMS_CoaddBoundedField_h_INCLUDED
AmpInfoBoxKey bbox
Definition Amplifier.cc:117
std::ostream * os
Definition Schema.cc:557
An abstract base class for 2-d functions defined on an integer bounding boxes.
BoundedField(BoundedField const &)=default
A CRTP facade class for subclasses of Persistable.
io::OutputArchiveHandle OutputArchiveHandle
An integer coordinate rectangle.
Definition Box.h:55
CoaddBoundedField(geom::Box2I const &bbox, std::shared_ptr< afw::geom::SkyWcs const > coaddWcs, ElementVector const &elements)
bool getThrowOnMissing() const
Get the throwOnMissing setting.
double getDefault() const
Get the default value.
virtual bool isPersistable() const noexcept override
Return true if the CoaddBoundedField persistable (always true).
std::shared_ptr< afw::geom::SkyWcs const > getCoaddWcs() const
Get the coaddWcs.
ElementVector getElements() const
Get the elements vector.
void write(OutputArchiveHandle &handle) const override
Write the object to one or more catalogs.
std::shared_ptr< afw::math::BoundedField > operator*(double const scale) const override
Return a scaled BoundedField.
std::string getPythonModule() const override
Return the fully-qualified Python module that should be imported to guarantee that its factory is reg...
double evaluate(geom::Point2D const &position) const override
Evaluate the field at the given point.
bool operator==(BoundedField const &rhs) const override
BoundedFields (of the same sublcass) are equal if their bounding boxes and parameters are equal.
std::string getPersistenceName() const override
Return the unique name used to persist this object and look up its factory.
afw::table::Key< int > coaddWcs
afw::table::Key< double > default_
Struct used to hold one Exposure's data in a CoaddBoundedField.
std::shared_ptr< afw::geom::SkyWcs const > wcs
bool operator!=(CoaddBoundedFieldElement const &rhs) const
Elements are equal if all their components are equal.
std::shared_ptr< afw::math::BoundedField > field
std::shared_ptr< afw::geom::polygon::Polygon const > validPolygon
CoaddBoundedFieldElement(std::shared_ptr< afw::math::BoundedField > field_, std::shared_ptr< afw::geom::SkyWcs const > wcs_, std::shared_ptr< afw::geom::polygon::Polygon const > validPolygon_, double weight_=1.0)
bool operator==(CoaddBoundedFieldElement const &rhs) const
Elements are equal if all their components are equal.