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

#include <alternaria_model.h>

Collaboration diagram for Alternaria_density:

Public Member Functions
	Alternaria_density () throw (jwscxx::base::Arg_error)
	Constructs an Alternaria_density initialized with default values.
virtual	~Alternaria_density ()
	Deletes this Alternaria_density.
float	get_num_levels_p () const
	Returns the number of levels density parameter.
float	get_spore_p () const
	Returns the probability of creating a Spore.
float	get_apical_hypha_p () const
	Returns the probability of creating a Apical_hypha.
float	get_lateral_hypha_1_p () const
	Returns the probability of creating a Lateral_hypha at level 1.
float	get_lateral_hypha_n_p () const
	Returns the probability of creating a Lateral_hypha at level > 1.
const Density::Uniform_params &	get_c_1 () const
	Gets the Alternaria_density::c_1 parameters.
void	set_num_levels_p (float p) throw (jwscxx::base::Arg_error)
	Sets the number of levels density parameters.
void	set_structure_p (float spore_p, float apical_hypha_p, float lateral_hypha_1_p, float lateral_hypha_n_p) throw (jwscxx::base::Arg_error)
	Sets the Structure creation probabilities.
void	set_c_1 (float min, float max) throw (jwscxx::base::Arg_error)
	Sets the Alternaria_density::c_1 parameters.
float	sample_c_1 () const
	Creates a random Alternaria::c_1.
virtual class Alternaria *	sample (size_t N, float centroid_x, float centroid_y, float centroid_z, float theta, float psi, size_t base_level, const Spore_density spore_d, const Apical_hypha_density apical_hypha_d, const Lateral_hypha_density lateral_hypha_1_d, const Lateral_hypha_density lateral_hypha_n_d) const throw (jwscxx::base::Arg_error)
	Creates a random Alternaria.
Protected Member Functions
void	generate_structure (Alternaria *alternaria, size_t N, float centroid_x, float centroid_y, float centroid_z) const throw (jwscxx::base::Arg_error)
	Generates the structure in an Alternaria.
Protected Attributes
float	num_levels_p
	Geometric density parameter for the number of levels in Alternaria.
float	spore_p
	Probability of creating an Spore.
float	apical_hypha_p
	Probability of creating an Apical_hypha.
float	lateral_hypha_1_p
	Probability of creating a Lateral_hypha at level 1.
float	lateral_hypha_n_p
	Probability of creating a Lateral_hypha at level > 1.
Density::Uniform_params	c_1
	Uniform density parameters for the constant C_1.

Detailed Description

Parameters for density functions over an Alternaria.

Definition at line 78 of file alternaria_model.h.

Constructor & Destructor Documentation

Alternaria_density::Alternaria_density ( ) throw (jwscxx::base::Arg_error)

Constructs an Alternaria_density initialized with default values.

Initializes with default values.

Exceptions:

jwscxx::base::Arg_error Invalid default density parameter value.

Definition at line 117 of file alternaria_model.cpp.

virtual Alternaria_density::~Alternaria_density ( ) [inline, virtual]

Deletes this Alternaria_density.

Definition at line 90 of file alternaria_model.h.

Member Function Documentation

float Alternaria_density::get_num_levels_p ( ) const [inline]

Returns the number of levels density parameter.

Definition at line 94 of file alternaria_model.h.

float Alternaria_density::get_spore_p ( ) const [inline]

Returns the probability of creating a Spore.

Definition at line 98 of file alternaria_model.h.

float Alternaria_density::get_apical_hypha_p ( ) const [inline]

Returns the probability of creating a Apical_hypha.

Definition at line 102 of file alternaria_model.h.

float Alternaria_density::get_lateral_hypha_1_p ( ) const [inline]

Returns the probability of creating a Lateral_hypha at level 1.

Definition at line 109 of file alternaria_model.h.

float Alternaria_density::get_lateral_hypha_n_p ( ) const [inline]

Returns the probability of creating a Lateral_hypha at level > 1.

Definition at line 116 of file alternaria_model.h.

const Density::Uniform_params& Alternaria_density::get_c_1 ( ) const [inline]

Gets the Alternaria_density::c_1 parameters.

Definition at line 120 of file alternaria_model.h.

void Alternaria_density::set_num_levels_p ( float p ) throw (jwscxx::base::Arg_error)

Sets the number of levels density parameters.

Parameters:

p	Geometric density parameter.

Exceptions:

jwscxx::base::Arg_error Parameter not valid.

Definition at line 131 of file alternaria_model.cpp.

void Alternaria_density::set_structure_p	(	float	spore_p,
		float	apical_hypha_p,
		float	lateral_hypha_1_p,
		float	lateral_hypha_n_p
	)		throw (jwscxx::base::Arg_error)

Sets the Structure creation probabilities.

Parameters:

spore_p	Probability of creating a Spore.
apical_hypha_p	Probability of creating a Apical_hypha.
lateral_hypha_1_p	Probability of creating a Lateral_hypha at level 1.
lateral_hypha_n_p	Probability of creating a Lateral_hypha at level > 1.

Exceptions:

jwscxx::base::Arg_error Parameters not valid.

Definition at line 152 of file alternaria_model.cpp.

void Alternaria_density::set_c_1	(	float	min,
		float	max
	)		throw (jwscxx::base::Arg_error)

Sets the Alternaria_density::c_1 parameters.

Parameters:

min	Minimum value.
max	Maximum value.

Exceptions:

jwscxx::base::Arg_error Parameters are not a valid range.

Definition at line 180 of file alternaria_model.cpp.

float Alternaria_density::sample_c_1 ( ) const

Creates a random Alternaria::c_1.

Returns:: A randomly sampled Alternaria::c_1 value.

Definition at line 191 of file alternaria_model.cpp.

Alternaria * Alternaria_density::sample	(	size_t	N,
		float	centroid_x,
		float	centroid_y,
		float	centroid_z,
		float	theta,
		float	psi,
		size_t	base_level,
		const Spore_density *	spore_d,
		const Apical_hypha_density *	apical_hypha_d,
		const Lateral_hypha_density *	lateral_hypha_1_d,
		const Lateral_hypha_density *	lateral_hypha_n_d
	)		const throw (jwscxx::base::Arg_error) `[virtual]`

Creates a random Alternaria.

Parameters:

N	Imaging_window to use.
centroid_x	X-coord of the root Structure::centroid.
centroid_y	Y-coord of the root Structure::centroid.
centroid_z	Z-coord of the root Structure::centroid.
theta	Euler angle: base rotation about the x-axis.
psi	Euler angle: base rotation about the z-axis.
base_level	Base level for all Structure.
spore_d	Spore_density parameters.
apical_hypha_d	Apical_hypha_density parameters.
lateral_hypha_1_d	Lateral_hypha_density parameters at level 1.
lateral_hypha_n_d	Lateral_hypha_density parameters at level > 1.

Exceptions:

jwscxx::base::Arg_error Values of sampled Alternaria Structure not in density parameter ranges.

Returns:: A randomly sampled Alternaria.

Definition at line 216 of file alternaria_model.cpp.

void Alternaria_density::generate_structure	(	Alternaria *	alternaria,
		size_t	N,
		float	centroid_x,
		float	centroid_y,
		float	centroid_z
	)		const throw (jwscxx::base::Arg_error) `[protected]`

Generates the structure in an Alternaria.

Parameters:

alternaria	Alternaria to generate the structure in.
N	Imaging_window to use.
centroid_x	X-coord of the root Structure::centroid.
centroid_y	Y-coord of the root Structure::centroid.
centroid_z	Z-coord of the root Structure::centroid.