Apical_hypha_density Class Reference

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

#include <hypha.h>

Inheritance diagram for Apical_hypha_density:

Collaboration diagram for Apical_hypha_density:

List of all members.

Public Member Functions
	Apical_hypha_density () throw (jwscxx::base::Arg_error)
	Creates an Apical_hypha_density initialized with default values.
Apical_hypha_density *	clone () const
	Clones this Apical_hypha_density.
const Density::Gaussian_params &	get_dwidth () const
	Gets the Structure_density::dwidth density parameters.
void	set_dwidth (float sigma, float min, float max) throw (jwscxx::base::Arg_error)
	Sets the difference in width between an Apical_hypha and its Apical_hypha or Lateral_hypha parent.
Apical_hypha *	sample (float base_theta=0, float base_psi=0, size_t level=0) const
	Creates a random Apical_hypha with no parent.
Apical_hypha *	sample (float centroid_x, float centroid_y, float centroid_z, float base_theta=0, float base_psi=0, size_t level=0) const throw (jwscxx::base::Arg_error)
	Creates a random Apical_hypha with no parent.
Apical_hypha *	sample (Structure *parent, float base_theta=0, float base_psi=0) const throw (jwscxx::base::Arg_error)
	Creates a random Apical_hypha with a parent.
float	sample_dwidth () const
	Creates a random difference in width between an Apical_hypha and its Apical_hypha or Lateral_hypha parent.
Protected Attributes
Density::Gaussian_params	dwidth
	Difference in width of an Apical_hypha and its Apical_hypha or Lateral_hypha parent.

---

Detailed Description

Parameters for density functions over an Alternaria Apical_hypha.

Definition at line 273 of file hypha.h.

---

Constructor & Destructor Documentation

Apical_hypha_density::Apical_hypha_density

(

)

throw (jwscxx::base::Arg_error)

Creates an Apical_hypha_density initialized with default values.

Initializes with default values.

Exceptions:

jwscxx::base::Arg_error

Apical_hypha values are not in the density parameter ranges.

Definition at line 161 of file hypha.cpp.

---

Member Function Documentation

Apical_hypha_density * Apical_hypha_density::clone

(

)

const [virtual]

Clones this Apical_hypha_density.

Returns:

A pointer to a cloned Apical_hypha_density.

Implements Structure_density.

Definition at line 214 of file hypha.cpp.

const Density::Gaussian_params& Apical_hypha_density::get_dwidth

(

)

const [inline]

Gets the Structure_density::dwidth density parameters.

Definition at line 289 of file hypha.h.

void Apical_hypha_density::set_dwidth	(	float	sigma,
		float	min,
		float	max
	)		throw (jwscxx::base::Arg_error)

Sets the difference in width between an Apical_hypha and its Apical_hypha or Lateral_hypha parent.

The mean value is set to 0.

Parameters:

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 281 of file hypha.cpp.

Apical_hypha * Apical_hypha_density::sample	(	float	base_theta = 0,
		float	base_psi = 0,
		size_t	level = 0
	)		const [virtual]

Creates a random Apical_hypha with no parent.

Parameters:

base_theta	Euler angle: base rotation about the x-axis.
base_psi	Euler angle: base rotation about the z-axis.
level	Level of the hypha.

Returns:

A randomly sampled Apical_hypha with no parent.

Implements Apical_structure_density.

Definition at line 300 of file hypha.cpp.

Apical_hypha * Apical_hypha_density::sample	(	float	centroid_x,
		float	centroid_y,
		float	centroid_z,
		float	base_theta = 0,
		float	base_psi = 0,
		size_t	level = 0
	)		const throw (jwscxx::base::Arg_error) [virtual]

Creates a random Apical_hypha with no parent.

Parameters:

centroid_x	X-coord of the Apical_hypha::centroid.
centroid_y	Y-coord of the Apical_hypha::centroid.
centroid_z	Z-coord of the Apical_hypha::centroid.
base_theta	Euler angle: base rotation about the x-axis.
base_psi	Euler angle: base rotation about the z-axis.
level	Level of the hypha.

Exceptions:

jwscxx::base::Arg_error

Apical_hypha values are not in the density parameter ranges.

Returns:

A randomly sampled Apical_hypha with no parent.

Implements Apical_structure_density.

Definition at line 328 of file hypha.cpp.

Apical_hypha * Apical_hypha_density::sample	(	Structure *	parent,
		float	base_theta = 0,
		float	base_psi = 0
	)		const throw (jwscxx::base::Arg_error) [virtual]

Creates a random Apical_hypha with a parent.

Parameters:

parent	Parent of the Apical_hypha to create.
base_theta	Euler angle: base rotation about the x-axis.
base_psi	Euler angle: base rotation about the z-axis.

Exceptions:

jwscxx::base::Arg_error

Apical_hypha values are not in the density parameter ranges.

Returns:

A randomly sampled Apical_hypha with a parent.

Implements Apical_structure_density.

Definition at line 355 of file hypha.cpp.

float Apical_hypha_density::sample_dwidth

(

)

const

Creates a random difference in width between an Apical_hypha and its Apical_hypha or Lateral_hypha parent.

Returns:

A randomly sampled Structure::dwidth.

Definition at line 376 of file hypha.cpp.

---

Member Data Documentation

Density::Gaussian_params Apical_hypha_density::dwidth [protected]

Difference in width of an Apical_hypha and its Apical_hypha or Lateral_hypha parent.

Definition at line 351 of file hypha.h.

---

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

• hypha.h
• hypha.cpp