Sys::SourceRays class reference
[Core module]

Declaration

#include <Goptical/Sys/SourceRays>

namespace Goptical {
  namespace Sys {
    class SourceRays;
  };
};

This class is a member of the Sys namespace.

Inheritance

Description

This class implement a light source which generates user defined rays.

Default wavelen list contains a single 550nm entry.

Members

See also the full member list section for this class.

Inherited members

48 members inherited from Source

Functions

SourceRays(const Math::Vector3 &object = [...])
void add_chief_rays(const System &sys)
void add_chief_rays(const Surface &s)
void add_marginal_rays(const System &sys, double entrance_height = [...])
void add_marginal_rays(const Surface &s, double entrance_height = [...])
void add_ray(const Light::Ray &ray, const Element *ref = [...])
void add_rays(const Math::VectorPair3 &ray, const Element *ref = [...])
void clear_rays()

Members detail

SourceRays(const Math::Vector3 &object = Math::vector3_0)

Create a rays source. Source object position is used by some of the add_* functions and may be specified.

void add_chief_rays(const System &sys)

Add chief rays to system entrance pupil for all defined wavelengths.

void add_chief_rays(const Surface &s)

Add chief rays to specified surface for all defined wavelengths.

void add_marginal_rays(const System &sys, double entrance_height = 0.)

Add marginal rays to system entrance pupil for all defined wavelengths.

void add_marginal_rays(const Surface &s, double entrance_height = 0.)

Add marginal rays to specified surface for all defined wavelengths.

Source direction (rotation) is used to determine tangential plane.

Entrance height is set to surface aperture radius when 0.

void add_ray(const Light::Ray &ray, const Element *ref = 0)

Add a single light ray; rays properties are copied from specified light ray.

Ray origin and direction are expressed in specified ref element coordinates or global coordinates if none is specified.

void add_rays(const Math::VectorPair3 &ray, const Element *ref = 0)

Creates light rays from position and direction for all defined wavelengths.