STIRA  0.1
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
stira::deconvolve::DeconvolveMaster Class Referenceabstract

parent class for computing deconvolutions More...

#include <DeconvolveMaster.h>

Inheritance diagram for stira::deconvolve::DeconvolveMaster:
stira::deconvolve::IterativeDeconvolve stira::deconvolve::WienerDeconvolve stira::deconvolve::GNCDeconvolve stira::deconvolve::RichardsonLucyDeconvolve stira::deconvolve::TikhonovMillerDeconvolve stira::deconvolve::VanCittertLandweberDeconvolve

Public Member Functions

virtual bool Run ()=0
 Runs the actual restoration algorithm After completion, get the result with GetRestoredImage()
 
Image * GetDegradedImage ()
 Gets the degraded input image.
 
void SetDegradedImage (Image *pDegradedImage)
 sets the degraded image to restore More...
 
Image * GetPSF ()
 gets the Point Spread Function (PSF) The PSF is a model of the blur; it is how every single point is imaged in the degraded image. For an ideal image, it would be a delta function; in reality, it is mostly a certain spot.
 
void SetPSF (Image *pPSF)
 sets the Point Spread Function (PSF) More...
 
Image * GetRestoredImage ()
 gets the result after running the deconvolution
 
void SetSigmaNoise (double sigma)
 sets the noise level More...
 
double GetSigmaNoise ()
 gets the noise level
 
virtual bool IsReadyToRun ()=0
 checks if all conditions are fulfilled for this deconvolution method
 

Protected Member Functions

 DeconvolveMaster (Image *pDegradedImage)
 constructor Sets degraded input image; PSF is estimated or entered in later stage More...
 
 DeconvolveMaster (Image *pDegradedImage, Image *pPSF)
 constructor Sets degraded input image and PSF More...
 
virtual ~DeconvolveMaster ()
 constructor
 
bool AreParentConditionsOK ()
 checks basic conditions are fulfilled for all deconvolution methods
 

Protected Attributes

Image * mpDegradedImage
 degraded input image
 
Image * mpRestoredImage
 restored image for output
 
Image * mpPSF
 image containing the Point Spread Function
 
double mSigmaNoise
 sigma of the noise
 

Detailed Description

parent class for computing deconvolutions

Constructor & Destructor Documentation

stira::deconvolve::DeconvolveMaster::DeconvolveMaster ( Image *  pDegradedImage)
protected

constructor Sets degraded input image; PSF is estimated or entered in later stage

Parameters
pDegradedImagedegraded input image
stira::deconvolve::DeconvolveMaster::DeconvolveMaster ( Image *  pDegradedImage,
Image *  pPSF 
)
protected

constructor Sets degraded input image and PSF

Parameters
pDegradedImagedegraded input image
pPSFPoint Spread Function (models the blur in the image)

Member Function Documentation

void stira::deconvolve::DeconvolveMaster::SetDegradedImage ( Image *  pDegradedImage)

sets the degraded image to restore

Parameters
pDegradedImagethe image to restore
void stira::deconvolve::DeconvolveMaster::SetPSF ( Image *  pPSF)

sets the Point Spread Function (PSF)

Parameters
pPSFThe PSF.
void stira::deconvolve::DeconvolveMaster::SetSigmaNoise ( double  sigma)

sets the noise level

Parameters
sigmathe sigma of the noise

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