LSSTApplications  20.0.0
LSSTDataManagementBasePackage
Defect.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 #if !defined(LSST_AFW_IMAGE_DEFECT_H)
26 #define LSST_AFW_IMAGE_DEFECT_H
27 
30 #include <limits>
31 #include <vector>
32 #include "lsst/geom.h"
33 
34 namespace lsst {
35 namespace afw {
36 namespace image {
37 
41 class DefectBase {
42 public:
44  )
45  : _bbox(bbox) {}
46  DefectBase(DefectBase const&) noexcept = default;
47  DefectBase(DefectBase&&) noexcept = default;
48  DefectBase& operator=(DefectBase const&) noexcept = default;
49  DefectBase& operator=(DefectBase&&) noexcept = default;
50  virtual ~DefectBase() noexcept = default;
51 
52  lsst::geom::Box2I const& getBBox() const noexcept { return _bbox; }
53  int getX0() const noexcept { return _bbox.getMinX(); }
54  int getX1() const noexcept { return _bbox.getMaxX(); }
55  int getY0() const noexcept { return _bbox.getMinY(); }
56  int getY1() const noexcept { return _bbox.getMaxY(); }
57 
58  void clip(lsst::geom::Box2I const& bbox) noexcept { _bbox.clip(bbox); }
59 
63  void shift(int dx,
64  int dy
65  ) {
66  _bbox.shift(lsst::geom::Extent2I(dx, dy));
67  }
68  void shift(lsst::geom::Extent2I const& d) { _bbox.shift(d); }
69 
70 private:
71  lsst::geom::Box2I _bbox;
72 };
73 } // namespace image
74 } // namespace afw
75 } // namespace lsst
76 
77 #endif
lsst::afw::image
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.
Definition: imageAlgorithm.dox:1
lsst::afw::image::DefectBase::clip
void clip(lsst::geom::Box2I const &bbox) noexcept
Definition: Defect.h:58
lsst::afw::image::DefectBase::getX0
int getX0() const noexcept
Return the Defect's left column.
Definition: Defect.h:53
lsst::afw::image::DefectBase::shift
void shift(lsst::geom::Extent2I const &d)
Definition: Defect.h:68
lsst::afw::image::DefectBase::getX1
int getX1() const noexcept
Return the Defect's right column.
Definition: Defect.h:54
lsst::afw
Definition: imageAlgorithm.dox:1
lsst::afw::image::DefectBase::shift
void shift(int dx, int dy)
Offset a Defect by (dx, dy)
Definition: Defect.h:63
geom.h
lsst::geom::Box2I::shift
void shift(Extent2I const &offset)
Shift the position of the box by the given offset.
Definition: Box.cc:134
lsst::afw::image::DefectBase
Encapsulate information about a bad portion of a detector.
Definition: Defect.h:41
lsst::afw::image::DefectBase::getBBox
lsst::geom::Box2I const & getBBox() const noexcept
Return the Defect's bounding box.
Definition: Defect.h:52
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::geom
Definition: geomOperators.dox:4
lsst::geom::Box2I::clip
void clip(Box2I const &other) noexcept
Shrink this to ensure that other.contains(*this).
Definition: Box.cc:189
lsst::geom::Box2I::getMaxY
int getMaxY() const noexcept
Definition: Box.h:162
lsst::geom::Box2I::getMaxX
int getMaxX() const noexcept
Definition: Box.h:161
lsst::afw::image::DefectBase::DefectBase
DefectBase(const lsst::geom::Box2I &bbox)
Definition: Defect.h:43
lsst::geom::Box2I
An integer coordinate rectangle.
Definition: Box.h:55
lsst::geom::Box2I::getMinX
int getMinX() const noexcept
Definition: Box.h:157
lsst::afw::image::DefectBase::DefectBase
DefectBase(DefectBase const &) noexcept=default
lsst::afw::image::DefectBase::getY1
int getY1() const noexcept
Return the Defect's top row.
Definition: Defect.h:56
lsst::afw::image::DefectBase::getY0
int getY0() const noexcept
Return the Defect's bottom row.
Definition: Defect.h:55
lsst::afw::image::DefectBase::DefectBase
DefectBase(DefectBase &&) noexcept=default
lsst::geom::Extent< int, 2 >
bbox
AmpInfoBoxKey bbox
Definition: Amplifier.cc:117
lsst::geom::Box2I::getMinY
int getMinY() const noexcept
Definition: Box.h:158