LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
Loading...
Searching...
No Matches
ImageSlice.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_SLICE_H)
26#define LSST_AFW_IMAGE_SLICE_H
27/*
28 * Define a single column or row of an Image
29 *
30 * The purpose of this class is to make it possible to add/sub/mult/div an Image by a row or column.
31 * We overload operators + - * / to do this. The original motivation was to facilitate subtraction
32 * of an overscan region.
33 *
34 */
35
37
38namespace lsst {
39namespace afw {
40namespace image {
41
45template <typename PixelT>
46class ImageSlice : public Image<PixelT> {
47public:
49
55 explicit ImageSlice(Image<PixelT> const &img);
56 ~ImageSlice() override {}
57 ImageSliceType getImageSliceType() const { return _sliceType; }
58
59private:
60 ImageSliceType _sliceType;
61};
62
63namespace details {
64
65/*
66 * These structs allow the operate() function to be templated over operation.
67 * The operate() function handles the loop over pixels and the chosen operator will be used.
68 * The templates allow the compiler to do this efficiently.
69 *
70 */
71
72template <typename PixelT>
73struct Plus {
74 PixelT operator()(PixelT const imgPix, PixelT const slcPix) { return imgPix + slcPix; }
75};
76template <typename PixelT>
77struct Minus {
78 PixelT operator()(PixelT const imgPix, PixelT const slcPix) { return imgPix - slcPix; }
79};
80template <typename PixelT>
81struct Mult {
82 PixelT operator()(PixelT const imgPix, PixelT const slcPix) { return imgPix * slcPix; }
83};
84template <typename PixelT>
85struct Div {
86 PixelT operator()(PixelT const imgPix, PixelT const slcPix) { return imgPix / slcPix; }
87};
88
93template <typename OperatorT, typename PixelT>
95 typename ImageSlice<PixelT>::ImageSliceType sliceType) {
96 OperatorT op;
97
98 if (sliceType == ImageSlice<PixelT>::ROW) {
99 for (int y = 0; y < img.getHeight(); ++y) {
100 typename ImageSlice<PixelT>::x_iterator pSlc = slc.row_begin(0);
101 for (typename Image<PixelT>::x_iterator pImg = img.row_begin(y), end = img.row_end(y);
102 pImg != end; ++pImg, ++pSlc) {
103 *pImg = op(*pImg, *pSlc);
104 }
105 }
106 } else if (sliceType == ImageSlice<PixelT>::COLUMN) {
107 typename ImageSlice<PixelT>::y_iterator pSlc = slc.col_begin(0);
108 for (int y = 0; y < img.getHeight(); ++y, ++pSlc) {
109 for (typename Image<PixelT>::x_iterator pImg = img.row_begin(y), end = img.row_end(y);
110 pImg != end; ++pImg) {
111 *pImg = op(*pImg, *pSlc);
112 }
113 }
114 }
115}
116} // namespace details
117
118// +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
119// overload +
128template <typename PixelT>
129std::shared_ptr<Image<PixelT>> operator+(Image<PixelT> const &img, ImageSlice<PixelT> const &slc);
130
139template <typename PixelT>
140std::shared_ptr<Image<PixelT>> operator+(ImageSlice<PixelT> const &slc, Image<PixelT> const &img);
141
150template <typename PixelT>
151void operator+=(Image<PixelT> &img, ImageSlice<PixelT> const &slc);
152
153// -----------------------------------------------------------------
154// overload -
163template <typename PixelT>
164std::shared_ptr<Image<PixelT>> operator-(Image<PixelT> const &img, ImageSlice<PixelT> const &slc);
165
174template <typename PixelT>
175void operator-=(Image<PixelT> &img, ImageSlice<PixelT> const &slc);
176
177// ******************************************************************
178// overload *
187template <typename PixelT>
188std::shared_ptr<Image<PixelT>> operator*(Image<PixelT> const &img, ImageSlice<PixelT> const &slc);
189
198template <typename PixelT>
199std::shared_ptr<Image<PixelT>> operator*(ImageSlice<PixelT> const &slc, Image<PixelT> const &img);
200
209template <typename PixelT>
210void operator*=(Image<PixelT> &img, ImageSlice<PixelT> const &slc);
211
212// ///////////////////////////////////////////////////////////////////
213// overload /
222template <typename PixelT>
223std::shared_ptr<Image<PixelT>> operator/(Image<PixelT> const &img, ImageSlice<PixelT> const &slc);
224
233template <typename PixelT>
234void operator/=(Image<PixelT> &img, ImageSlice<PixelT> const &slc);
235} // namespace image
236} // namespace afw
237} // namespace lsst
238
239#endif
int end
int y
Definition SpanSet.cc:48
y_iterator col_begin(int x) const
Return an y_iterator to the start of the y'th row.
Definition ImageBase.h:413
int getHeight() const
Return the number of rows in the image.
Definition ImageBase.h:296
x_iterator row_begin(int y) const
Return an x_iterator to the start of the y'th row.
Definition ImageBase.h:401
x_iterator row_end(int y) const
Return an x_iterator to the end of the y'th row.
Definition ImageBase.h:404
typename _view_t::x_iterator x_iterator
An iterator for traversing the pixels in a row.
Definition ImageBase.h:133
typename _view_t::y_iterator y_iterator
An iterator for traversing the pixels in a column.
Definition ImageBase.h:143
A class to represent a 2-dimensional array of pixels.
Definition Image.h:51
A class to specify a slice of an image.
Definition ImageSlice.h:46
ImageSliceType getImageSliceType() const
Definition ImageSlice.h:57
ImageSlice(Image< PixelT > const &img)
Constructor for ImageSlice.
Definition ImageSlice.cc:41
void operate(Image< PixelT > &img, ImageSlice< PixelT > const &slc, typename ImageSlice< PixelT >::ImageSliceType sliceType)
A function to loop over pixels and perform the requested operation.
Definition ImageSlice.h:94
std::shared_ptr< Image< PixelT > > operator+(Image< PixelT > const &img, ImageSlice< PixelT > const &slc)
Overload operator+()
Definition ImageSlice.cc:69
Image< LhsPixelT > & operator+=(Image< LhsPixelT > &lhs, Image< RhsPixelT > const &rhs)
Add lhs to Image rhs (i.e. pixel-by-pixel addition) where types are different.
Definition Image.cc:658
Image< LhsPixelT > & operator-=(Image< LhsPixelT > &lhs, Image< RhsPixelT > const &rhs)
Subtract lhs from Image rhs (i.e. pixel-by-pixel subtraction) where types are different.
Definition Image.cc:664
std::shared_ptr< Image< PixelT > > operator*(Image< PixelT > const &img, ImageSlice< PixelT > const &slc)
Overload operator*()
std::shared_ptr< Image< PixelT > > operator/(Image< PixelT > const &img, ImageSlice< PixelT > const &slc)
Overload operator/()
std::shared_ptr< Image< PixelT > > operator-(Image< PixelT > const &img, ImageSlice< PixelT > const &slc)
Overload operator-()
Definition ImageSlice.cc:89
Image< LhsPixelT > & operator/=(Image< LhsPixelT > &lhs, Image< RhsPixelT > const &rhs)
Divide lhs by Image rhs (i.e. pixel-by-pixel division) where types are different.
Definition Image.cc:676
Image< LhsPixelT > & operator*=(Image< LhsPixelT > &lhs, Image< RhsPixelT > const &rhs)
Multiply lhs by Image rhs (i.e. pixel-by-pixel multiplication) where types are different.
Definition Image.cc:670
PixelT operator()(PixelT const imgPix, PixelT const slcPix)
Definition ImageSlice.h:86
PixelT operator()(PixelT const imgPix, PixelT const slcPix)
Definition ImageSlice.h:78
PixelT operator()(PixelT const imgPix, PixelT const slcPix)
Definition ImageSlice.h:82
PixelT operator()(PixelT const imgPix, PixelT const slcPix)
Definition ImageSlice.h:74