Spore_density Class Reference
Parameters for density functions over an Alternaria Spore. More...
#include <spore.h>
Inheritance diagram for Spore_density:
Collaboration diagram for Spore_density:
Public Member Functions | |
| Spore_density (const class DD_spore_set *dd_spores=0) throw (jwscxx::base::Arg_error) | |
| Creates a Spore_density initialized with default values. | |
| Spore_density * | clone () const |
| Clones a Spore_density. | |
| Spore * | sample (float base_theta=0, float base_psi=0, size_t level=0) const |
| Creates a random Spore with no parent. | |
| Spore * | 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 Spore with no parent. | |
| Spore * | sample (Structure *parent, float base_theta=0, float base_psi=0) const throw (jwscxx::base::Arg_error) |
| Creates a random Spore with a parent. | |
| const DD_spore_set * | get_dd_spores () const |
| Retruns the DD_spore_set. | |
Protected Attributes | |
| const DD_spore_set * | dd_spores |
| Data-driven set of spores. | |
Detailed Description
Parameters for density functions over an Alternaria Spore.
Constructor & Destructor Documentation
| Spore_density::Spore_density | ( | const class DD_spore_set * | dd_spores = 0 | ) | throw (jwscxx::base::Arg_error) |
Creates a Spore_density initialized with default values.
Initializes with default values.
- Parameters:
-
dd_spores DD_spore_set to use. Can be 0, in which case there are none.
- Exceptions:
-
jwscxx::base::Arg_error Spore values are not in the density parameter ranges.
Member Function Documentation
| Spore_density * Spore_density::clone | ( | ) | const [virtual] |
| Spore * Spore_density::sample | ( | float | base_theta = 0, |
| float | base_psi = 0, |
||
| size_t | level = 0 |
||
| ) | const [virtual] |
Creates a random Spore 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 Spore.
- Returns:
- A randomly sampled Spore with no parent.
Implements Apical_structure_density.
| Spore * Spore_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 Spore with no parent.
- Parameters:
-
centroid_x X-coord of the Spore::centroid. centroid_y Y-coord of the Spore::centroid. centroid_z Z-coord of the Spore::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 Spore.
- Exceptions:
-
jwscxx::base::Arg_error Spore values are not in the density parameter ranges.
- Returns:
- A randomly sampled Spore with no parent.
Implements Apical_structure_density.
| Spore * Spore_density::sample | ( | Structure * | parent, |
| float | base_theta = 0, |
||
| float | base_psi = 0 |
||
| ) | const throw (jwscxx::base::Arg_error) [virtual] |
Creates a random Spore with a parent.
- Parameters:
-
parent Parent of the Spore 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 Spore values are not in the density parameter ranges.
- Returns:
- A randomly sampled Spore with a parent.
Implements Apical_structure_density.
| const DD_spore_set* Spore_density::get_dd_spores | ( | ) | const [inline] |
Member Data Documentation
const DD_spore_set* Spore_density::dd_spores [protected] |
The documentation for this class was generated from the following files:
