PSF_gauss_model Class Reference

Gaussian function model of the point spread function. More...

#include <psf_model.h>

Inheritance diagram for PSF_gauss_model:

Collaboration diagram for PSF_gauss_model:

List of all members.

Public Member Functions
	PSF_gauss_model (float sigma, const PSF_padding *padding, const Imaging_model *imaging) throw (jwscxx::base::Arg_error)
	Constructs a new PSF_gauss_model.
virtual	~PSF_gauss_model ()
	Deletes this PSF_gauss_model.
void	update_h (const Imaging_model *imaging)
	Update this PSF_gauss_model::h.
PSF_gauss_model &	operator= (const PSF_gauss_model &psf)
	Copies a PSF into this PSF.
Protected Attributes
float	sigma
	Shared sigma for the 3D Gaussian.

---

Detailed Description

Gaussian function model of the point spread function.

The point spread function h(x,y,z) is defined as a 3D Gaussian function with a shared sigma.

Definition at line 456 of file psf_model.h.

---

Constructor & Destructor Documentation

PSF_gauss_model::PSF_gauss_model	(	float	sigma,
		const PSF_padding *	padding,
		const Imaging_model *	imaging
	)		throw (jwscxx::base::Arg_error)

Constructs a new PSF_gauss_model.

Parameters:

sigma	Shared sigma for the 3D Gaussian.
padding	PSF_padding to use.
imaging	Imaging_model to use for updating the PSF::h.

Exceptions:

jwscxx::base::Arg_error

Sigma is too small.

Definition at line 1154 of file psf_model.cpp.

virtual PSF_gauss_model::~PSF_gauss_model

(

)

[inline, virtual]

Deletes this PSF_gauss_model.

Definition at line 471 of file psf_model.h.

---

Member Function Documentation

void PSF_gauss_model::update_h

(

const Imaging_model *

imaging

)

[virtual]

Update this PSF_gauss_model::h.

Since h(x,y,z) is symmetric about the x,y-plane and z-axis, the computation is done for only 1/8 of the psf and the other values are copied.

Parameters:

imaging

Imaging_model to use.

Note:

The PSF_model::h is shifted for use in FFT convolution functions. Use unshift_matblock_f() to undo this.

Implements PSF.

Definition at line 1195 of file psf_model.cpp.

PSF_gauss_model & PSF_gauss_model::operator=

(

const PSF_gauss_model &

psf

)

Copies a PSF into this PSF.

Parameters:

psf	PSF_gauss_model to copy.

Returns:

A reference to this PSF_gauss_model with psf copied into it.

Definition at line 1176 of file psf_model.cpp.

---

Member Data Documentation

float PSF_gauss_model::sigma [protected]

Shared sigma for the 3D Gaussian.

Definition at line 485 of file psf_model.h.

---

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

• psf_model.h
• psf_model.cpp