lsst.afw.math::WarpingControl Class Reference

Parameters to control convolution. More...

#include <warpExposure.h>

Public Member Functions
	WarpingControl (std::string const &warpingKernelName, std::string const &maskWarpingKernelName="", int cacheSize=0, int interpLength=0, lsst::afw::gpu::DevicePreference devicePreference=lsst::afw::gpu::DEFAULT_DEVICE_PREFERENCE, lsst::afw::image::MaskPixel growFullMask=0)
	Construct a WarpingControl object. More...
	WarpingControl (SeparableKernel &warpingKernel, int interpLength=0, lsst::afw::gpu::DevicePreference devicePreference=lsst::afw::gpu::DEFAULT_DEVICE_PREFERENCE)
	This constructor supports the deprecated legacy warping API. More...
virtual	~WarpingControl ()
int	getCacheSize () const
	get the cache size for the interpolation kernel(s) More...
void	setCacheSize (int cacheSize)
	set the cache size for the interpolation kernel(s) More...
int	getInterpLength () const
	get the interpolation length (pixels) More...
void	setInterpLength (int interpLength)
	set the interpolation length More...
lsst::afw::gpu::DevicePreference	getDevicePreference () const
	get the GPU device preference More...
void	setDevicePreference (lsst::afw::gpu::DevicePreference devicePreference)
	set the GPU device preference More...
boost::shared_ptr < SeparableKernel >	getWarpingKernel () const
	get the warping kernel More...
void	setWarpingKernelName (std::string const &warpingKernelName)
	set the warping kernel by name More...
void	setWarpingKernel (SeparableKernel const &warpingKernel)
	set the warping kernel More...
boost::shared_ptr < SeparableKernel >	getMaskWarpingKernel () const
	get the mask warping kernel More...
bool	hasMaskWarpingKernel () const
	return true if there is a mask kernel More...
void	setMaskWarpingKernelName (std::string const &maskWarpingKernelName)
	set or clear the mask warping kernel by name More...
void	setMaskWarpingKernel (SeparableKernel const &maskWarpingKernel)
	set the mask warping kernel More...
lsst::afw::image::MaskPixel	getGrowFullMask () const
	get mask bits to grow to full width of image/variance kernel More...
void	setGrowFullMask (lsst::afw::image::MaskPixel growFullMask)
	set mask bits to grow to full width of image/variance kernel More...

Private Member Functions
void	_testWarpingKernels (SeparableKernel const &warpingKernel, SeparableKernel const &maskWarpingKernel) const
	Throw an exception if the two kernels are not compatible in shape. More...
void	_testDevicePreference (lsst::afw::gpu::DevicePreference const &devicePreference, boost::shared_ptr< SeparableKernel const > const &warpingKernelPtr) const
	test if GPU device preference and main warping kernel are compatible More...

Private Attributes
boost::shared_ptr < SeparableKernel >	_warpingKernelPtr
boost::shared_ptr < SeparableKernel >	_maskWarpingKernelPtr
int	_cacheSize
int	_interpLength
lsst::afw::gpu::DevicePreference	_devicePreference
	choose CPU or GPU acceleration More...
lsst::afw::image::MaskPixel	_growFullMask

Detailed Description

Parameters to control convolution.

Note

padValue is not member of this class to avoid making this a templated class.

Warning

: GPU acceleration requires interpLength > 0

Definition at line 239 of file warpExposure.h.

Constructor & Destructor Documentation

lsst.afw.math::WarpingControl::WarpingControl ( std::string const &  warpingKernelName, std::string const &  maskWarpingKernelName = "", int  cacheSize = 0, int  interpLength = 0, lsst::afw::gpu::DevicePreference  devicePreference = lsst::afw::gpu::DEFAULT_DEVICE_PREFERENCE, lsst::afw::image::MaskPixel  growFullMask = 0  )

inlineexplicit

Construct a WarpingControl object.

Warning

: the GPU code does not yet support warping the mask with a separate kernel. Thus if maskWarpingKernelName is provided the GPU is disabled (or an exception is raised if the GPU is required)

Exceptions

pex_exceptions	InvalidParameterError if the warping kernel is smaller than the mask warping kernel.
pex_exceptions	InvalidParameterError if GPU is required and maskWarpingKernelName supplied.

Parameters

warpingKernelName	name of warping kernel; used as the argument to makeWarpingKernel
maskWarpingKernelName	name of warping kernel used for the mask plane; if "" then the regular warping kernel is used. Intended so one can use a bilinear kernel or other compact kernel for the mask plane to avoid smearing mask bits too far. The theory is that bad pixels are already interpolated over, so we don't need to worry about bad values spreading very far.
cacheSize	cache size for warping kernel; no cache if 0 (used as the argument to the warping kernels' computeCache method)
interpLength	distance over which the WCS can be linearly interpolated
devicePreference	use GPU acceleration?
growFullMask	mask bits to grow to full width of image/variance kernel

Definition at line 253 of file warpExposure.h.

          :
            _warpingKernelPtr(makeWarpingKernel(warpingKernelName)),
            _maskWarpingKernelPtr(),
            _cacheSize(cacheSize),
            _interpLength(interpLength),
            _devicePreference(devicePreference),
            _growFullMask(growFullMask)
        {
            setMaskWarpingKernelName(maskWarpingKernelName);
            _testDevicePreference(_devicePreference, _warpingKernelPtr);
        }

lsst.afw.math::WarpingControl::WarpingControl ( SeparableKernel &  warpingKernel, int  interpLength = 0, lsst::afw::gpu::DevicePreference  devicePreference = lsst::afw::gpu::DEFAULT_DEVICE_PREFERENCE  )

inlineexplicit

This constructor supports the deprecated legacy warping API.

Parameters

warpingKernel	warping kernel
interpLength	distance over which the WCS can be linearly interpolated; 0 means no interpolation and uses an optimized branch of the code 1 also performs no interpolation but it runs the interpolation code branch (and so is only intended for unit tests)
devicePreference	use GPU acceleration?

Definition at line 283 of file warpExposure.h.

          :
            _warpingKernelPtr(boost::dynamic_pointer_cast<SeparableKernel>(warpingKernel.clone())),
            _maskWarpingKernelPtr(),
            _cacheSize(warpingKernel.getCacheSize()),
            _interpLength(interpLength),
            _devicePreference(devicePreference),
            _growFullMask(lsst::afw::image::Mask<lsst::afw::image::MaskPixel>::getPlaneBitMask("EDGE") |
                          lsst::afw::image::Mask<lsst::afw::image::MaskPixel>::getPlaneBitMask("NO_DATA"))
        {
            _testDevicePreference(_devicePreference, _warpingKernelPtr);
        }

virtual lsst.afw.math::WarpingControl::~WarpingControl ( )

inlinevirtual

Definition at line 304 of file warpExposure.h.

{};

Member Function Documentation

void lsst.afw.math::WarpingControl::_testDevicePreference ( lsst::afw::gpu::DevicePreference const &  devicePreference, boost::shared_ptr< SeparableKernel const > const &  warpingKernelPtr  ) const

private

test if GPU device preference and main warping kernel are compatible

Exceptions

lsst::pex::exceptions::InvalidParameterError

if the parameters are incompatible

Parameters

devicePreference	GPU device preference
warpingKernelPtr	warping kernel

Definition at line 288 of file warpExposure.cc.

        {
    CONST_PTR(LanczosWarpingKernel) const lanczosKernelPtr =
        boost::dynamic_pointer_cast<const LanczosWarpingKernel>(warpingKernelPtr);
    if (devicePreference == lsst::afw::gpu::USE_GPU && !lanczosKernelPtr) {
        throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
            "devicePreference = USE_GPU, but warping kernel not Lanczos");
    }
}

void lsst.afw.math::WarpingControl::_testWarpingKernels ( SeparableKernel const &  warpingKernel, SeparableKernel const &  maskWarpingKernel  ) const

private

Throw an exception if the two kernels are not compatible in shape.

Exceptions

lsst::pex::exceptions::InvalidParameterError

if the two kernels are not compatible in shape

Parameters

warpingKernel	warping kernel
maskWarpingKernel	mask warping kernel

Definition at line 270 of file warpExposure.cc.

        {
    lsst::afw::geom::Box2I kernelBBox = lsst::afw::geom::Box2I(
        lsst::afw::geom::Point2I(0, 0) - lsst::afw::geom::Extent2I(warpingKernel.getCtr()),
        warpingKernel.getDimensions()
    );
    lsst::afw::geom::Box2I maskKernelBBox = lsst::afw::geom::Box2I(
        lsst::afw::geom::Point2I(0, 0) - lsst::afw::geom::Extent2I(maskWarpingKernel.getCtr()),
        maskWarpingKernel.getDimensions()
    );
    if (!kernelBBox.contains(maskKernelBBox)) {
        throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
            "warping kernel is smaller than mask warping kernel");
    }
}

int lsst.afw.math::WarpingControl::getCacheSize ( ) const

inline

get the cache size for the interpolation kernel(s)

Definition at line 309 of file warpExposure.h.

{ return _cacheSize; };

lsst::afw::gpu::DevicePreference lsst.afw.math::WarpingControl::getDevicePreference ( ) const

inline

get the GPU device preference

Definition at line 343 of file warpExposure.h.

{ return _devicePreference; };

lsst::afw::image::MaskPixel lsst.afw.math::WarpingControl::getGrowFullMask ( ) const

inline

get mask bits to grow to full width of image/variance kernel

Definition at line 406 of file warpExposure.h.

{ return _growFullMask; };

int lsst.afw.math::WarpingControl::getInterpLength ( ) const

inline

get the interpolation length (pixels)

Definition at line 326 of file warpExposure.h.

{ return _interpLength; };

boost::shared_ptr< afwMath::SeparableKernel > lsst.afw.math::WarpingControl::getMaskWarpingKernel

(

)

const

get the mask warping kernel

Definition at line 242 of file warpExposure.cc.

                                                                              {
    if (_maskWarpingKernelPtr) { // lazily update kernel cache
        if (_maskWarpingKernelPtr->getCacheSize() != _cacheSize) {
            _maskWarpingKernelPtr->computeCache(_cacheSize);
        }
    }
    return _maskWarpingKernelPtr;
}

boost::shared_ptr< afwMath::SeparableKernel > lsst.afw.math::WarpingControl::getWarpingKernel

(

)

const

get the warping kernel

Definition at line 216 of file warpExposure.cc.

                                                                          {
    if (_warpingKernelPtr->getCacheSize() != _cacheSize) {
        _warpingKernelPtr->computeCache(_cacheSize);
    }
    return _warpingKernelPtr;
};

bool lsst.afw.math::WarpingControl::hasMaskWarpingKernel ( ) const

inline

return true if there is a mask kernel

Definition at line 384 of file warpExposure.h.

{ return static_cast<bool>(_maskWarpingKernelPtr); }

void lsst.afw.math::WarpingControl::setCacheSize ( int  cacheSize )

inline

set the cache size for the interpolation kernel(s)

A value of 0 disables the cache for maximum accuracy. 10,000 typically results in a warping error of a fraction of a count. 100,000 typically results in a warping error of less than 0.01 count. Note the new cache is not computed until getWarpingKernel or getMaskWarpingKernel is called.

Parameters

cacheSize

cache size

Definition at line 319 of file warpExposure.h.

          { _cacheSize = cacheSize; };

void lsst.afw.math::WarpingControl::setDevicePreference ( lsst::afw::gpu::DevicePreference  devicePreference )

inline

set the GPU device preference

Parameters

devicePreference

device preference

Definition at line 348 of file warpExposure.h.

          {
            _testDevicePreference(devicePreference, _warpingKernelPtr);
            _devicePreference = devicePreference;
        }

void lsst.afw.math::WarpingControl::setGrowFullMask ( lsst::afw::image::MaskPixel  growFullMask )

inline

set mask bits to grow to full width of image/variance kernel

Parameters

growFullMask

device preference

Definition at line 411 of file warpExposure.h.

          { _growFullMask = growFullMask; }

void lsst.afw.math::WarpingControl::setInterpLength ( int  interpLength )

inline

set the interpolation length

Interpolation length is the distance over which the WCS can be linearly interpolated, in pixels:

• 0 means no interpolation and uses an optimized branch of the code
• 1 also performs no interpolation but it runs the interpolation code branch (and so is only intended for unit tests)

Parameters

interpLength

interpolation length (pixels)

Definition at line 336 of file warpExposure.h.

          { _interpLength = interpLength; };

void lsst.afw.math::WarpingControl::setMaskWarpingKernel

(

SeparableKernel const &

maskWarpingKernel

)

set the mask warping kernel

Note

To clear the mask warping kernel use setMaskWarpingKernelName("").

Parameters

maskWarpingKernel

mask warping kernel

Definition at line 262 of file warpExposure.cc.

  {
    _testWarpingKernels(*_warpingKernelPtr, maskWarpingKernel);
    _maskWarpingKernelPtr = boost::static_pointer_cast<SeparableKernel>(maskWarpingKernel.clone());
}

void lsst.afw.math::WarpingControl::setMaskWarpingKernelName

(

std::string const &

maskWarpingKernelName

)

set or clear the mask warping kernel by name

Parameters

maskWarpingKernelName

name of mask warping kernel; use "" to clear the kernel

Definition at line 251 of file warpExposure.cc.

  {
    if (!maskWarpingKernelName.empty()) {
        PTR(SeparableKernel) maskWarpingKernelPtr(makeWarpingKernel(maskWarpingKernelName));
        setMaskWarpingKernel(*maskWarpingKernelPtr);
    } else {
        _maskWarpingKernelPtr.reset();
    }
}

void lsst.afw.math::WarpingControl::setWarpingKernel

(

SeparableKernel const &

warpingKernel

)

set the warping kernel

Exceptions

lsst::pex::exceptions::InvalidParameterError

if new kernel pointer is empty.

Parameters

warpingKernel

warping kernel

Definition at line 230 of file warpExposure.cc.

  {
    if (_maskWarpingKernelPtr) {
        _testWarpingKernels(warpingKernel, *_maskWarpingKernelPtr);
    }
    PTR(SeparableKernel) warpingKernelPtr(boost::static_pointer_cast<SeparableKernel>(warpingKernel.clone()));
    _testDevicePreference(_devicePreference, warpingKernelPtr);
    _warpingKernelPtr = warpingKernelPtr;
}

void lsst.afw.math::WarpingControl::setWarpingKernelName

(

std::string const &

warpingKernelName

)

set the warping kernel by name

Parameters

warpingKernelName

name of warping kernel

Definition at line 223 of file warpExposure.cc.

  {
    PTR(SeparableKernel) warpingKernelPtr(makeWarpingKernel(warpingKernelName));
    setWarpingKernel(*warpingKernelPtr);
}

Member Data Documentation

int lsst.afw.math::WarpingControl::_cacheSize

private

Definition at line 439 of file warpExposure.h.

lsst::afw::gpu::DevicePreference lsst.afw.math::WarpingControl::_devicePreference

private

choose CPU or GPU acceleration

Definition at line 441 of file warpExposure.h.

lsst::afw::image::MaskPixel lsst.afw.math::WarpingControl::_growFullMask

private

Definition at line 442 of file warpExposure.h.

int lsst.afw.math::WarpingControl::_interpLength

private

Definition at line 440 of file warpExposure.h.

boost::shared_ptr< SeparableKernel > lsst.afw.math::WarpingControl::_maskWarpingKernelPtr

private

Definition at line 438 of file warpExposure.h.

boost::shared_ptr< SeparableKernel > lsst.afw.math::WarpingControl::_warpingKernelPtr

private

Definition at line 437 of file warpExposure.h.

---

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

• /home/lsstsw/stack/Linux64/afw/11.0.rc2+4/include/lsst/afw/math/warpExposure.h
• /home/lsstsw/stack/Linux64/afw/11.0.rc2+4/src/math/warpExposure.cc