LSST Applications g07dc498a13+5a531fccd6,g1409bbee79+5a531fccd6,g1a7e361dbc+5a531fccd6,g1fd858c14a+665e312648,g28da252d5a+a317024c06,g33399d78f5+6804da6274,g35bb328faa+e55fef2c71,g3bd4b5ce2c+4a07cc943c,g3c79e8cd92+d786b80045,g43bc871e57+9a9eb91fab,g53246c7159+e55fef2c71,g60b5630c4e+3d27850df0,g78460c75b0+8427c4cc8f,g786e29fd12+307f82e6af,g8534526c7b+af2545e932,g89139ef638+5a531fccd6,g8b49a6ea8e+3d27850df0,g9125e01d80+e55fef2c71,g97b8272a79+b6fee22cc3,g989de1cb63+5a531fccd6,g9f33ca652e+9f0bd23748,gaaedd4e678+5a531fccd6,gabe3b4be73+9c0c3c7524,gafaee74c96+447dce4572,gb1101e3267+9f3a9bd797,gb58c049af0+28045f66fd,gc1fe0db326+3d27850df0,gca43fec769+e55fef2c71,gcf25f946ba+6804da6274,gd397e13551+2ae48f76b9,gd6cbbdb0b4+784e334a77,gde0f65d7ad+f638193783,ge278dab8ac+25667260f6,geab183fbe5+3d27850df0,gecb8035dfe+0fa5abcb94,gefa07fa684+89734069dd,gf58bf46354+e55fef2c71,gfe7187db8c+44651d607e,w.2025.02
LSST Data Management Base Package
Loading...
Searching...
No Matches
Ellipse.h
Go to the documentation of this file.
1// -*- lsst-c++ -*-
2
3/*
4 * LSST Data Management System
5 * Copyright 2008, 2009, 2010 LSST Corporation.
6 *
7 * This product includes software developed by the
8 * LSST Project (http://www.lsst.org/).
9 *
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation, either version 3 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the LSST License Statement and
21 * the GNU General Public License along with this program. If not,
22 * see <http://www.lsstcorp.org/LegalNotices/>.
23 */
24
25#ifndef LSST_AFW_GEOM_ELLIPSES_Ellipse_h_INCLUDED
26#define LSST_AFW_GEOM_ELLIPSES_Ellipse_h_INCLUDED
27
28/*
29 * Forward declarations, typedefs, and definitions for Ellipse.
30 *
31 * Note: do not include directly; use the main ellipse header file.
32 */
33
35#include "lsst/geom/Box.h"
37
38namespace lsst {
39namespace afw {
40namespace geom {
41namespace ellipses {
42
51class Ellipse {
52public:
53 class Transformer;
54 class GridTransform;
55 class Convolution;
56
57 using ParameterVector = Eigen::Matrix<double, 5, 1>;
58
59 enum ParameterEnum { X = 3, Y = 4 };
60
62 lsst::geom::Point2D const& getCenter() const { return _center; }
63
65 lsst::geom::Point2D& getCenter() { return _center; }
66
68 void setCenter(lsst::geom::Point2D const& center) { _center = center; }
69
71 BaseCore const& getCore() const { return *_core; }
72
74 BaseCore& getCore() { return *_core; }
75
78
81
83 void setCore(BaseCore const& core) { *_core = core; }
84
86 void normalize() { _core->normalize(); }
87
89 void grow(double buffer) { _core->grow(buffer); }
90
92 void scale(double factor) { _core->scale(factor); }
93
95 void shift(lsst::geom::Extent2D const& offset) { _center += offset; }
96
99
101 void setParameterVector(ParameterVector const& vector);
102
103 void readParameters(double const* iter);
104
105 void writeParameters(double* iter) const;
106
116 Transformer const transform(lsst::geom::AffineTransform const& transform) const;
118
123 Convolution convolve(Ellipse const& other);
124 Convolution const convolve(Ellipse const& other) const;
126
133 GridTransform const getGridTransform() const;
134
137
143 Ellipse& operator=(Ellipse const& other);
144 Ellipse& operator=(Ellipse&& other);
145
151 bool operator==(Ellipse const& other) const {
152 return getCenter() == other.getCenter() && getCore() == other.getCore();
153 }
154
160 bool operator!=(Ellipse const& other) const { return !operator==(other); }
161
162 virtual ~Ellipse() = default;
163
164 explicit Ellipse(BaseCore const& core, lsst::geom::Point2D const& center = lsst::geom::Point2D())
165 : _core(core.clone()), _center(center) {}
166
169 : _core(core->clone()), _center(center) {}
170
171 Ellipse(Transformer const& other);
172 Ellipse(Convolution const& other);
173
174 Ellipse(Ellipse const& other) : _core(other.getCore().clone()), _center(other.getCenter()) {}
175 // Delegate to copy-constructor for backwards compatibility
176 Ellipse(Ellipse&& other) : Ellipse(other) {}
177
178private:
180 lsst::geom::Point2D _center;
181};
182} // namespace ellipses
183} // namespace geom
184} // namespace afw
185} // namespace lsst
186
187#endif // !LSST_AFW_GEOM_ELLIPSES_Ellipse_h_INCLUDED
table::Key< int > transform
A base class for parametrizations of the "core" of an ellipse - the ellipticity and size.
Definition BaseCore.h:55
A temporary-only expression object representing an lsst::geom::AffineTransform that maps the Ellipse ...
A temporary-only expression object for ellipse transformations.
Definition Transformer.h:86
An ellipse defined by an arbitrary BaseCore and a center point.
Definition Ellipse.h:51
ParameterVector const getParameterVector() const
Return the ellipse parameters as a vector.
Definition Ellipse.cc:31
void grow(double buffer)
Increase the major and minor radii of the ellipse by the given buffer.
Definition Ellipse.h:89
void writeParameters(double *iter) const
Definition Ellipse.cc:49
Ellipse(Ellipse const &other)
Return the transform that maps the ellipse to the unit circle.
Definition Ellipse.h:174
void shift(lsst::geom::Extent2D const &offset)
Move the ellipse center by the given offset.
Definition Ellipse.h:95
lsst::geom::Point2D & getCenter()
Return the center point.
Definition Ellipse.h:65
void scale(double factor)
Scale the size of the ellipse by the given factor.
Definition Ellipse.h:92
Ellipse & operator=(Ellipse const &other)
Set the parameters of this ellipse from another.
Definition Ellipse.cc:60
lsst::geom::Point2D const & getCenter() const
Return the center point.
Definition Ellipse.h:62
virtual ~Ellipse()=default
Return the transform that maps the ellipse to the unit circle.
bool operator!=(Ellipse const &other) const
Compare two ellipses for inequality.
Definition Ellipse.h:160
Ellipse(std::shared_ptr< BaseCore const > const &core, lsst::geom::Point2D const &center=lsst::geom::Point2D())
Return the transform that maps the ellipse to the unit circle.
Definition Ellipse.h:167
lsst::geom::Box2D computeBBox() const
Return the bounding box of the ellipse.
Definition Ellipse.cc:55
BaseCore const & getCore() const
Return the ellipse core.
Definition Ellipse.h:71
std::shared_ptr< BaseCore > getCorePtr()
Return the ellipse core.
Definition Ellipse.h:80
bool operator==(Ellipse const &other) const
Compare two ellipses for equality.
Definition Ellipse.h:151
GridTransform const getGridTransform() const
Return the transform that maps the ellipse to the unit circle.
Ellipse(BaseCore const &core, lsst::geom::Point2D const &center=lsst::geom::Point2D())
Return the transform that maps the ellipse to the unit circle.
Definition Ellipse.h:164
void normalize()
Put the parameters in a standard form.
Definition Ellipse.h:86
void setCenter(lsst::geom::Point2D const &center)
Set the center point.
Definition Ellipse.h:68
void readParameters(double const *iter)
Definition Ellipse.cc:43
void setParameterVector(ParameterVector const &vector)
Set the ellipse parameters from a vector.
Definition Ellipse.cc:38
Convolution convolve(Ellipse const &other)
Return the transform that maps the ellipse to the unit circle.
Definition Convolution.h:99
Ellipse(Ellipse &&other)
Return the transform that maps the ellipse to the unit circle.
Definition Ellipse.h:176
void setCore(BaseCore const &core)
Set the ellipse core; the type of the core is not changed.
Definition Ellipse.h:83
BaseCore & getCore()
Return the ellipse core.
Definition Ellipse.h:74
std::shared_ptr< BaseCore const > getCorePtr() const
Return the ellipse core.
Definition Ellipse.h:77
Eigen::Matrix< double, 5, 1 > ParameterVector
Proxy return type for Ellipse::convolve().
Definition Ellipse.h:57
An affine coordinate transformation consisting of a linear transformation and an offset.
A floating-point coordinate rectangle geometry.
Definition Box.h:413