lsst::meas::algorithms::CloughTocher2DInterpolatorUtils Class Reference

This class contains static utility methods that are used by the CloughTocher2DInterpolatorTask and exists solely to provide a namespace. More...

#include <CloughTocher2DInterpolatorUtils.h>

Static Public Member Functions
static std::pair< ndarray::Array< float, 2, 2 >, ndarray::Array< float, 2, 2 > >	findGoodPixelsAroundBadPixels (afw::image::MaskedImage< PixelT, afw::image::MaskPixel, afw::image::VariancePixel > const &mimage, std::vector< std::string > const &maskPlanes, int const buffer)
	Find the positions of bad pixels as defined by the masks, and also find the location and pixel value of good pixels around the bad pixels.
static void	updateArrayFromImage (ndarray::Array< float, 2, 2 > const &pixelArray, afw::image::Image< PixelT > const &image)
	Update the values (third column) of the pixelArray from the image.
static void	updateImageFromArray (afw::image::Image< PixelT > &image, ndarray::Array< float const, 2, 2 > const &pixelArray)
	Update the pixel values of the image from the pixelArray.

Detailed Description

This class contains static utility methods that are used by the CloughTocher2DInterpolatorTask and exists solely to provide a namespace.

Definition at line 44 of file CloughTocher2DInterpolatorUtils.h.

Member Function Documentation

findGoodPixelsAroundBadPixels()

std::pair< ndarray::Array< float, 2, 2 >, ndarray::Array< float, 2, 2 > > lsst::meas::algorithms::CloughTocher2DInterpolatorUtils::findGoodPixelsAroundBadPixels ( afw::image::MaskedImage< PixelT, afw::image::MaskPixel, afw::image::VariancePixel > const & mimage, std::vector< std::string > const & maskPlanes, int const buffer )

static

Find the positions of bad pixels as defined by the masks, and also find the location and pixel value of good pixels around the bad pixels.

Parameters

[in]	mimage	MaskedImage to find the pixels from.
[in]	maskPlanes	List of mask planes to consider as bad pixels.
[in]	buffer	Number of pixels to dilate the bad pixels by.

Returns

A pair of arrays, the first containing the bad pixels and the second containing the good pixels.

Note

The bad pixels array has shape (N, 3) where N is the number of bad pixels. The first column is the x coordinate, the second column is the y coordinate, and the third column is the pixel value. The good pixels array has shape (M, 3) where M is the number of good pixels and has the same format as the previous one.

Definition at line 43 of file CloughTocher2DInterpolatorUtils.cc.

                                                                                 {
    auto bitMask = afw::image::Mask<>::getPlaneBitMask(maskPlanes);
 
    auto badSpanSet = afw::geom::SpanSet::fromMask(
            *mimage.getMask(), [bitMask](afw::image::MaskPixel pixel) { return bool(pixel & bitMask); });
    ndarray::Array<float, 2, 2> badPixelArray = ndarray::allocate(badSpanSet->getArea(), 3);
    badSpanSet->applyFunctor(
            [](geom::Point2I pt, float &x, float &y, float &valueOut, float valueIn) {
                x = pt.getX();
                y = pt.getY();
                valueOut = valueIn;
            },
            ndFlat(badPixelArray[ndarray::view()(0)].shallow()),
            ndFlat(badPixelArray[ndarray::view()(1)].shallow()),
            ndFlat(badPixelArray[ndarray::view()(2)].shallow()),
            *mimage.getImage());
 
    auto allSpanSet = badSpanSet->dilated(buffer, afw::geom::Stencil::BOX);
    auto goodSpanSet = allSpanSet->intersectNot(*badSpanSet);
    goodSpanSet = goodSpanSet->clippedTo(mimage.getBBox());
 
    badSpanSet.reset();
    allSpanSet.reset();
 
    ndarray::Array<float, 2, 2> goodPixelArray = ndarray::allocate(goodSpanSet->getArea(), 3);
    goodSpanSet->applyFunctor(
            [](geom::Point2I pt, float &x, float &y, float &valueOut, float valueIn) {
                x = pt.getX();
                y = pt.getY();
                valueOut = valueIn;
            },
            ndFlat(goodPixelArray[ndarray::view()(0)].shallow()),
            ndFlat(goodPixelArray[ndarray::view()(1)].shallow()),
            ndFlat(goodPixelArray[ndarray::view()(2)].shallow()),
            *mimage.getImage());
 
    goodSpanSet.reset();
 
    return std::make_pair(badPixelArray, goodPixelArray);
}

updateArrayFromImage()

void lsst::meas::algorithms::CloughTocher2DInterpolatorUtils::updateArrayFromImage ( ndarray::Array< float, 2, 2 > const & pixelArray, afw::image::Image< PixelT > const & image )

static

Update the values (third column) of the pixelArray from the image.

Parameters

[out]	pixelArray	The three-column array to update.
[in]	image	The image to update the pixel values from.

Note

The pixelArray is typically one of the arrays returned by findGoodPixelsAroundBadPixels.

See also

updateImageFromArray

Definition at line 86 of file CloughTocher2DInterpolatorUtils.cc.

                                                                                              {
    afw::image::CheckIndices docheck(true);
    auto x0 = image.getX0();
    auto y0 = image.getY0();
    for (auto row : pixelArray) {
        int x = row[0] - x0;
        int y = row[1] - y0;
        row[2] = image(x, y, docheck);
    }
}

updateImageFromArray()

void lsst::meas::algorithms::CloughTocher2DInterpolatorUtils::updateImageFromArray ( afw::image::Image< PixelT > & image, ndarray::Array< float const, 2, 2 > const & pixelArray )

static

Update the pixel values of the image from the pixelArray.

Parameters

[out]	image	The image to update.
[in]	pixelArray	The three-column array to update the pixel values from.

Note

The pixelArray is typically one of the arrays returned by findGoodPixelsAroundBadPixels.

See also

updateArrayFromImage

Definition at line 98 of file CloughTocher2DInterpolatorUtils.cc.

                                                                                        {
    afw::image::CheckIndices docheck(true);
    auto x0 = image.getX0();
    auto y0 = image.getY0();
    for (auto row : pixelArray) {
        int x = row[0] - x0;
        int y = row[1] - y0;
        image(x, y, docheck) = row[2];
    }
}

---

The documentation for this class was generated from the following files:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_algorithms/ge6526c86ff+84383d05b3/include/lsst/meas/algorithms/CloughTocher2DInterpolatorUtils.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_algorithms/ge6526c86ff+84383d05b3/src/CloughTocher2DInterpolatorUtils.cc