LSSTApplications  10.0+286,10.0+36,10.0+46,10.0-2-g4f67435,10.1+152,10.1+37,11.0,11.0+1,11.0-1-g47edd16,11.0-1-g60db491,11.0-1-g7418c06,11.0-2-g04d2804,11.0-2-g68503cd,11.0-2-g818369d,11.0-2-gb8b8ce7
LSSTDataManagementBasePackage
Public Member Functions | Private Attributes | List of all members
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
doNormalizenormalize the kernel to sum=1?
doCopyEdgecopy edge pixels from source image instead of setting them to the standard edge pixel?
maxInterpolationDistancemaximum width or height of a region over which to use linear interpolation interpolate
devicePreferenceuse Gpu acceleration?

Definition at line 60 of file ConvolveImage.h.

69  :
70  _doNormalize(doNormalize),
71  _doCopyEdge(doCopyEdge),
72  _maxInterpolationDistance(maxInterpolationDistance),
73  _devicePreference(devicePreference)
74  { }
bool _doNormalize
normalize the kernel to sum=1?
Definition: ConvolveImage.h:88
bool _doCopyEdge
instead of setting them to the standard edge pixel?
Definition: ConvolveImage.h:89
lsst::afw::gpu::DevicePreference _devicePreference
choose CPU or GPU acceleration
Definition: ConvolveImage.h:93
int _maxInterpolationDistance
over which to attempt interpolation
Definition: ConvolveImage.h:91

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::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; }
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; }
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; };
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::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; }
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; }
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; }
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: