Components

• Config
  • set_show_iteration_count()
  • get_show_iteration_count()
  • set_tolerance()
  • get_tolerance()
  • set_max_iterations()
  • get_max_iterations()
  • set_damping_factor()
  • get_damping_factor()
  • restore_default_settings()
• Constraints
  • Constraint
    • Constraint.fun
    • Constraint.type
  • EqualZero
  • GEQZero
  • LEQZero
• Element
  • is_valid_square_circle()
  • OpticalSystem
    • OpticalSystem.modules_dict
    • OpticalSystem.forward()
    • OpticalSystem.get_plotable_childs()
    • OpticalSystem.get_plot_points_2D()
    • OpticalSystem.get_plot_points_3D()
  • SequentialOpticalSystem
    • SequentialOpticalSystem.n_func_enviroment
    • SequentialOpticalSystem.forward()
  • OpticalElement
    • OpticalElement.forward()
    • OpticalElement.get_transform()
  • OpticalSurface
    • OpticalSurface.surface
    • OpticalSurface.aperture_radius
    • OpticalSurface.is_square
    • OpticalSurface.transform
    • OpticalSurface.integrator
    • OpticalSurface.get_constraint_funs_leq_zero()
    • OpticalSurface.get_plot_points_2D()
    • OpticalSurface.get_plot_points_3D()
    • OpticalSurface.get_CAD_points()
    • OpticalSurface.get_CAD_face()
    • OpticalSurface.parametric_sample()
    • OpticalSurface.parametric_surface()
    • OpticalSurface.get_surface_and_normal_func_with_params()
    • OpticalSurface.get_ray_intersect_length()
    • OpticalSurface.get_new_is_valid()
    • OpticalSurface.get_transform()
  • LensSurfaceTransmissionEnter
    • LensSurfaceTransmissionEnter.forward()
  • LensSurfaceTransmissionLeave
    • LensSurfaceTransmissionLeave.forward()
  • LensSurfaceSide
    • LensSurfaceSide.surface1
    • LensSurfaceSide.surface2
    • LensSurfaceSide.aperture_radius
    • LensSurfaceSide.is_square
    • LensSurfaceSide.parametric_sample()
    • LensSurfaceSide.parametric_surface()
    • LensSurfaceSide.get_plot_points_2D()
    • LensSurfaceSide.get_plot_points_3D()
    • LensSurfaceSide.get_plotly_color_scale()
  • Lens
    • Lens.n_func
    • Lens._transform1
    • Lens._transform2
    • Lens.lens_thickness
    • Lens.surface1
    • Lens.surface2
    • Lens.lens_surface_side
    • Lens.aperture_radius
    • Lens.is_square
    • Lens.get_plot_points_2D()
    • Lens.get_plot_points_3D()
    • Lens.get_plotly_color_scale()
    • Lens.get_plotable_childs()
    • Lens.forward()
    • Lens.get_transform()
  • Mirror
    • Mirror.forward()
  • Detector
    • Detector.forward()
  • trace_to_detector()
  • set_unused_params_to_zero()
  • get_unused_params_mask()
  • set_used_params_bounds_to_constant()
  • FresnelOpticalSurface
    • FresnelOpticalSurface.get_virtual_normals()
  • FresnelVirtualLensSurfaceTransmissionEnter
    • FresnelVirtualLensSurfaceTransmissionEnter.forward()
  • FresnelVirtualLensSurfaceTransmissionLeave
    • FresnelVirtualLensSurfaceTransmissionLeave.forward()
  • FresnelVirtualLens
    • FresnelVirtualLens.get_plot_points_2D()
    • FresnelVirtualLens.get_plot_points_3D()
    • FresnelVirtualLens.get_plotly_color_scale()
    • FresnelVirtualLens.get_plotable_childs()
    • FresnelVirtualLens.forward()
    • FresnelVirtualLens.get_transform()
  • compute_reflected_directions()
  • get_refracted_directions()
  • set_unused_bspline_coeff_to_nearest()
• Integrators
  • Integrator
    • Integrator.sample()
    • Integrator.in_bounds()
    • Integrator.get_volume()
  • Cube
    • Cube.sample()
    • Cube.in_bounds()
    • Cube.get_volume()
  • Disc
    • Disc.sample()
    • Disc.in_bounds()
    • Disc.get_volume()
  • IntegrationMethod
    • IntegrationMethod.SIMPSON
    • IntegrationMethod.MIDPOINT
    • IntegrationMethod.MONTE_CARLO
    • IntegrationMethod.SOBOL
    • IntegrationMethod.SOBOL_POW2
• Intersection
  • SemiFunctionalModule
    • SemiFunctionalModule.functional()
    • SemiFunctionalModule.get_functional_param_args()
  • cat_semi_functionals()
  • get_functional_param_args()
  • construct_surface_and_normal_func()
  • construct_surface_and_normal_func_with_params()
  • CustomAutogradRule_t
    • CustomAutogradRule_t.forward()
    • CustomAutogradRule_t.backward()
  • get_ray_intersection_length()
• Optimize
  • Optimization Utilities for PyTorch-SciPy Integration
    • Key Features:
    • Optimization Constraints in Optical Systems
    • Types of Constraints
  • make_bounds_from_param()
  • make_parameter_from_input()
  • pack_tensors()
  • unpack_tensors()
  • apply_vec_to_params()
  • set_full_if_nan()
  • ParameterFunHelper
    • ParameterFunHelper.original_fun
    • ParameterFunHelper.params
    • ParameterFunHelper.nan_fallback
    • ParameterFunHelper.last_x_fun_numpy
    • ParameterFunHelper.last_fun_val_numpy
    • ParameterFunHelper.last_fun_val_torch
    • ParameterFunHelper.last_x_grad_numpy
    • ParameterFunHelper.last_grad_val_numpy
    • ParameterFunHelper.fun()
    • ParameterFunHelper.jac()
    • ParameterFunHelper.fun_jac()
  • create_fun_and_gradient()
  • remove_bounds()
  • get_bounds()
  • get_scipy_constraint()
  • create_callback()
  • minimize()
  • copy_bounds_to_attr_name()
  • set_bounds_from_params_mask()
• Physical Object
  • PhysicalObject
    • PhysicalObject.get_transformation_matrix()
    • PhysicalObject.to_global_dir()
    • PhysicalObject.to_local_dir()
    • PhysicalObject.to_global_pos()
    • PhysicalObject.to_local_pos()
    • PhysicalObject.get_transform()
  • PhysicalSurface
    • PhysicalSurface.get_constraint_funs_leq_zero()
    • PhysicalSurface.parametric_sample()
    • PhysicalSurface.parametric_surface()
• Refractive Index
  • RefractiveIndex
    • RefractiveIndex.forward()
• Source
  • RaySource
    • RaySource.sample()
    • RaySource.forward()
    • RaySource.get_plot_points_2D()
    • RaySource.get_plot_points_3D()
    • RaySource.get_volume()
    • RaySource.get_transform()
  • LightSource
    • LightSource.sample()
    • LightSource.get_flux()
    • LightSource.get_volume()
  • PlaneSource
    • PlaneSource.get_plot_points_2D()
    • PlaneSource.get_plot_points_3D()
  • PlaneSource1D
    • PlaneSource1D.get_plot_points_2D()
    • PlaneSource1D.get_plot_points_3D()
  • make_cone_directions()
  • VisibleSunlightSimpleMonochromatic
    • VisibleSunlightSimpleMonochromatic.sample()
    • VisibleSunlightSimpleMonochromatic.forward()
  • VisibleSunlightSimple
    • VisibleSunlightSimple.sample()
    • VisibleSunlightSimple.forward()
  • CollimatedMonochromatic
    • CollimatedMonochromatic.sample()
    • CollimatedMonochromatic.forward()
  • CollimatedGaussianBeam
  • CollimatedMonochromatic1D
    • CollimatedMonochromatic1D.sample()
    • CollimatedMonochromatic1D.forward()
  • CollimatedMonochromatic1DRotSym
    • CollimatedMonochromatic1DRotSym.sample()
    • CollimatedMonochromatic1DRotSym.forward()
• Spectrum
  • Spectrum
    • Spectrum.forward()
  • VisibleSunlight_am15g
• Surface
  • Surface
    • Surface.functional()
    • Surface.get_functional_param_args()
    • Surface.explicit()
  • Plane
    • Plane.functional()
    • Plane.get_functional_param_args()
    • Plane.explicit()
  • Aspheric
    • Aspheric.g()
    • Aspheric.h()
    • Aspheric.functional()
    • Aspheric.get_functional_param_args()
    • Aspheric.explicit()
  • Bspline
    • Bspline.get_CAD_coeff()
    • Bspline.get_CAD_face()
    • Bspline.refine()
    • Bspline.functional()
    • Bspline.get_functional_param_args()
    • Bspline.explicit()
  • Legendre
    • Legendre.refine()
    • Legendre.functional()
    • Legendre.get_functional_param_args()
    • Legendre.explicit()
• Target Grid
  • Grid
    • Grid.get_area()
    • Grid.get_pixel_area()
    • Grid.get_yi_xi()
    • Grid.get_k()
    • Grid.map_matrix_to_ray()
    • Grid.sum()
    • Grid.prod()
    • Grid.mean()
    • Grid.min()
    • Grid.max()
    • Grid.get_y_middle()
    • Grid.get_x_middle()
    • Grid.nearest()
    • Grid.get_pixel_centers()
    • Grid.get_nearest_ray()
  • GridSquare
• Transforms
  • Transform
    • Transform.get_functional_param_args()
    • Transform.functional()
    • Transform.get_transformation_matrix()
    • Transform.to_global_dir()
    • Transform.to_local_dir()
    • Transform.to_global_pos()
    • Transform.to_local_pos()
    • Transform.get_functional_param_args()
    • Transform.functional()
    • Transform.get_transformation_matrix()
    • Transform.get_transform()
    • Transform.to_global_dir()
    • Transform.to_local_dir()
    • Transform.to_global_pos()
    • Transform.to_local_pos()
  • Identity
    • Identity.get_functional_param_args()
    • Identity.functional()
    • Identity.get_transformation_matrix()
  • Compose
    • Compose.get_functional_param_args()
    • Compose.get_transformation_matrix()
  • Offset
    • Offset.get_functional_param_args()
    • Offset.functional()
    • Offset.get_transformation_matrix()
  • Distance
    • Distance.get_functional_param_args()
    • Distance.functional()
    • Distance.get_transformation_matrix()
  • Rotation
    • Rotation.get_functional_param_args()
    • Rotation.functional()
    • Rotation.get_transformation_matrix()
  • rotation_matrix_x()
  • rotation_matrix_y()
  • rotation_matrix_z()
• Render
  • smoothed_irradiance()
  • binned_irradiance()
• Gaussian Smoother
  • gaussian_func_1D()
  • gaussian_func_2D()
  • calc_smooth_desired_irradiance()
  • GaussianSmoother
    • GaussianSmoother.x_grid_size
    • GaussianSmoother.y_grid_size
    • GaussianSmoother.sigma
    • GaussianSmoother.include_boundary
    • GaussianSmoother.x_range
    • GaussianSmoother.y_range
    • GaussianSmoother.grid
    • GaussianSmoother.discrete_desired_irradiance
    • GaussianSmoother.smoothed_desired_irradiance
    • GaussianSmoother.smoothed_irradiance()
    • GaussianSmoother.none_smoothed_irradiance()
    • GaussianSmoother.integrate_values()
  • make_evaluation_function()
  • make_merit_function()
  • GaussianSmootherSquare
• Basis Functions
  • Bspline
    • cox_de_boor_recursion()
    • basis_1D()
    • basis_2D()
    • surface_2D()
    • insert_knot_1D_single()
  • Chebyshev
  • Legendre
    • precompute_legendre_polynomials()
    • basis_2D()
    • get_num_coeff()
  • Zernike
    • get_num_basis()
    • get_radial_order()
    • get_azimuthal_frequency()
  • Module Contents
• Export
  • Cad
    • lens_to_solid()
    • extract_knots_and_multiplicities()
    • makeNurbsFace()
    • makeBsplineFace()
    • export_lens()
  • Module Contents
• Plotting
  • Core
    • Plotable
      • Plotable.fill_color
      • Plotable.outline_color
      • Plotable.is_volume
      • Plotable.get_plotly_color_scale()
      • Plotable.get_plotable_childs()
      • Plotable.get_plot_points_2D()
      • Plotable.get_plot_points_3D()
  • Quantity2D
    • plot()
  • System2D
    • annotate_position_simple()
    • annotate_position()
    • annotated_arrow()
    • layout()
    • ray_paths()
    • plot()
  • System3D
    • ray_paths_one_bin()
    • ray_paths()
    • surface()
    • get_optical_system_layout()
    • plot()
  • Wavelength
    • PlotableWavelength
      • PlotableWavelength.bounds
      • PlotableWavelength.ylabel
    • add_colour_bar()
    • plot()
  • Module Contents
    • Plotable
      • Plotable.fill_color
      • Plotable.outline_color
      • Plotable.is_volume
      • Plotable.get_plotly_color_scale()
      • Plotable.get_plotable_childs()
      • Plotable.get_plot_points_2D()
      • Plotable.get_plot_points_3D()
• Utils
  • Autograd
    • grad()
  • Irradiance Importer
    • create_irradiance_from_image_square()
    • pil_center_crop()
    • load_image()
  • Module Contents