LSSTApplications: lsst.afw.math::ConvolutionControl Class Reference

LSSTApplications 1.1.2+25,10.0+13,10.0+132,10.0+133,10.0+224,10.0+41,10.0+8,10.0-1-g0f53050+14,10.0-1-g4b7b172+19,10.0-1-g61a5bae+98,10.0-1-g7408a83+3,10.0-1-gc1e0f5a+19,10.0-1-gdb4482e+14,10.0-11-g3947115+2,10.0-12-g8719d8b+2,10.0-15-ga3f480f+1,10.0-2-g4f67435,10.0-2-gcb4bc6c+26,10.0-28-gf7f57a9+1,10.0-3-g1bbe32c+14,10.0-3-g5b46d21,10.0-4-g027f45f+5,10.0-4-g86f66b5+2,10.0-4-gc4fccf3+24,10.0-40-g4349866+2,10.0-5-g766159b,10.0-5-gca2295e+25,10.0-6-g462a451+1

LSSTDataManagementBasePackage

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.

79 { return _devicePreference; };

lsst.afw.math::ConvolutionControl::_devicePreference

lsst::afw::gpu::DevicePreference _devicePreference

choose CPU or GPU acceleration

Definition: ConvolveImage.h:93

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

inline

Definition at line 77 of file ConvolveImage.h.

77 { return _doCopyEdge; }

lsst.afw.math::ConvolutionControl::_doCopyEdge

bool _doCopyEdge

instead of setting them to the standard edge pixel?

Definition: ConvolveImage.h:89

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

inline

Definition at line 76 of file ConvolveImage.h.

76 { return _doNormalize; }

lsst.afw.math::ConvolutionControl::_doNormalize

bool _doNormalize

normalize the kernel to sum=1?

Definition: ConvolveImage.h:88

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

inline

Definition at line 78 of file ConvolveImage.h.

78 { return _maxInterpolationDistance; };

lsst.afw.math::ConvolutionControl::_maxInterpolationDistance

int _maxInterpolationDistance

over which to attempt interpolation

Definition: ConvolveImage.h:91

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

inline

Definition at line 85 of file ConvolveImage.h.

85 { _devicePreference = devicePreference; }

lsst.afw.math::ConvolutionControl::_devicePreference

lsst::afw::gpu::DevicePreference _devicePreference

choose CPU or GPU acceleration

Definition: ConvolveImage.h:93

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

inline

Definition at line 82 of file ConvolveImage.h.

82 { _doCopyEdge = doCopyEdge; }

lsst.afw.math::ConvolutionControl::_doCopyEdge

bool _doCopyEdge

instead of setting them to the standard edge pixel?

Definition: ConvolveImage.h:89

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

inline

Definition at line 81 of file ConvolveImage.h.

81 {_doNormalize = doNormalize; }

lsst.afw.math::ConvolutionControl::_doNormalize

bool _doNormalize

normalize the kernel to sum=1?

Definition: ConvolveImage.h:88

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

inline

Definition at line 83 of file ConvolveImage.h.

83 {

84 _maxInterpolationDistance = maxInterpolationDistance; }

lsst.afw.math::ConvolutionControl::_maxInterpolationDistance

int _maxInterpolationDistance

over which to attempt interpolation

Definition: ConvolveImage.h:91

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/10.0-40-g4349866+2/include/lsst/afw/math/ConvolveImage.h