Template Function lsst::ip::diffim::convolveAndSubtract(lsst::afw::image::Image<PixelT> const&, lsst::afw::image::MaskedImage<PixelT> const&, lsst::afw::math::Kernel const&, BackgroundT, bool)

Function Documentation

template<typename PixelT, typename BackgroundT>
lsst::afw::image::MaskedImage<PixelT> lsst::ip::diffim::convolveAndSubtract(lsst::afw::image::Image<PixelT> const &templateImage, lsst::afw::image::MaskedImage<PixelT> const &scienceMaskedImage, lsst::afw::math::Kernel const &convolutionKernel, BackgroundT background, bool invert = true)

Execute fundamental task of convolving template and subtracting it from science image.

Note

This version accepts an Image for the template, and is thus faster during convolution

Parameters
  • templateImage: Image to apply convolutionKernel to

  • scienceMaskedImage: MaskedImage from which convolved templateImage is subtracted

  • convolutionKernel: Kernel to apply to templateImage

  • background: Background scalar or function to subtract after convolution

  • invert: Invert the output difference image