lsst.afw.math::ConvolutionControl Class Reference

Parameters to control convolution. More...

#include <ConvolveImage.h>

Public Member Functions
	ConvolutionControl (bool doNormalize=true, bool doCopyEdge=false, int maxInterpolationDistance=10, lsst::afw::gpu::DevicePreference devicePreference=lsst::afw::gpu::DEFAULT_DEVICE_PREFERENCE)
bool	getDoNormalize () const
bool	getDoCopyEdge () const
int	getMaxInterpolationDistance () const
lsst::afw::gpu::DevicePreference	getDevicePreference () const
void	setDoNormalize (bool doNormalize)
void	setDoCopyEdge (bool doCopyEdge)
void	setMaxInterpolationDistance (int maxInterpolationDistance)
void	setDevicePreference (lsst::afw::gpu::DevicePreference devicePreference)

Private Attributes
bool	_doNormalize
	normalize the kernel to sum=1? More...
bool	_doCopyEdge
	instead of setting them to the standard edge pixel? More...
int	_maxInterpolationDistance
	over which to attempt interpolation More...
lsst::afw::gpu::DevicePreference	_devicePreference
	choose CPU or GPU acceleration More...

Detailed Description

Parameters to control convolution.

Definition at line 58 of file ConvolveImage.h.

Constructor & Destructor Documentation

lsst.afw.math::ConvolutionControl::ConvolutionControl ( bool  doNormalize = true, bool  doCopyEdge = false, int  maxInterpolationDistance = 10, lsst::afw::gpu::DevicePreference  devicePreference = lsst::afw::gpu::DEFAULT_DEVICE_PREFERENCE  )

inline

Parameters

doNormalize	normalize the kernel to sum=1?
doCopyEdge	copy edge pixels from source image instead of setting them to the standard edge pixel?
maxInterpolationDistance	maximum width or height of a region over which to use linear interpolation interpolate
devicePreference	use Gpu acceleration?

Definition at line 60 of file ConvolveImage.h.

        :
            _doNormalize(doNormalize),
            _doCopyEdge(doCopyEdge),
            _maxInterpolationDistance(maxInterpolationDistance),
            _devicePreference(devicePreference)
        { }

Member Function Documentation

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

inline

Definition at line 79 of file ConvolveImage.h.

{ return _devicePreference; };

bool lsst.afw.math::ConvolutionControl::getDoCopyEdge ( ) const

inline

Definition at line 77 of file ConvolveImage.h.

{ return _doCopyEdge; }

bool lsst.afw.math::ConvolutionControl::getDoNormalize ( ) const

inline

Definition at line 76 of file ConvolveImage.h.

{ return _doNormalize; }

int lsst.afw.math::ConvolutionControl::getMaxInterpolationDistance ( ) const

inline

Definition at line 78 of file ConvolveImage.h.

{ return _maxInterpolationDistance; };

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

inline

Definition at line 85 of file ConvolveImage.h.

{ _devicePreference = devicePreference; }

void lsst.afw.math::ConvolutionControl::setDoCopyEdge ( bool  doCopyEdge )

inline

Definition at line 82 of file ConvolveImage.h.

{ _doCopyEdge = doCopyEdge; }

void lsst.afw.math::ConvolutionControl::setDoNormalize ( bool  doNormalize )

inline

Definition at line 81 of file ConvolveImage.h.

{_doNormalize = doNormalize; }

void lsst.afw.math::ConvolutionControl::setMaxInterpolationDistance ( int  maxInterpolationDistance )

inline

Definition at line 83 of file ConvolveImage.h.

                                                                       {
            _maxInterpolationDistance = maxInterpolationDistance; }

Member Data Documentation

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

private

choose CPU or GPU acceleration

Definition at line 93 of file ConvolveImage.h.

bool lsst.afw.math::ConvolutionControl::_doCopyEdge

private

instead of setting them to the standard edge pixel?

copy edge pixels from source image

Definition at line 89 of file ConvolveImage.h.

bool lsst.afw.math::ConvolutionControl::_doNormalize

private

normalize the kernel to sum=1?

Definition at line 88 of file ConvolveImage.h.

int lsst.afw.math::ConvolutionControl::_maxInterpolationDistance

private

over which to attempt interpolation

maximum width or height of a region

Definition at line 91 of file ConvolveImage.h.

---

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

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