lsst::coadd::utils Namespace Reference

Namespaces
namespace	version

Functions
template<typename CoaddPixelT , typename WeightPixelT >
lsst::geom::Box2I	addToCoadd (lsst::afw::image::Image< CoaddPixelT > &coadd, lsst::afw::image::Image< WeightPixelT > &weightMap, lsst::afw::image::Image< CoaddPixelT > const &image, WeightPixelT weight)
	add good pixels from an image to a coadd and associated weight map
template<typename CoaddPixelT , typename WeightPixelT >
lsst::geom::Box2I	addToCoadd (lsst::afw::image::MaskedImage< CoaddPixelT, lsst::afw::image::MaskPixel, lsst::afw::image::VariancePixel > &coadd, lsst::afw::image::Image< WeightPixelT > &weightMap, lsst::afw::image::MaskedImage< CoaddPixelT, lsst::afw::image::MaskPixel, lsst::afw::image::VariancePixel > const &maskedImage, lsst::afw::image::MaskPixel const badPixelMask, WeightPixelT weight)
	add good pixels from a masked image to a coadd image and associated weight map
template<typename ImagePixelT >
int	copyGoodPixels (lsst::afw::image::Image< ImagePixelT > &destImage, lsst::afw::image::Image< ImagePixelT > const &srcImage)
	copy good pixels from one image to another
template<typename ImagePixelT >
int	copyGoodPixels (lsst::afw::image::MaskedImage< ImagePixelT, lsst::afw::image::MaskPixel, lsst::afw::image::VariancePixel > &destImage, lsst::afw::image::MaskedImage< ImagePixelT, lsst::afw::image::MaskPixel, lsst::afw::image::VariancePixel > const &srcImage, lsst::afw::image::MaskPixel const badPixelMask)
	copy good pixels from one masked image to another
template<typename WeightPixelT >
void	setCoaddEdgeBits (lsst::afw::image::Mask< lsst::afw::image::MaskPixel > &coaddMask, lsst::afw::image::Image< WeightPixelT > const &weightMap)
	set edge bits of coadd mask based on weight map
void	wrapAddtoCoadd (WrapperCollection &wrappers)
void	wrapCopyGoodPixels (WrapperCollection &wrappers)
void	wrapSetCoaddEdgeBits (WrapperCollection &wrappers)
	PYBIND11_MODULE (_coaddUtilsLib, mod)

Detailed Description

lsst.coadd.utils

Function Documentation

addToCoadd() [1/2]

template<typename CoaddPixelT , typename WeightPixelT >

lsst::geom::Box2I lsst::coadd::utils::addToCoadd	(	lsst::afw::image::Image< CoaddPixelT > &	coadd,
		lsst::afw::image::Image< WeightPixelT > &	weightMap,
		lsst::afw::image::Image< CoaddPixelT > const &	image,
		WeightPixelT	weight )

add good pixels from an image to a coadd and associated weight map

The images are assumed to be registered to the same wcs and parent origin, thus: coadd[i+coadd.x0, j+coadd.y0] += image[i+image.x0, j+image.y0] weightMap[i+weightMap.x0, j+weightMap.y0] += weight for all good image pixels that overlap a coadd pixel. Good pixels are those that are not NaN (thus they do include +/- inf).

Returns

overlapBBox: overlapping bounding box, relative to parent image (hence xy0 is taken into account)

Exceptions

pexExcept::InvalidParameterError

if coadd and weightMap dimensions or xy0 do not match.

Parameters

[in,out]	coadd	coadd to be modified
[in,out]	weightMap	weight map to be modified; this is the sum of weights of all images contributing each pixel of the coadd
	image	image to add to coadd
	weight	relative weight of this image

Definition at line 127 of file addToCoadd.cc.

  {
    typedef lsst::afw::image::Image<CoaddPixelT> Image;
    return addToCoaddImpl<Image, WeightPixelT, CheckKnownValue>(coadd, weightMap, image, 0x0, weight);
}

addToCoadd() [2/2]

template<typename CoaddPixelT , typename WeightPixelT >

lsst::geom::Box2I lsst::coadd::utils::addToCoadd	(	lsst::afw::image::MaskedImage< CoaddPixelT, lsst::afw::image::MaskPixel, lsst::afw::image::VariancePixel > &	coadd,
		lsst::afw::image::Image< WeightPixelT > &	weightMap,
		lsst::afw::image::MaskedImage< CoaddPixelT, lsst::afw::image::MaskPixel, lsst::afw::image::VariancePixel > const &	maskedImage,
		lsst::afw::image::MaskPixel const	badPixelMask,
		WeightPixelT	weight )

add good pixels from a masked image to a coadd image and associated weight map

The images are assumed to be registered to the same wcs and parent origin, thus: coadd[i+coadd.x0, j+coadd.y0] += image[i+image.x0, j+image.y0] weightMap[i+weightMap.x0, j+weightMap.y0] += weight for all good image pixels that overlap a coadd pixel. Good pixels are those for which mask & badPixelMask == 0.

Returns

overlapBBox: overlapping bounding box, relative to parent image (hence xy0 is taken into account)

Exceptions

pexExcept::InvalidParameterError

if coadd and weightMap dimensions or xy0 do not match.

Parameters

[in,out]	coadd	coadd to be modified
[in,out]	weightMap	weight map to be modified; this is the sum of weights of all images contributing each pixel of the coadd
	maskedImage	masked image to add to coadd
	badPixelMask	skip input pixel if input mask & badPixelMask !=0
	weight	relative weight of this image

Definition at line 139 of file addToCoadd.cc.

  {
    typedef lsst::afw::image::MaskedImage<CoaddPixelT> Image;
    return addToCoaddImpl<Image,WeightPixelT,CheckMask>(coadd, weightMap, maskedImage, badPixelMask, weight);
}

copyGoodPixels() [1/2]

template<typename ImagePixelT >

int lsst::coadd::utils::copyGoodPixels	(	lsst::afw::image::Image< ImagePixelT > &	destImage,
		lsst::afw::image::Image< ImagePixelT > const &	srcImage )

copy good pixels from one image to another

Good pixels are those that are not NaN (thus they do include +/- inf).

Only the overlapping pixels (relative to the parent) are copied; thus the images do not have to be the same size.

Returns

number of pixels copied

Parameters

[in,out]	destImage	image to be modified
	srcImage	image to copy

Definition at line 116 of file copyGoodPixels.cc.

  {
    typedef lsst::afw::image::Image<ImagePixelT> Image;
    return copyGoodPixelsImpl<Image, CheckKnownValue>(destImage, srcImage, 0x0);
}

copyGoodPixels() [2/2]

template<typename ImagePixelT >

int lsst::coadd::utils::copyGoodPixels	(	lsst::afw::image::MaskedImage< ImagePixelT, lsst::afw::image::MaskPixel, lsst::afw::image::VariancePixel > &	destImage,
		lsst::afw::image::MaskedImage< ImagePixelT, lsst::afw::image::MaskPixel, lsst::afw::image::VariancePixel > const &	srcImage,
		lsst::afw::image::MaskPixel const	badPixelMask )

copy good pixels from one masked image to another

Good pixels are those for which mask & badPixelMask == 0.

Only the overlapping pixels (relative to the parent) are copied; thus the images do not have to be the same size.

Returns

number of pixels copied

Parameters

[in,out]	destImage	image to be modified
	srcImage	image to copy
	badPixelMask	skip input pixel if src mask & badPixelMask != 0

Definition at line 126 of file copyGoodPixels.cc.

  {
    typedef lsst::afw::image::MaskedImage<ImagePixelT> Image;
    return copyGoodPixelsImpl<Image, CheckMask>(destImage, srcImage, badPixelMask);
}

PYBIND11_MODULE()

lsst::coadd::utils::PYBIND11_MODULE	(	_coaddUtilsLib	,
		mod	)

Definition at line 36 of file _coaddUtilsLib.cc.

                                     {
    lsst::cpputils::python::WrapperCollection wrappers(mod, "lsst.coadd.utils");
    wrappers.addSignatureDependency("lsst.afw.image");
    wrappers.addSignatureDependency("lsst.afw.geom");
    wrapAddtoCoadd(wrappers);
    wrapCopyGoodPixels(wrappers);
    wrapSetCoaddEdgeBits(wrappers);
    wrappers.finish();
}

setCoaddEdgeBits()

template<typename WeightPixelT >

void lsst::coadd::utils::setCoaddEdgeBits	(	lsst::afw::image::Mask< lsst::afw::image::MaskPixel > &	coaddMask,
		lsst::afw::image::Image< WeightPixelT > const &	weightMap )

set edge bits of coadd mask based on weight map

Set pixels in the image to the edge pixel when the corresponding pixel in the weight map is zero. The edge pixel is image=nan, variance=inf, mask=NO_DATA for masked images and image=nan for plain images.

Exceptions

pexExcept::InvalidParameterError

if the dimensions of coaddMask and weightMap do not match.

Parameters

[in,out]	coaddMask	mask of coadd
	weightMap	weight map

Definition at line 42 of file setCoaddEdgeBits.cc.

  {
    typedef afwImage::Mask<afwImage::MaskPixel>::x_iterator MaskXIter;
    typedef typename afwImage::Image<WeightPixelT>::const_x_iterator WeightMapConstXIter;
 
    if (coaddMask.getDimensions() != weightMap.getDimensions()) {
        throw LSST_EXCEPT(pexExcept::InvalidParameterError,
            (boost::format("coaddMask and weightMap dimensions differ: %dx%d != %dx%d") %
            coaddMask.getWidth() % coaddMask.getHeight() % weightMap.getWidth() % weightMap.getHeight()
            ).str());
    }
 
    afwImage::MaskPixel const edgeMask = afwImage::Mask<afwImage::MaskPixel>::getPlaneBitMask("NO_DATA");
 
    // Set the pixels row by row, to avoid repeated checks for end-of-row
    for (int y = 0, endY = weightMap.getHeight(); y != endY; ++y) {
        WeightMapConstXIter weightMapPtr = weightMap.row_begin(y);
        WeightMapConstXIter const weightMapEndPtr = weightMap.row_end(y);
        MaskXIter coaddMaskPtr = coaddMask.row_begin(y);
        for (; weightMapPtr != weightMapEndPtr; ++weightMapPtr, ++coaddMaskPtr) {
            if (*weightMapPtr == 0) {
                (*coaddMaskPtr) = (*coaddMaskPtr) | edgeMask;
            }
        }
    }
}

wrapAddtoCoadd()

void lsst::coadd::utils::wrapAddtoCoadd

(

WrapperCollection &

wrappers

)

Definition at line 57 of file addToCoadd.cc.

                                                                   {
    auto &mod = wrappers.module;
    declareAddToCoadd<double, double>(mod);
    declareAddToCoadd<double, float>(mod);
    declareAddToCoadd<double, int>(mod);
    declareAddToCoadd<double, std::uint16_t>(mod);
    declareAddToCoadd<float, double>(mod);
    declareAddToCoadd<float, float>(mod);
    declareAddToCoadd<float, int>(mod);
    declareAddToCoadd<float, std::uint16_t>(mod);
}

wrapCopyGoodPixels()

void lsst::coadd::utils::wrapCopyGoodPixels

(

WrapperCollection &

wrappers

)

Definition at line 53 of file copyGoodPixels.cc.

                                                                       {
    auto &mod = wrappers.module;
    declareCopyGoodPixels<double>(mod);
    declareCopyGoodPixels<float>(mod);
    declareCopyGoodPixels<int>(mod);
    declareCopyGoodPixels<std::uint16_t>(mod);
}

wrapSetCoaddEdgeBits()

void lsst::coadd::utils::wrapSetCoaddEdgeBits

(

WrapperCollection &

wrappers

)

Definition at line 49 of file setCoaddEdgeBits.cc.

                                                                         {
    auto &mod = wrappers.module;
    declareSetCoaddEdgeBits<double>(mod);
    declareSetCoaddEdgeBits<float>(mod);
    declareSetCoaddEdgeBits<int>(mod);
    declareSetCoaddEdgeBits<std::uint16_t>(mod);
}