PSF_model_density Class Reference

Parameters for density functions over a PSF_model. More...

#include <psf_model.h>

Collaboration diagram for PSF_model_density:

List of all members.

Public Member Functions
	PSF_model_density () throw (jwscxx::base::Arg_error)
	Creates a PSF_model_density initialized with default values.
virtual	~PSF_model_density ()
	Deletes this PSF_model_density.
PSF_model_density *	clone () const
	Clones this PSF_model_density.
const Density::Gaussian_params &	get_alpha () const
	Gets the PSF_model_density::alpha parameters.
const Density::Gaussian_params &	get_beta () const
	Gets the PSF_model_density::beta parameters.
const Density::Gaussian_params &	get_gamma () const
	Gets the PSF_model_density::gamma parameters.
void	set_alpha (float mu, float sigma, float min, float max) throw (jwscxx::base::Arg_error)
	Sets the PSF_model_density::alpha parameters.
void	set_beta (float mu, float sigma, float min, float max) throw (jwscxx::base::Arg_error)
	Sets the PSF_model_density::beta parameters.
void	set_gamma (float mu, float sigma, float min, float max) throw (jwscxx::base::Arg_error)
	Sets the PSF_model_density::gamma parameters.
float	sample_alpha () const
	Creates a random PSF_model::alpha.
float	sample_beta () const
	Creates a random PSF_model::beta.
float	sample_gamma () const
	Creates a random PSF_model::gamma.
class PSF_model *	sample (const PSF_padding *padding, const Imaging_model *imaging) const
	Creates a random PSF_model.
Protected Attributes
Density::Gaussian_params	alpha
	Gaussian density parameters for PSF_model::alpha.
Density::Gaussian_params	beta
	Gaussian density parameters for PSF_model::beta.
Density::Gaussian_params	gamma
	Gaussian density parameters for PSF_model::gamma.

---

Detailed Description

Parameters for density functions over a PSF_model.

Currently, all the model parameters are Gaussian distributed.

Definition at line 162 of file psf_model.h.

---

Constructor & Destructor Documentation

PSF_model_density::PSF_model_density

(

)

throw (jwscxx::base::Arg_error)

Creates a PSF_model_density initialized with default values.

Initializes with default values.

Exceptions:

jwscxx::base::Arg_error

Invalid default density parameter value.

Definition at line 249 of file psf_model.cpp.

virtual PSF_model_density::~PSF_model_density

(

)

[inline, virtual]

Deletes this PSF_model_density.

Definition at line 174 of file psf_model.h.

---

Member Function Documentation

PSF_model_density * PSF_model_density::clone

(

)

const

Clones this PSF_model_density.

Returns:

A pointer to a cloned PSF_model_density.

Definition at line 275 of file psf_model.cpp.

const Density::Gaussian_params& PSF_model_density::get_alpha

(

)

const [inline]

Gets the PSF_model_density::alpha parameters.

Definition at line 182 of file psf_model.h.

const Density::Gaussian_params& PSF_model_density::get_beta

(

)

const [inline]

Gets the PSF_model_density::beta parameters.

Definition at line 186 of file psf_model.h.

const Density::Gaussian_params& PSF_model_density::get_gamma

(

)

const [inline]

Gets the PSF_model_density::gamma parameters.

Definition at line 190 of file psf_model.h.

void PSF_model_density::set_alpha	(	float	mu,
		float	sigma,
		float	min,
		float	max
	)		throw (jwscxx::base::Arg_error)

Sets the PSF_model_density::alpha parameters.

Parameters:

mu	Mean value.
sigma	Standard deviation.
min	Minimum value.
max	Maximum value.

Exceptions:

jwscxx::base::Arg_error

Parameters are not a valid range or sigma is too small.

Definition at line 313 of file psf_model.cpp.

void PSF_model_density::set_beta	(	float	mu,
		float	sigma,
		float	min,
		float	max
	)		throw (jwscxx::base::Arg_error)

Sets the PSF_model_density::beta parameters.

Parameters:

mu	Mean value.
sigma	Standard deviation.
min	Minimum value.
max	Maximum value.

Exceptions:

jwscxx::base::Arg_error

Parameters are not a valid range or sigma is too small.

Definition at line 337 of file psf_model.cpp.

void PSF_model_density::set_gamma	(	float	mu,
		float	sigma,
		float	min,
		float	max
	)		throw (jwscxx::base::Arg_error)

Sets the PSF_model_density::gamma parameters.

Parameters:

mu	Mean value.
sigma	Standard deviation.
min	Minimum value.
max	Maximum value.

Exceptions:

jwscxx::base::Arg_error

Parameters are not a valid range or sigma is too small.

Definition at line 357 of file psf_model.cpp.

float PSF_model_density::sample_alpha

(

)

const

Creates a random PSF_model::alpha.

Returns:

A randomly sampled PSF_model::alpha value.

Definition at line 373 of file psf_model.cpp.

float PSF_model_density::sample_beta

(

)

const

Creates a random PSF_model::beta.

Returns:

A randomly sampled PSF_model::beta value.

Definition at line 381 of file psf_model.cpp.

float PSF_model_density::sample_gamma

(

)

const

Creates a random PSF_model::gamma.

Returns:

A randomly sampled PSF_model::gamma value.

Definition at line 389 of file psf_model.cpp.

PSF_model * PSF_model_density::sample	(	const PSF_padding *	padding,
		const Imaging_model *	imaging
	)		const

Creates a random PSF_model.

Parameters:

padding	PSF_padding to use.
imaging	Imaging_model to use for updating the PSF_model::h.

Returns:

A randomly sampled Imaging_model.

Definition at line 403 of file psf_model.cpp.

---

Member Data Documentation

Density::Gaussian_params PSF_model_density::alpha [protected]

Gaussian density parameters for PSF_model::alpha.

Definition at line 232 of file psf_model.h.

Density::Gaussian_params PSF_model_density::beta [protected]

Gaussian density parameters for PSF_model::beta.

Definition at line 235 of file psf_model.h.

Density::Gaussian_params PSF_model_density::gamma [protected]

Gaussian density parameters for PSF_model::gamma.

Definition at line 238 of file psf_model.h.

---

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

• psf_model.h
• psf_model.cpp