Imaging_model_density Class Reference

Parameters for density functions over an Imaging_model. More...

#include <imaging_model.h>

Collaboration diagram for Imaging_model_density:

List of all members.

Public Member Functions
	Imaging_model_density () throw (jwscxx::base::Arg_error)
	Creates an Imaging_model_density initialized with default values.
virtual	~Imaging_model_density ()
	Deletes this Imaging_model_density.
Imaging_model_density *	clone () const
	Clones this Imaging_model_density.
const Density::Gaussian_params &	get_bg () const
	Gets the Imaging_model_density::bg parameters.
const Density::Uniform_params &	get_c_2 () const
	Gets the Imaging_model_density::c_2 parameters.
void	set_bg (float mu, float sigma, float min, float max) throw (jwscxx::base::Arg_error)
	Sets the Imaging_model_density::bg parameters.
void	set_c_2 (float min, float max) throw (jwscxx::base::Arg_error)
	Sets the Imaging_model_density::c_2 parameters.
float	sample_bg () const
	Creates a random Imaging_model::bg.
float	sample_c_2 () const
	Creates a random Imaging_model::c_2.
class Imaging_model *	sample (const Imaging_window *window, const Imaging_scale *scale) const
	Creates a random Imaging_model.
Protected Attributes
Density::Gaussian_params	bg
	Gaussian density parameters for background intensity.
Density::Uniform_params	c_2
	Uniform density parameters for the constant C_2.

---

Detailed Description

Parameters for density functions over an Imaging_model.

Definition at line 218 of file imaging_model.h.

---

Constructor & Destructor Documentation

Imaging_model_density::Imaging_model_density

(

)

throw (jwscxx::base::Arg_error)

Creates an Imaging_model_density initialized with default values.

Initializes with default values.

Exceptions:

jwscxx::base::Arg_error

Invalid default density parameter value.

Definition at line 267 of file imaging_model.cpp.

virtual Imaging_model_density::~Imaging_model_density

(

)

[inline, virtual]

Deletes this Imaging_model_density.

Definition at line 230 of file imaging_model.h.

---

Member Function Documentation

Imaging_model_density * Imaging_model_density::clone

(

)

const

Clones this Imaging_model_density.

Returns:

A pointer to a cloned Imaging_model_density.

Definition at line 285 of file imaging_model.cpp.

const Density::Gaussian_params& Imaging_model_density::get_bg

(

)

const [inline]

Gets the Imaging_model_density::bg parameters.

Definition at line 238 of file imaging_model.h.

const Density::Uniform_params& Imaging_model_density::get_c_2

(

)

const [inline]

Gets the Imaging_model_density::c_2 parameters.

Definition at line 242 of file imaging_model.h.

void Imaging_model_density::set_bg	(	float	mu,
		float	sigma,
		float	min,
		float	max
	)		throw (jwscxx::base::Arg_error)

Sets the Imaging_model_density::bg 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 315 of file imaging_model.cpp.

void Imaging_model_density::set_c_2	(	float	min,
		float	max
	)		throw (jwscxx::base::Arg_error)

Sets the Imaging_model_density::c_2 parameters.

Parameters:

min	Minimum value.
max	Maximum value.

Exceptions:

jwscxx::base::Arg_error

Parameters are not a valid range.

Definition at line 336 of file imaging_model.cpp.

float Imaging_model_density::sample_bg

(

)

const

Creates a random Imaging_model::bg.

Returns:

A randomly sampled Imaging_model::bg value.

Definition at line 347 of file imaging_model.cpp.

float Imaging_model_density::sample_c_2

(

)

const

Creates a random Imaging_model::c_2.

Returns:

A randomly sampled Imaging_model::c_2 value.

Definition at line 355 of file imaging_model.cpp.

Imaging_model * Imaging_model_density::sample	(	const Imaging_window *	window,
		const Imaging_scale *	scale
	)		const

Creates a random Imaging_model.

Parameters:

window	Imaging_window to use.
scale	Imaging_scale to use.

Returns:

A randomly sampled Imaging_model.

Definition at line 368 of file imaging_model.cpp.

---

Member Data Documentation

Density::Gaussian_params Imaging_model_density::bg [protected]

Gaussian density parameters for background intensity.

Definition at line 274 of file imaging_model.h.

Density::Uniform_params Imaging_model_density::c_2 [protected]

Uniform density parameters for the constant C_2.

Definition at line 277 of file imaging_model.h.

---

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

• imaging_model.h
• imaging_model.cpp