Trace::Distribution class reference
[Core module]

This class is a member of the Trace namespace.

This class describes distribution pattern and ray density used for light ray distribution over surfaces during light propagation.

Ray density is expressed as average number of rays along surface radius.

See also the full member list section for this class.

• Distribution (Pattern pattern = [...], unsigned int radial_density = [...], double scaling = [...])
• Pattern get_pattern () const
• unsigned int get_radial_density () const
• double get_scaling () const
• void set_pattern (Pattern p)
• void set_radial_density (unsigned int count)
• void set_scaling (double scaling)
• void set_uniform_pattern ()

Distribution(Pattern pattern = DefaultDist, unsigned int radial_density = 5, double scaling = 0.999)

Creates a distribution pattern with specified pattern, radial ray density and scaling.

The scaling ratio parameter may be used to avoid distributing rays too close to the surface edge.

Pattern get_pattern() const

Get distribution pattern

unsigned int get_radial_density() const

Get current radial density

double get_scaling() const

get current scaling

void set_pattern(Pattern p)

Set distribution pattern

void set_radial_density(unsigned int count)

Set average number of ray to distribute on surface radius

void set_scaling(double scaling)

Set scaling, Rays are distributed on surface but are kept away from surface edge if scaling is less than 1.0.

void set_uniform_pattern()

Ensure uniform 2d pattern suitable for spot diagram and image analysis is selected. Change to default pattern if not.