Lateral_hypha_density Class Reference
Parameters for density functions over an Alternaria Lateral_hypha. More...
#include <hypha.h>
Inheritance diagram for Lateral_hypha_density:
Collaboration diagram for Lateral_hypha_density:
Public Member Functions | |
| Lateral_hypha_density () throw (jwscxx::base::Arg_error) | |
| Creates a Lateral_hypha_density initialized with default values. | |
| Lateral_hypha_density * | clone () const |
| Clones this Lateral_hypha_density. | |
| Lateral_hypha * | sample (float base_theta=0, float base_psi=0, size_t level=0) const |
| Creates a random Lateral_hypha with no parent. | |
| Lateral_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 Lateral_hypha with no parent. | |
| Lateral_hypha * | sample (Structure *parent, float base_theta=0, float base_psi=0) const throw (jwscxx::base::Arg_error) |
| Creates a random Lateral_hypha with a parent. | |
Detailed Description
Parameters for density functions over an Alternaria Lateral_hypha.
Constructor & Destructor Documentation
| Lateral_hypha_density::Lateral_hypha_density | ( | ) | throw (jwscxx::base::Arg_error) |
Creates a Lateral_hypha_density initialized with default values.
Initializes with default values.
- Exceptions:
-
jwscxx::base::Arg_error Lateral_hypha values are not in the density parameter ranges.
Member Function Documentation
| Lateral_hypha_density * Lateral_hypha_density::clone | ( | ) | const [virtual] |
Clones this Lateral_hypha_density.
- Returns:
- A pointer to a cloned Lateral_hypha_density.
Implements Lateral_structure_density.
| Lateral_hypha * Lateral_hypha_density::sample | ( | float | base_theta = 0, |
| float | base_psi = 0, |
||
| size_t | level = 0 |
||
| ) | const [virtual] |
Creates a random Lateral_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 Lateral_hypha with no parent.
Implements Lateral_structure_density.
| Lateral_hypha * Lateral_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 Lateral_hypha with no parent.
- Parameters:
-
centroid_x X-coord of the Lateral_hypha::centroid. centroid_y Y-coord of the Lateral_hypha::centroid. centroid_z Z-coord of the Lateral_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 Lateral_hypha with no parent.
Implements Lateral_structure_density.
| Lateral_hypha * Lateral_hypha_density::sample | ( | Structure * | parent, |
| float | base_theta = 0, |
||
| float | base_psi = 0 |
||
| ) | const throw (jwscxx::base::Arg_error) [virtual] |
Creates a random Lateral_hypha with a parent.
- Parameters:
-
parent Parent of the Lateral_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 Lateral_hypha with a parent.
Implements Lateral_structure_density.
The documentation for this class was generated from the following files:
