4 API documentation

4.1 Modules  

CoreGoptical core classes
DesignParametrizable optical designs classes

4.2 Namespaces list  

AnalysisOptical systems analysis tools
CurveSurface curvature models
DataNumerical data interpolation and plotting
DesignDesign module classes
IoData input/output and graphical rendering
LightPhysical properties of light
MaterialMaterial models for optical components
MathMathematical tools and functions
Shape2d shapes used for surface contours
SysOptical system and components
TraceRay tracer and light propagation

4.3 Classes list  

Analysis::FocusBest focus point analysis
Analysis::RayFanRayFan diagram analysis
Analysis::SpotSpot diagram analysis
Curve::ArrayEnable definition of curve as square and hexagonal array of an other curve
Curve::BaseBase class for surface curvature models
Curve::ComposerEnable definition of curve as composition of other curves
Curve::Composer::AttributesCurve::Composer base curve attributes.
Curve::ConicGeneral purpose conic curve model
Curve::FlatFlat curve
Curve::FoucaultDefine surface curve from Foucault test data.
Curve::GridDefine surface curve from interpolated grid data set.
Curve::ParabolaParabola curve model
Curve::PolynomialEven and odd polynomial curve implementation.
Curve::SphereSpherical curve model
Curve::SplineRotationally symmetric spline curve implementation
Curve::ZernikeDefine surface curve from Zernike polynomials
Curve::ConicBaseBase class for conic family of curves
Curve::CurveRocBase class for curves with a radius of curvature
Curve::RotationalBase class for rotationally symmetric curves.
Data::DiscreteSet1d numerical data set with interpolation
Data::Grid2d numerical data set with interpolation.
Data::PlotData plots container
Data::PlotDataData set plot
Data::SampleSet1d fixed interval numerical data set with interpolation
Data::SetBase class for numerical data sets.
Data::Set1dBase class for 1d y = f(x) numerical data set
Design::Telescope::CassegrainCassegrain telescopes model
Design::Telescope::NewtonNewton telescope optical design
Design::Telescope::TelescopeBase class for telescope optical designs
ErrorBase class used for Goptical exceptions.
Io::ImportOsloOslo files loader
Io::ImportZemaxZemax files loader (experimental)
Io::RendererBase class for rendering drivers
Io::RendererDxfDXF rendering driver base (experimental)
Io::RendererGdGD rendering driver
Io::RendererOpenglOpenGL rendering driver
Io::RendererPlplotPlplot rendering driver
Io::RendererSvgSVG file rendering driver
Io::RendererX11X11 rendering driver
Io::RendererX3dX3d rendering driver (experimental)
Io::ExportFile export class interface
Io::ImportFile import class interface
Io::RendererAxesRendererAxes rendering descriptor
Io::RendererViewportBase class for viewport based rendering drivers
Io::RgbRGB color descriptor
Light::RayDescribe a ray of light
Light::SpectralLineDescribe a spectral line
Material::AbbeAbbe model for optical glass material
Material::AirAir optical material model
Material::BaseOptical material base class.
Material::CatalogHold a glass material catalog
Material::ConradyConrady model for optical glass material
Material::DispersionTableInterpolated refractive index data set model
Material::HerzbergerHerzberger model for optical glass material
Material::MetalMetal optical material model.
Material::MilMil glass code material model
Material::MirrorSimple mirror optical material model.
Material::SchottSchott model for optical glass material
Material::SellmeierSellmeier model for optical glass material
Material::SellmeierModModified sellmeier model for optical glass material
Material::VacuumVacuum optical material model
Material::DielectricDielectric optical material model base class.
Material::ProxyOptical material proxy class.
Material::SolidSolid optical material base class.
Math::MatrixNxN square matrix class.
Math::QuaternionQuaternion class.
Math::Transform<3>3d linear and affine transformation class.
Math::Transform<2>2d linear and affine transformation class.
Math::TriangleN dimension triangle class
Math::Triangle<3>3d triangle class
Math::VectorN dimension vector class
Math::Vector<3, T>3d vector class
Math::Vector<2, T>2d vector class
Math::VectorPairVector pair class
Math::VectorPair<2>Vector pair class
Math::VectorPair<3>Vector pair class
Shape::BaseBase class for contour 2d shapes
Shape::ComposerEnable definition of shape as composition ot other shapes (experimental)
Shape::Composer::AttributesEnable definition of shape as composition ot other shapes (experimental)
Shape::DiskDisk shape
Shape::EllipseEllipse shape
Shape::EllipticalRingElliptical ring shape
Shape::InfiniteBorderless shape
Shape::PolygonPolygon shape
Shape::RectangleRectangle and square shape
Shape::RegularPolygonRegular Polygon shape
Shape::RingRing shape
Sys::GroupOptical elements group element
Sys::ImageImage plane optical element
Sys::LensLens optical element
Sys::MirrorReflecting optical surface element
Sys::OpticalSurfaceOptical surface element
Sys::SourcePointPoint light source
Sys::SourceRaysCustom rays light source
Sys::SystemOptical system
Sys::ContainerBase class for System and Group
Sys::ElementOptical element base class
Sys::SourceBase class for light sources
Sys::StopAperture stop element
Sys::SurfaceBase class for surfaces
Trace::DistributionRay distribution pattern descriptor
Trace::ParamsLight propagation parameters descriptor
Trace::ResultStore light propagation result
Trace::SequenceDefines light propagation elemets order for sequential light propagation
Trace::TracerLight propagation algorithms
Trace::RayPropagated light ray class

Valid XHTML 1.0 StrictGenerated by diaxen on Sun Jan 8 00:47:25 2012 using MkDoc