4. diffractio
- 4.1. diffractio package
- 4.1.1. Submodules
- 4.1.2. diffractio.config module
- 4.1.3. diffractio.scalar_fields_X module
Scalar_field_XScalar_field_X.conjugate()Scalar_field_X.duplicate()Scalar_field_X.reduce_to_1()Scalar_field_X.clear_field()Scalar_field_X.save_data()Scalar_field_X.load_data()Scalar_field_X.cut_resample()Scalar_field_X.incident_field()Scalar_field_X.inverse_amplitude()Scalar_field_X.inverse_phase()Scalar_field_X.filter()Scalar_field_X.insert_mask()Scalar_field_X.pupil()Scalar_field_X.insert_array_masks()Scalar_field_X.repeat_structure()Scalar_field_X.fft()Scalar_field_X.ifft()Scalar_field_X.RS()Scalar_field_X.CZT()Scalar_field_X.WPM()Scalar_field_X.normalize()Scalar_field_X.MTF()Scalar_field_X.intensity()Scalar_field_X.average_intensity()Scalar_field_X.get_edges()Scalar_field_X.get_RS_minimum_z()Scalar_field_X.draw()
Scalar_field_X.self.xScalar_field_X.self.wavelengthScalar_field_X.self.uScalar_field_X.self.qualityScalar_field_X.self.infoScalar_field_X.self.typeScalar_field_X.self.datekernelRS()kernelRSinverse()PWD_kernel()WPM_schmidt_kernel()polychromatic_multiprocessing()extended_source_multiprocessing()extended_polychromatic_source()quality_factor()get_RS_minimum_z()
- 4.1.4. diffractio.scalar_fields_XY module
Scalar_field_XYScalar_field_XY.conjugate()Scalar_field_XY.duplicate()Scalar_field_XY.reduce_to_1()Scalar_field_XY.add()Scalar_field_XY.rotate()Scalar_field_XY.apodization()Scalar_field_XY.clear_field()Scalar_field_XY.save_data()Scalar_field_XY.load_data()Scalar_field_XY.save_mask()Scalar_field_XY.cut_resample()Scalar_field_XY.incident_field()Scalar_field_XY.pupil()Scalar_field_XY.fft()Scalar_field_XY.ifft_proposal()Scalar_field_XY.ifft()Scalar_field_XY.RS()Scalar_field_XY.WPM()Scalar_field_XY.CZT_backup()Scalar_field_XY.CZT()Scalar_field_XY.profile()Scalar_field_XY.draw_profile()Scalar_field_XY.get_edges()Scalar_field_XY.search_focus()Scalar_field_XY.MTF()Scalar_field_XY.beam_width_4s()Scalar_field_XY.intensity()Scalar_field_XY.average_intensity()Scalar_field_XY.send_image_screen()Scalar_field_XY.get_amplitude()Scalar_field_XY.get_phase()Scalar_field_XY.remove_phase()Scalar_field_XY.binarize()Scalar_field_XY.discretize()Scalar_field_XY.normalize()Scalar_field_XY.get_RS_minimum_z()Scalar_field_XY.draw()Scalar_field_XY.video()
Scalar_field_XY.self.xScalar_field_XY.self.yScalar_field_XY.self.wavelengthScalar_field_XY.self.uScalar_field_XY.self.infokernelRS()kernelRSinverse()kernelFresnel()PWD_kernel()WPM_schmidt_kernel()get_RS_minimum_z()quality_factor()
- 4.1.5. diffractio.scalar_fields_XYZ module
Scalar_field_XYZScalar_field_XYZ.xy_2_xyz()Scalar_field_XYZ.conjugate()Scalar_field_XYZ.normalize()Scalar_field_XYZ.duplicate()Scalar_field_XYZ.reduce_to_1()Scalar_field_XYZ.clear_field()Scalar_field_XYZ.clear_refractive_index()Scalar_field_XYZ.save_data()Scalar_field_XYZ.load_data()Scalar_field_XYZ.cut_resample()Scalar_field_XYZ.incident_field()Scalar_field_XYZ.final_field()Scalar_field_XYZ.RS()Scalar_field_XYZ.RS_amplification()Scalar_field_XYZ.BPM()Scalar_field_XYZ.PWD()Scalar_field_XYZ.WPM()Scalar_field_XYZ.to_Scalar_field_XY()Scalar_field_XYZ.to_Scalar_field_XZ()Scalar_field_XYZ.to_Scalar_field_YZ()Scalar_field_XYZ.to_Z()Scalar_field_XYZ.average_intensity()Scalar_field_XYZ.beam_widths()Scalar_field_XYZ.surface_detection()Scalar_field_XYZ.draw_proposal()Scalar_field_XYZ.draw_XY()Scalar_field_XYZ.draw_XZ()Scalar_field_XYZ.draw_YZ()Scalar_field_XYZ.draw_XYZ_deprecated()Scalar_field_XYZ.draw_volume_deprecated()Scalar_field_XYZ.draw_refractive_index_deprecated()Scalar_field_XYZ.video()
Scalar_field_XYZ.self.xScalar_field_XYZ.self.yScalar_field_XYZ.self.zScalar_field_XYZ.self.uScalar_field_XYZ.self.wavelengthScalar_field_XYZ.self.u0Scalar_field_XYZ.self.n_backgroundScalar_field_XYZ.self.n
- 4.1.6. diffractio.scalar_fields_XZ module
Scalar_field_XZScalar_field_XZ.reduce_to_1()Scalar_field_XZ.duplicate()Scalar_field_XZ.refractive_index_from_scalar_mask_XY()Scalar_field_XZ.rotate_field()Scalar_field_XZ.clear_field()Scalar_field_XZ.clear_refractive_index()Scalar_field_XZ.normalize()Scalar_field_XZ.mask_field()Scalar_field_XZ.smooth_refractive_index()Scalar_field_XZ.save_data()Scalar_field_XZ.load_data()Scalar_field_XZ.cut_resample()Scalar_field_XZ.incident_field()Scalar_field_XZ.final_field()Scalar_field_XZ.BPM()Scalar_field_XZ.BPM_inverse()Scalar_field_XZ.BPM_back_propagation()Scalar_field_XZ.RS()Scalar_field_XZ.PWD()Scalar_field_XZ.WPM()Scalar_field_XZ.RS_polychromatic()Scalar_field_XZ.BPM_polychromatic()Scalar_field_XZ.fast_propagation()Scalar_field_XZ.intensity()Scalar_field_XZ.average_intensity()Scalar_field_XZ.check_intensity()Scalar_field_XZ.detect_index_variations()Scalar_field_XZ.surface_detection()Scalar_field_XZ.draw()Scalar_field_XZ.draw_refractive_index()Scalar_field_XZ.draw_incident_field()Scalar_field_XZ.profile_longitudinal()Scalar_field_XZ.profile_transversal()Scalar_field_XZ.search_focus()Scalar_field_XZ.beam_widths()Scalar_field_XZ.video()Scalar_field_XZ.draw_profiles_interactive()
Scalar_field_XZ.self.xScalar_field_XZ.self.zScalar_field_XZ.self.wavelengthScalar_field_XZ.self.u0Scalar_field_XZ.self.uScalar_field_XZ.self.n_backgroundScalar_field_XZ.self.fastScalar_field_XZ.self.info
- 4.1.7. diffractio.scalar_fields_Z module
Scalar_field_ZScalar_field_Z.duplicate()Scalar_field_Z.conjugate()Scalar_field_Z.clear_field()Scalar_field_Z.save_data()Scalar_field_Z.load_data()Scalar_field_Z.cut_resample()Scalar_field_Z.normalize()Scalar_field_Z.intensity()Scalar_field_Z.average_intensity()Scalar_field_Z.FWHM1D()Scalar_field_Z.DOF()Scalar_field_Z.draw()
Scalar_field_Z.self.zScalar_field_Z.self.wavelengthScalar_field_Z.self.uScalar_field_Z.self.qualityScalar_field_Z.self.infoScalar_field_Z.self.typeScalar_field_Z.self.date
- 4.1.8. diffractio.scalar_masks_X module
Scalar_mask_XScalar_mask_X.filter()Scalar_mask_X.mask_from_function()Scalar_mask_X.mask_from_array()Scalar_mask_X.dots()Scalar_mask_X.slit()Scalar_mask_X.double_slit()Scalar_mask_X.two_levels()Scalar_mask_X.gray_scale()Scalar_mask_X.prism()Scalar_mask_X.biprism_fresnel()Scalar_mask_X.biprism_fresnel_nh()Scalar_mask_X.lens()Scalar_mask_X.lens_spherical()Scalar_mask_X.aspheric()Scalar_mask_X.fresnel_lens()Scalar_mask_X.roughness()Scalar_mask_X.dust_different_sizes()Scalar_mask_X.dust()Scalar_mask_X.sine_grating()Scalar_mask_X.ronchi_grating()Scalar_mask_X.binary_grating()Scalar_mask_X.blazed_grating()Scalar_mask_X.chirped_grating_p()Scalar_mask_X.chirped_grating_q()Scalar_mask_X.chirped_grating()Scalar_mask_X.binary_code_positions()Scalar_mask_X.binary_code()
Scalar_mask_X.self.xScalar_mask_X.self.wavelengthScalar_mask_X.self.uScalar_mask_X.self.qualityScalar_mask_X.self.infoScalar_mask_X.self.typeScalar_mask_X.self.date
- 4.1.9. diffractio.scalar_masks_XY module
Scalar_mask_XYScalar_mask_XY.set_amplitude()Scalar_mask_XY.set_phase()Scalar_mask_XY.area()Scalar_mask_XY.inverse_amplitude()Scalar_mask_XY.inverse_phase()Scalar_mask_XY.filter()Scalar_mask_XY.widen()Scalar_mask_XY.extrude_mask_x()Scalar_mask_XY.mask_from_function()Scalar_mask_XY.image()Scalar_mask_XY.repeat_structure()Scalar_mask_XY.masks_to_positions()Scalar_mask_XY.polygon()Scalar_mask_XY.regular_polygon()Scalar_mask_XY.star()Scalar_mask_XY.triangle()Scalar_mask_XY.photon_sieve()Scalar_mask_XY.insert_array_masks()Scalar_mask_XY.dots()Scalar_mask_XY.dots_regular()Scalar_mask_XY.one_level()Scalar_mask_XY.two_levels()Scalar_mask_XY.edge_series()Scalar_mask_XY.slit()Scalar_mask_XY.slit_series()Scalar_mask_XY.double_slit()Scalar_mask_XY.square()Scalar_mask_XY.gray_scale()Scalar_mask_XY.circle()Scalar_mask_XY.circular_sector()Scalar_mask_XY.super_gauss()Scalar_mask_XY.square_circle()Scalar_mask_XY.angular_aperture()Scalar_mask_XY.ring()Scalar_mask_XY.rings()Scalar_mask_XY.cross()Scalar_mask_XY.prism()Scalar_mask_XY.lens()Scalar_mask_XY.lens_spherical()Scalar_mask_XY.aspheric()Scalar_mask_XY.lens_cylindrical()Scalar_mask_XY.fresnel_lens()Scalar_mask_XY.axicon()Scalar_mask_XY.axicon_binary()Scalar_mask_XY.biprism_fresnel()Scalar_mask_XY.radial_grating()Scalar_mask_XY.angular_grating()Scalar_mask_XY.hyperbolic_grating()Scalar_mask_XY.hammer()Scalar_mask_XY.archimedes_spiral()Scalar_mask_XY.laguerre_gauss_spiral()Scalar_mask_XY.forked_grating()Scalar_mask_XY.sine_grating()Scalar_mask_XY.sine_edge_grating()Scalar_mask_XY.ronchi_grating()Scalar_mask_XY.binary_grating()Scalar_mask_XY.blazed_grating()Scalar_mask_XY.grating_2D()Scalar_mask_XY.grating_2D_chess()Scalar_mask_XY.roughness()Scalar_mask_XY.circle_rough()Scalar_mask_XY.ring_rough()Scalar_mask_XY.fresnel_lens_rough()Scalar_mask_XY.super_ellipse()Scalar_mask_XY.superformula()Scalar_mask_XY.elliptical_phase()Scalar_mask_XY.sinusoidal_slit()Scalar_mask_XY.crossed_slits()Scalar_mask_XY.hermite_gauss_binary()Scalar_mask_XY.laguerre_gauss_binary()
Scalar_mask_XY.self.xScalar_mask_XY.self.yScalar_mask_XY.self.wavelengthScalar_mask_XY.self.uScalar_mask_XY.self.info
- 4.1.10. diffractio.scalar_masks_XYZ module
- 4.1.11. diffractio.scalar_masks_XZ module
Scalar_mask_XZScalar_mask_XZ.extrude_mask()Scalar_mask_XZ.mask_from_function()Scalar_mask_XZ.mask_from_array()Scalar_mask_XZ.mask_from_array_proposal()Scalar_mask_XZ.object_by_surfaces()Scalar_mask_XZ.add_surfaces()Scalar_mask_XZ.discretize_refractive_index()Scalar_mask_XZ.image()Scalar_mask_XZ.dots()Scalar_mask_XZ.semi_plane()Scalar_mask_XZ.layer()Scalar_mask_XZ.rectangle()Scalar_mask_XZ.slit()Scalar_mask_XZ.sphere()Scalar_mask_XZ.semi_sphere()Scalar_mask_XZ.lens_plane_convergent()Scalar_mask_XZ.lens_convergent()Scalar_mask_XZ.lens_plane_divergent()Scalar_mask_XZ.lens_divergent()Scalar_mask_XZ.aspheric_surface_z()Scalar_mask_XZ.aspheric_lens()Scalar_mask_XZ.wedge()Scalar_mask_XZ.prism()Scalar_mask_XZ.biprism()Scalar_mask_XZ.ronchi_grating()Scalar_mask_XZ.sine_grating()Scalar_mask_XZ.probe()Scalar_mask_XZ.rough_sheet()
Scalar_mask_XZ.self.xScalar_mask_XZ.self.zScalar_mask_XZ.self.wavelengthScalar_mask_XZ.self.u0Scalar_mask_XZ.self.uScalar_mask_XZ.self.n_backgroundScalar_mask_XZ.self.info
- 4.1.12. diffractio.scalar_sources_X module
- 4.1.13. diffractio.scalar_sources_XY module
Scalar_source_XYScalar_source_XY.plane_wave()Scalar_source_XY.gauss_beam()Scalar_source_XY.spherical_wave()Scalar_source_XY.vortex_beam()Scalar_source_XY.hermite_gauss_beam()Scalar_source_XY.laguerre_beam()Scalar_source_XY.zernike_beam()Scalar_source_XY.bessel_beam()Scalar_source_XY.plane_waves_dict()Scalar_source_XY.plane_waves_several_inclined()Scalar_source_XY.gauss_beams_several_parallel()Scalar_source_XY.gauss_beams_several_inclined()
Scalar_source_XY.self.xScalar_source_XY.self.yScalar_source_XY.self.wavelengthScalar_source_XY.self.uScalar_source_XY.self.info
- 4.1.14. diffractio.utils_common module
- 4.1.15. diffractio.utils_drawing module
- 4.1.16. diffractio.utils_math module
nextpow2()Bluestein_dft_x()Bluestein_dft_xy()find_local_extrema()reduce_to_1()distance()nearest()nearest2()find_extrema()ndgrid()get_amplitude()get_phase()amplitude2phase()phase2amplitude()normalize()binarize()discretize()delta_kronecker()vector_product()dot_product()divergence()curl()get_edges()cut_function()fft_convolution2d()fft_convolution1d()fft_filter()fft_correlation1d()fft_correlation2d()rotate_image()cart2pol()pol2cart()fZernike()laguerre_polynomial_nk()get_k()get_k_deprecated()filter_edge_1D()filter_edge_2D()
- 4.1.17. diffractio.utils_multiprocessing module
- 4.1.18. diffractio.utils_optics module
roughness_1D()roughness_2D()beam_width_1D()width_percentage()beam_width_2D()refractive_index()FWHM1D()FWHM2D()DOF()detect_intensity_range()MTF_ideal()lines_mm_2_cycles_degree()MTF_parameters()gauss_spectrum()lorentz_spectrum()uniform_spectrum()normalize_field()field_parameters()convert_phase2heigths()convert_amplitude2heigths()fresnel_equations_kx()transmitances_reflectances_kx()fresnel_equations()transmitances_reflectances()
- 4.1.19. diffractio.utils_slicer_deprecated module
- 4.1.20. diffractio.utils_tests module
- 4.1.21. diffractio.vector_fields_X module
Vector_field_XVector_field_X.save_data()Vector_field_X.load_data()Vector_field_X.clear_field()Vector_field_X.duplicate()Vector_field_X.get()Vector_field_X.apply_mask()Vector_field_X.intensity()Vector_field_X.polarization_states()Vector_field_X.polarization_ellipse()Vector_field_X.normalize()Vector_field_X.draw()
Vector_field_X.self.xVector_field_X.self.wavelengthVector_field_X.self.ExVector_field_X.self.EyVector_field_X.self.Ez
- 4.1.22. diffractio.vector_fields_XY module
Vector_field_XYVector_field_XY.save_data()Vector_field_XY.load_data()Vector_field_XY.clear()Vector_field_XY.duplicate()Vector_field_XY.get()Vector_field_XY.pupil()Vector_field_XY.apply_mask()Vector_field_XY.intensity()Vector_field_XY.RS()Vector_field_XY.VFFT()Vector_field_XY.IVFFT()Vector_field_XY.VRS()Vector_field_XY.CZT()Vector_field_XY.polarization_states()Vector_field_XY.polarization_ellipse()Vector_field_XY.normalize()Vector_field_XY.cut_resample()Vector_field_XY.draw()
Vector_field_XY.self.xVector_field_XY.self.yVector_field_XY.self.wavelengthVector_field_XY.self.ExVector_field_XY.self.Ey
- 4.1.23. diffractio.vector_fields_XYZ module
Vector_field_XYZVector_field_XYZ.save_data()Vector_field_XYZ.load_data()Vector_field_XYZ.clear_field()Vector_field_XYZ.duplicate()Vector_field_XYZ.get()Vector_field_XYZ.intensity()Vector_field_XYZ.polarization_states()Vector_field_XYZ.polarization_ellipse()Vector_field_XYZ.normalize()Vector_field_XYZ.to_Vector_field_XY()Vector_field_XYZ.to_Vector_field_XZ()Vector_field_XYZ.to_Vector_field_YZ()Vector_field_XYZ.to_Z()Vector_field_XYZ.draw_XY()Vector_field_XYZ.draw_XZ()Vector_field_XYZ.draw_YZ()
Vector_field_XYZ.self.xVector_field_XYZ.self.yVector_field_XYZ.self.zVector_field_XYZ.self.wavelengthVector_field_XYZ.self.ExVector_field_XYZ.self.EyVector_field_XYZ.self.Ez
- 4.1.24. diffractio.vector_fields_XZ module
Vector_field_XZVector_field_XZ.save_data()Vector_field_XZ.load_data()Vector_field_XZ.clear_field()Vector_field_XZ.duplicate()Vector_field_XZ.get()Vector_field_XZ.apply_mask()Vector_field_XZ.intensity()Vector_field_XZ.polarization_states()Vector_field_XZ.polarization_ellipse()Vector_field_XZ.normalize()Vector_field_XZ.draw()
Vector_field_XZ.self.xVector_field_XZ.self.wavelengthVector_field_XZ.self.ExVector_field_XZ.self.EyVector_field_XZ.self.Ezpolarization_ellipse()
- 4.1.25. diffractio.vector_fields_Z module
Vector_field_ZVector_field_Z.save_data()Vector_field_Z.load_data()Vector_field_Z.clear_field()Vector_field_Z.duplicate()Vector_field_Z.get()Vector_field_Z.apply_mask()Vector_field_Z.intensity()Vector_field_Z.polarization_states()Vector_field_Z.polarization_ellipse()Vector_field_Z.normalize()Vector_field_Z.draw()
Vector_field_Z.self.zVector_field_Z.self.wavelengthVector_field_Z.self.ExVector_field_Z.self.EyVector_field_Z.self.Ez
- 4.1.26. diffractio.vector_masks_XY module
Vector_mask_XYVector_mask_XY.duplicate()Vector_mask_XY.apply_circle()Vector_mask_XY.pupil()Vector_mask_XY.scalar_to_vector_mask()Vector_mask_XY.complementary_masks()Vector_mask_XY.multilevel_mask()Vector_mask_XY.from_py_pol()Vector_mask_XY.polarizer_linear()Vector_mask_XY.quarter_waveplate()Vector_mask_XY.half_waveplate()Vector_mask_XY.polarizer_retarder()Vector_mask_XY.to_py_pol()Vector_mask_XY.draw()
rotation_matrix_Jones()
- 4.1.27. diffractio.vector_sources_XY module
Vector_source_XYVector_source_XY.constant_polarization()Vector_source_XY.azimuthal_wave()Vector_source_XY.radial_wave()Vector_source_XY.radial_inverse_wave()Vector_source_XY.azimuthal_inverse_wave()Vector_source_XY.local_polarized_vector_wave()Vector_source_XY.local_polarized_vector_wave_radial()Vector_source_XY.local_polarized_vector_wave_hybrid()Vector_source_XY.spiral_polarized_beam()Vector_source_XY.to_py_pol()
Vector_source_XY.self.xVector_source_XY.self.yVector_source_XY.self.wavelengthVector_source_XY.self.ExVector_source_XY.self.Eydefine_initial_field()
- 4.1.28. Module contents