LSSTApplications  17.0+124,17.0+14,17.0+73,18.0.0+37,18.0.0+80,18.0.0-4-g68ffd23+4,18.1.0-1-g0001055+12,18.1.0-1-g03d53ef+5,18.1.0-1-g1349e88+55,18.1.0-1-g2505f39+44,18.1.0-1-g5315e5e+4,18.1.0-1-g5e4b7ea+14,18.1.0-1-g7e8fceb+4,18.1.0-1-g85f8cd4+48,18.1.0-1-g8ff0b9f+4,18.1.0-1-ga2c679d+1,18.1.0-1-gd55f500+35,18.1.0-10-gb58edde+2,18.1.0-11-g0997b02+4,18.1.0-13-gfe4edf0b+12,18.1.0-14-g259bd21+21,18.1.0-19-gdb69f3f+2,18.1.0-2-g5f9922c+24,18.1.0-2-gd3b74e5+11,18.1.0-2-gfbf3545+32,18.1.0-26-g728bddb4+5,18.1.0-27-g6ff7ca9+2,18.1.0-3-g52aa583+25,18.1.0-3-g8ea57af+9,18.1.0-3-gb69f684+42,18.1.0-3-gfcaddf3+6,18.1.0-32-gd8786685a,18.1.0-4-gf3f9b77+6,18.1.0-5-g1dd662b+2,18.1.0-5-g6dbcb01+41,18.1.0-6-gae77429+3,18.1.0-7-g9d75d83+9,18.1.0-7-gae09a6d+30,18.1.0-9-gc381ef5+4,w.2019.45
LSSTDataManagementBasePackage
BaselineUtils.h
Go to the documentation of this file.
1 // -*- LSST-C++ -*-
2 #if !defined(LSST_DEBLENDER_BASELINE_H)
3 #define LSST_DEBLENDER_BASELINE_H
4 
6 #include <vector>
7 #include <utility>
8 
9 #include "lsst/afw/image/Image.h"
10 #include "lsst/afw/image/MaskedImage.h"
11 #include "lsst/afw/detection/Footprint.h"
12 #include "lsst/afw/detection/HeavyFootprint.h"
13 #include "lsst/afw/detection/Peak.h"
14 
15 namespace lsst {
16  namespace meas {
17  namespace deblender {
18 
19  template <typename ImagePixelT,
20  typename MaskPixelT=lsst::afw::image::MaskPixel,
21  typename VariancePixelT=lsst::afw::image::VariancePixel>
22  class BaselineUtils {
23 
24  public:
25  typedef typename lsst::afw::image::MaskedImage<ImagePixelT, MaskPixelT, VariancePixelT> MaskedImageT;
26  typedef typename PTR(lsst::afw::image::MaskedImage<ImagePixelT, MaskPixelT, VariancePixelT>) MaskedImagePtrT;
27  typedef typename lsst::afw::image::Image<ImagePixelT> ImageT;
28  typedef typename PTR(lsst::afw::image::Image<ImagePixelT>) ImagePtrT;
29  typedef typename lsst::afw::image::Mask<MaskPixelT> MaskT;
30  typedef typename PTR(lsst::afw::image::Mask<MaskPixelT>) MaskPtrT;
31 
32  typedef typename lsst::afw::detection::Footprint FootprintT;
33  typedef typename PTR(lsst::afw::detection::Footprint) FootprintPtrT;
34  typedef typename lsst::afw::detection::HeavyFootprint<ImagePixelT, MaskPixelT, VariancePixelT> HeavyFootprintT;
35 
36  typedef typename PTR(lsst::afw::detection::HeavyFootprint<ImagePixelT, MaskPixelT, VariancePixelT>) HeavyFootprintPtrT;
37 
38  static
39  PTR(lsst::afw::detection::Footprint)
40  symmetrizeFootprint(lsst::afw::detection::Footprint const& foot,
41  int cx, int cy);
42 
43  static
44  std::pair<ImagePtrT, FootprintPtrT>
45  buildSymmetricTemplate(MaskedImageT const& img,
46  lsst::afw::detection::Footprint const& foot,
47  lsst::afw::detection::PeakRecord const& pk,
48  double sigma1,
49  bool minZero,
50  bool patchEdges,
51  bool* patchedEdges);
52 
53  static void
54  medianFilter(ImageT const& img,
55  ImageT & outimg,
56  int halfsize);
57 
58  static void
59  makeMonotonic(ImageT & img,
60  lsst::afw::detection::PeakRecord const& pk);
61 
62  static const int ASSIGN_STRAYFLUX = 0x1;
63  static const int STRAYFLUX_TO_POINT_SOURCES_WHEN_NECESSARY = 0x2;
64  static const int STRAYFLUX_TO_POINT_SOURCES_ALWAYS = 0x4;
65  // split flux according to the closest distance to the template?
66  // (default is according to distance to the peak)
67  static const int STRAYFLUX_R_TO_FOOTPRINT = 0x8;
68  static const int STRAYFLUX_NEAREST_FOOTPRINT = 0x10;
69  static const int STRAYFLUX_TRIM = 0x20;
70 
71  // swig doesn't seem to understand std::vector<MaskedImagePtrT>...
72  static
73  std::vector<typename PTR(lsst::afw::image::MaskedImage<ImagePixelT, MaskPixelT, VariancePixelT>)>
74  apportionFlux(MaskedImageT const& img,
75  lsst::afw::detection::Footprint const& foot,
76  std::vector<typename PTR(lsst::afw::image::Image<ImagePixelT>)> templates,
77  std::vector<std::shared_ptr<lsst::afw::detection::Footprint> > templ_footprints,
78  //
79  ImagePtrT templ_sum,
80  std::vector<bool> const& ispsf,
81  std::vector<int> const& pkx,
82  std::vector<int> const& pky,
83  std::vector<std::shared_ptr<typename lsst::afw::detection::HeavyFootprint<ImagePixelT,MaskPixelT,VariancePixelT> > > & strays,
84  int strayFluxOptions,
85  double clipStrayFluxFraction
86  );
87 
88  static
89  bool
90  hasSignificantFluxAtEdge(ImagePtrT,
91  std::shared_ptr<lsst::afw::detection::Footprint>,
92  ImagePixelT threshold);
93 
94  static
95  std::shared_ptr<lsst::afw::detection::Footprint>
96  getSignificantEdgePixels(ImagePtrT,
97  std::shared_ptr<lsst::afw::detection::Footprint>,
98  ImagePixelT threshold);
99 
100 
101  static
102  void
103  _sum_templates(std::vector<ImagePtrT> timgs,
104  ImagePtrT tsum);
105 
106  static
107  void
108  _find_stray_flux(lsst::afw::detection::Footprint const& foot,
109  ImagePtrT tsum,
110  MaskedImageT const& img,
111  int strayFluxOptions,
112  std::vector<std::shared_ptr<lsst::afw::detection::Footprint> > tfoots,
113  std::vector<bool> const& ispsf,
114  std::vector<int> const& pkx,
115  std::vector<int> const& pky,
116  double clipStrayFluxFraction,
117  std::vector<std::shared_ptr<typename lsst::afw::detection::HeavyFootprint<ImagePixelT,MaskPixelT,VariancePixelT> > > & strays);
118 
119  };
120  }
121  }
122 }
123 
124 #endif
lsst::meas::deblender::BaselineUtils::hasSignificantFluxAtEdge
static bool hasSignificantFluxAtEdge(ImagePtrT, std::shared_ptr< lsst::afw::detection::Footprint >, ImagePixelT threshold)
Returns true if the given Footprint sfoot in image img has flux above value thresh at its edge...
Definition: BaselineUtils.cc:1387
Footprint.h
lsst::meas::deblender::BaselineUtils::getSignificantEdgePixels
static std::shared_ptr< lsst::afw::detection::Footprint > getSignificantEdgePixels(ImagePtrT, std::shared_ptr< lsst::afw::detection::Footprint >, ImagePixelT threshold)
Returns a list of pixels that are on the edge of the given Footprint sfoot* in image img...
Definition: BaselineUtils.cc:1420
lsst::meas::deblender::BaselineUtils::ImageT
lsst::afw::image::Image< ImagePixelT > ImageT
Definition: BaselineUtils.h:27
lsst::meas::deblender::BaselineUtils::STRAYFLUX_TO_POINT_SOURCES_WHEN_NECESSARY
static const int STRAYFLUX_TO_POINT_SOURCES_WHEN_NECESSARY
Definition: BaselineUtils.h:63
HeavyFootprint.h
lsst::meas::deblender::BaselineUtils::_find_stray_flux
static void _find_stray_flux(lsst::afw::detection::Footprint const &foot, ImagePtrT tsum, MaskedImageT const &img, int strayFluxOptions, std::vector< std::shared_ptr< lsst::afw::detection::Footprint > > tfoots, std::vector< bool > const &ispsf, std::vector< int > const &pkx, std::vector< int > const &pky, double clipStrayFluxFraction, std::vector< std::shared_ptr< typename lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > > > &strays)
Definition: BaselineUtils.cc:395
lsst::meas::deblender::BaselineUtils::FootprintPtrT
boost::shared_ptr< lsst::afw::detection::Footprint > FootprintPtrT
Definition: BaselineUtils.h:33
lsst::meas::deblender::BaselineUtils::MaskedImageT
lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > MaskedImageT
Definition: BaselineUtils.h:25
lsst::meas::deblender::BaselineUtils::symmetrizeFootprint
static boost::shared_ptr< lsst::afw::detection::Footprint > symmetrizeFootprint(lsst::afw::detection::Footprint const &foot, int cx, int cy)
Given a Footprint foot and peak cx,cy, returns a Footprint that is symmetric around the peak (with tw...
Definition: BaselineUtils.cc:976
lsst::afw::detection::HeavyFootprint
A set of pixels in an Image, including those pixels&#39; actual values.
Definition: HeavyFootprint.h:47
lsst::meas::deblender::BaselineUtils::STRAYFLUX_NEAREST_FOOTPRINT
static const int STRAYFLUX_NEAREST_FOOTPRINT
Definition: BaselineUtils.h:68
lsst::meas::deblender::BaselineUtils::medianFilter
static void medianFilter(ImageT const &img, ImageT &outimg, int halfsize)
Run a spatial median filter over the given input img, writing the results to out. ...
Definition: BaselineUtils.cc:149
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::afw::image::Mask
Represent a 2-dimensional array of bitmask pixels.
Definition: Mask.h:77
lsst::meas::deblender::BaselineUtils::MaskPtrT
boost::shared_ptr< lsst::afw::image::Mask< MaskPixelT > > MaskPtrT
Definition: BaselineUtils.h:30
lsst::afw::image::MaskedImage
A class to manipulate images, masks, and variance as a single object.
Definition: MaskedImage.h:73
lsst::afw::image::MaskPixel
std::int32_t MaskPixel
default type for Masks and MaskedImage Masks
Definition: LsstImageTypes.h:34
lsst::meas::deblender::BaselineUtils::MaskT
lsst::afw::image::Mask< MaskPixelT > MaskT
Definition: BaselineUtils.h:29
lsst::afw::detection::Footprint
Class to describe the properties of a detected object from an image.
Definition: Footprint.h:62
Peak.h
lsst::meas::deblender::BaselineUtils::makeMonotonic
static void makeMonotonic(ImageT &img, lsst::afw::detection::PeakRecord const &pk)
Given an image mimg and Peak location peak, overwrite mimg so that pixels further from the peak have ...
Definition: BaselineUtils.cc:227
std::vector
STL class.
lsst::meas::deblender::BaselineUtils::apportionFlux
static std::vector< typename boost::shared_ptr< lsst::afw::image::MaskedImage< ImagePixelT > MaskPixelT, VariancePixelT >)> apportionFlux(MaskedImageT const &img, lsst::afw::detection::Footprint const &foot, std::vector< typename boost::shared_ptr< lsst::afw::image::Image< ImagePixelT > >> templates, std::vector< std::shared_ptr< lsst::afw::detection::Footprint > > templ_footprints, ImagePtrT templ_sum, std::vector< bool > const &ispsf, std::vector< int > const &pkx, std::vector< int > const &pky, std::vector< std::shared_ptr< typename lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > > > &strays, int strayFluxOptions, double clipStrayFluxFraction)
Splits flux in a given image img, within a given footprint foot, among a number of templates timgs...
Definition: BaselineUtils.cc:694
lsst::meas::deblender::BaselineUtils::_sum_templates
static void _sum_templates(std::vector< ImagePtrT > timgs, ImagePtrT tsum)
Definition: BaselineUtils.cc:611
lsst::meas::deblender::BaselineUtils::FootprintT
lsst::afw::detection::Footprint FootprintT
Definition: BaselineUtils.h:32
MaskedImage.h
lsst::meas::deblender::BaselineUtils::buildSymmetricTemplate
static std::pair< ImagePtrT, FootprintPtrT > buildSymmetricTemplate(MaskedImageT const &img, lsst::afw::detection::Footprint const &foot, lsst::afw::detection::PeakRecord const &pk, double sigma1, bool minZero, bool patchEdges, bool *patchedEdges)
Given an img, footprint foot, and peak, creates a symmetric template around the peak; produce a Maske...
Definition: BaselineUtils.cc:1191
lsst::meas::deblender::BaselineUtils::STRAYFLUX_TO_POINT_SOURCES_ALWAYS
static const int STRAYFLUX_TO_POINT_SOURCES_ALWAYS
Definition: BaselineUtils.h:64
lsst::afw::image::VariancePixel
float VariancePixel
default type for MaskedImage variance images
Definition: LsstImageTypes.h:35
lsst::afw::detection::PeakRecord
Record class that represents a peak in a Footprint.
Definition: Peak.h:42
lsst::meas::deblender::BaselineUtils::MaskedImagePtrT
boost::shared_ptr< lsst::afw::image::MaskedImage< ImagePixelT > MaskPixelT, VariancePixelT > MaskedImagePtrT
Definition: BaselineUtils.h:26
lsst::afw::image::Image
A class to represent a 2-dimensional array of pixels.
Definition: Image.h:58
lsst::meas::deblender::BaselineUtils::HeavyFootprintT
lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > HeavyFootprintT
Definition: BaselineUtils.h:34
lsst::meas::deblender::BaselineUtils::HeavyFootprintPtrT
boost::shared_ptr< lsst::afw::detection::HeavyFootprint< ImagePixelT > MaskPixelT, VariancePixelT > HeavyFootprintPtrT
Definition: BaselineUtils.h:36
sigma1
table::Key< double > sigma1
Definition: FunctionLibrary.cc:20
lsst::meas::deblender::BaselineUtils::ImagePtrT
boost::shared_ptr< lsst::afw::image::Image< ImagePixelT > > ImagePtrT
Definition: BaselineUtils.h:28
PTR
#define PTR(...)
Definition: base.h:41
Generated on Sat Nov 16 2019 09:14:50 for LSSTApplications by   doxygen 1.8.13