rayoptics.raytr package
Package for optical ray tracing and calculations
The raytr
subpackage provides core classes and functions
for optical ray tracing and analyses. These include:
Base level ray tracing,
raytrace
Calculation of wavefront aberration,
waveabr
Specification of aperture, field, wavelength and defocus,
opticalspec
Higher level ray tracing, in terms of aperture, field and wavelength,
trace
Functions setting vignetting and clear apertures and support for pupil exploration,
vigcalc
Tracing of fans, lists and grids of rays, including refocusing of OPD values,
analyses
Exception classes for reporting ray trace errors,
traceerror
Sample generation for ray grids,
sampler
The overall optical model is managed by the OpticalModel
class
- class RayPkg(ray, op, wvl)
Bases:
tuple
Ray and optical path length, plus wavelength
- op
optical path length between pupils
- ray
list of RaySegs
- wvl
wavelength (in nm) that the ray was traced in
- class RaySeg(p, d, dst, nrml)
Bases:
tuple
ray intersection and transfer data
- d
ray direction cosine following the interface
- dst
geometric distance to next point of incidence
- nrml
surface normal vector at the point of incidence
- p
the point of incidence
Submodules
- rayoptics.raytr.analyses module
Ray
RayFan
select_plot_data()
smooth_plot_data()
trace_ray_fan()
eval_fan()
trace_fan()
focus_fan()
RayList
trace_ray_list()
trace_list_of_rays()
eval_pupil_coords()
trace_pupil_coords()
focus_pupil_coords()
RayGrid
trace_ray_grid()
eval_wavefront()
trace_wavefront()
focus_wavefront()
psf_sampling()
calc_psf_scaling()
calc_psf()
update_psf_data()
- rayoptics.raytr.opticalspec module
OpticalSpecs
OpticalSpecs.do_aiming
OpticalSpecs.do_aiming_default
OpticalSpecs.listobj_str()
OpticalSpecs.spectral_region
OpticalSpecs.pupil
OpticalSpecs.field_of_view
OpticalSpecs.defocus
OpticalSpecs.set_from_list()
OpticalSpecs.set_from_specsheet()
OpticalSpecs.sync_to_restore()
OpticalSpecs.update_model()
OpticalSpecs.update_optical_properties()
OpticalSpecs.lookup_fld_wvl_focus()
OpticalSpecs.obj_coords()
OpticalSpecs.list_first_order_data()
OpticalSpecs.list_parax_trace()
WvlSpec
PupilSpec
PupilSpec.key
PupilSpec.value
PupilSpec.pupil_rays
PupilSpec.ray_labels
PupilSpec.default_pupil_rays
PupilSpec.default_ray_labels
PupilSpec.listobj_str()
PupilSpec.sync_to_restore()
PupilSpec.set_from_specsheet()
PupilSpec.get_input_for_specsheet()
PupilSpec.update_model()
PupilSpec.mutate_pupil_type()
FieldSpec
FieldSpec.key
FieldSpec.value
FieldSpec.fields
FieldSpec.is_relative
FieldSpec.listobj_str()
FieldSpec.sync_to_restore()
FieldSpec.set_from_list()
FieldSpec.set_from_specsheet()
FieldSpec.get_input_for_specsheet()
FieldSpec.update_model()
FieldSpec.mutate_field_type()
FieldSpec.obj_coords()
FieldSpec.max_field()
Field
FocusRange
- rayoptics.raytr.raytrace module
- rayoptics.raytr.sampler module
- rayoptics.raytr.trace module
ray_pkg()
ray_df()
list_ray()
trace_safe()
retrieve_ray()
trace()
trace_base()
iterate_ray()
trace_with_opd()
trace_boundary_rays_at_field()
boundary_ray_dict()
trace_boundary_rays()
trace_ray_list_at_field()
trace_field()
trace_all_fields()
trace_chief_ray()
trace_fan()
trace_grid()
setup_pupil_coords()
aim_chief_ray()
apply_paraxial_vignetting()
get_chief_ray_pkg()
refocus()
trace_astigmatism_coddington_fan()
trace_coddington_fan()
intersect_2_lines()
trace_astigmatism_curve()
trace_astigmatism()
- rayoptics.raytr.traceerror module
- rayoptics.raytr.vigcalc module
- rayoptics.raytr.waveabr module