Lateral_structure_density Class Reference

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

#include <structure.h>

Inheritance diagram for Lateral_structure_density:

Collaboration diagram for Lateral_structure_density:

List of all members.

Public Member Functions
virtual	~Lateral_structure_density ()
	Destructor.
virtual Lateral_structure_density *	clone () const =0
	Clones this Lateral_structure_density.
const Density::Gaussian_params &	get_lat_dist () const
	Gets the Lateral_structure_density::lat_dist density parameters.
void	set_lat_dist (float mu, float sigma, float min, float max) throw (jwscxx::base::Arg_error)
	Sets the Lateral_structure_density::lat_dist density parameters.
float	sample_lat_dist () const
	Creates a random Lateral_structure::lat_dist.
virtual Lateral_structure *	sample (float base_theta, float base_psi, size_t level) const =0
	Creates a random Lateral_structure with no parent.
virtual Lateral_structure *	sample (float centroid_x, float centroid_y, float centroid_z, float base_theta, float base_psi, size_t level) const =0 throw (jwscxx::base::Arg_error)
	Creates a random Lateral_structure with no parent.
virtual Lateral_structure *	sample (class Structure *parent, float base_theta, float base_psi) const =0 throw (jwscxx::base::Arg_error)
	Creates a random Lateral_structure with a parent.
Protected Attributes
Density::Gaussian_params	lat_dist
	Normalized distance to the lateral from its parent's Structure::begin_pt.

---

Detailed Description

Parameters for density functions over an Alternaria Lateral_structure element.

Abstract class providing some basic functionality for all Alternaria lateral structure elements.

Definition at line 1398 of file structure.h.

---

Constructor & Destructor Documentation

virtual Lateral_structure_density::~Lateral_structure_density

(

)

[inline, virtual]

Destructor.

Definition at line 1403 of file structure.h.

---

Member Function Documentation

virtual Lateral_structure_density* Lateral_structure_density::clone

(

)

const [pure virtual]

Clones this Lateral_structure_density.

Implements Structure_density.

Implemented in Lateral_hypha_density.

const Density::Gaussian_params& Lateral_structure_density::get_lat_dist

(

)

const [inline]

Gets the Lateral_structure_density::lat_dist density parameters.

Definition at line 1414 of file structure.h.

void Lateral_structure_density::set_lat_dist	(	float	mu,
		float	sigma,
		float	min,
		float	max
	)		throw (jwscxx::base::Arg_error)

Sets the Lateral_structure_density::lat_dist density 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 348 of file structure.cpp.

float Lateral_structure_density::sample_lat_dist

(

)

const

Creates a random Lateral_structure::lat_dist.

Returns:

A randomly sampled Lateral_structure::lat_dist.

Definition at line 365 of file structure.cpp.

virtual Lateral_structure* Lateral_structure_density::sample	(	float	base_theta,
		float	base_psi,
		size_t	level
	)		const [pure virtual]

Creates a random Lateral_structure with no parent.

Implements Structure_density.

Implemented in Lateral_hypha_density.

virtual Lateral_structure* Lateral_structure_density::sample	(	float	centroid_x,
		float	centroid_y,
		float	centroid_z,
		float	base_theta,
		float	base_psi,
		size_t	level
	)		const throw (jwscxx::base::Arg_error) [pure virtual]

Creates a random Lateral_structure with no parent.

Implements Structure_density.

Implemented in Lateral_hypha_density.

virtual Lateral_structure* Lateral_structure_density::sample	(	class Structure *	parent,
		float	base_theta,
		float	base_psi
	)		const throw (jwscxx::base::Arg_error) [pure virtual]

Creates a random Lateral_structure with a parent.

Implements Structure_density.

Implemented in Lateral_hypha_density.

---

Member Data Documentation

Density::Gaussian_params Lateral_structure_density::lat_dist [protected]

Normalized distance to the lateral from its parent's Structure::begin_pt.

Definition at line 1475 of file structure.h.

---

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

• structure.h
• structure.cpp