eLynx SDK v3.0.1
C++ image processing API reference

eLynx::Image::KernelPSF Class Reference

#include <KernelPSF.h>

Inheritance diagram for eLynx::Image::KernelPSF:

eLynx::Image::IImagePSF

List of all members.


Public Member Functions

 KernelPSF (const Math::ConvolutionKerneld &iKernel)
 KernelPSF (const Math::ConvolutionKerneld &iKernel1, const Math::ConvolutionKerneld &iKernel2)
 Constructor, creates PSF from separable kernel.
 KernelPSF (const KernelPSF &iC)
KernelPSFoperator= (const KernelPSF &iC)
bool IsSeparable () const
const Math::ConvolutionKerneldGetKernel () const
Math::ConvolutionKerneldGetKernel ()
const Math::ConvolutionKerneldGetKernel2 () const
Math::ConvolutionKerneldGetKernel2 ()
void SetKernel (const Math::ConvolutionKerneld &iKernel)
void SetKernel2 (const Math::ConvolutionKerneld &iKernel)
IImagePSF implementation
virtual uint32 GetWidth () const
virtual uint32 GetHeight () const
virtual double EvalPSF (uint32 iX, uint32 iY, int32 iDX, int32 iDY) const

Detailed Description

PSF (point spread function) implementation based on convolution kernel. The PSF does not change over the image. The kernel is supposed to be normalized. The kernel sizes must be odd numbers (so kernel has clear central pixel).

Definition at line 35 of file KernelPSF.h.


Constructor & Destructor Documentation

eLynx::Image::KernelPSF::KernelPSF ( const Math::ConvolutionKerneld iKernel  ) 

Constructor, creates PSF from given kernel.

Parameters:
iKernel the kernel to describe PSF

eLynx::Image::KernelPSF::KernelPSF ( const Math::ConvolutionKerneld iKernel1,
const Math::ConvolutionKerneld iKernel2 
)

Constructor, creates PSF from separable kernel.

eLynx::Image::KernelPSF::KernelPSF ( const KernelPSF iC  ) 

Copy constructor.

Parameters:
iC the object to copy


Member Function Documentation

KernelPSF& eLynx::Image::KernelPSF::operator= ( const KernelPSF iC  ) 

An assignement operator.

Parameters:
iC the object to assign
Returns:
reference to this object

bool eLynx::Image::KernelPSF::IsSeparable (  )  const

Returns true if PSF is implemented using separable kernel.

Returns:
true for separable kernel, false otherwise

const Math::ConvolutionKerneld& eLynx::Image::KernelPSF::GetKernel (  )  const

Returns convolution kernel, that defines PSF.

Returns:
the convolution kernel

Math::ConvolutionKerneld& eLynx::Image::KernelPSF::GetKernel (  ) 

const Math::ConvolutionKerneld& eLynx::Image::KernelPSF::GetKernel2 (  )  const

Returns second convolution kernel, that defines PSF. Valid if convolution is done using separable kernel.

Returns:
the second convolution kernel

Math::ConvolutionKerneld& eLynx::Image::KernelPSF::GetKernel2 (  ) 

void eLynx::Image::KernelPSF::SetKernel ( const Math::ConvolutionKerneld iKernel  ) 

Sets convolution kernel.

Parameters:
iKernel the kernel to describe PSF

void eLynx::Image::KernelPSF::SetKernel2 ( const Math::ConvolutionKerneld iKernel  ) 

Sets second convolution kernel. Used if convolution is done using separable kernel.

Parameters:
iKernel the second kernel to describe PSF

virtual uint32 eLynx::Image::KernelPSF::GetWidth (  )  const [virtual]

Returns width of the PSF function in pixels. The PSF can be viewed as luminance image with width and height. The original point source is in the center of the image. PSF pixel values shows the convolved image of te source. Both width and height should be odd numbers.

Returns:
the width of the PSF function

Implements eLynx::Image::IImagePSF.

virtual uint32 eLynx::Image::KernelPSF::GetHeight (  )  const [virtual]

Returns height of the PSF function in pixels. The PSF can be viewed as luminance image with width and height. The original point source is in the center of the image. PSF pixel values shows the convolved image of te source. Both width and height should be odd numbers.

Returns:
the width of the PSF function

Implements eLynx::Image::IImagePSF.

virtual double eLynx::Image::KernelPSF::EvalPSF ( uint32  iX,
uint32  iY,
int32  iDX,
int32  iDY 
) const [virtual]

Returns the PSF value (floating point value between 0 and 1). The PSF is related to pixel iX and iY of the image. Delta values iDX and iDY represents center-relative coordinates in the PSF image. If the PSF is constant over whole image, iX and iY parameters are ignored.

Parameters:
iX the x coordinate of the image pixel, for which PSF should be evaluated
iY the y coordinate of the image pixel, for which PSF should be evaluated
iDX the delta from PSF center in x direction (PSF coordinates)
iDY the delta from PSF center in y direction (PSF coordinates)
Returns:
the PSF value for given pixel and delta (floating point value between 0 and 1)

Implements eLynx::Image::IImagePSF.


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

Generated on 14 Apr 2009 by doxygen 1.5.8