structured-optics 0.6.2__tar.gz → 0.6.4__tar.gz

{structured_optics-0.6.2/structured_optics.egg-info → structured_optics-0.6.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: structured_optics
-Version: 0.6.2
+Version: 0.6.4
 Summary: Package for Structured Light simulation
 Author: Altilano C. Barbosa
 License-Expression: BSD-3-Clause
@@ -95,6 +95,18 @@ Issues and pull requests are welcome at
 This project is licensed under the BSD-3-Clause License. See `LICENSE` for details.
 
 ## Citation
+If you use this package in your research, please cite it:
+
+```bibtex
+@software{barbosa_structured_optics,
+  author  = {Barbosa, Altilano C.},
+  title   = {structured\_optics: Package for Structured Light simulation},
+  year    = {2026},
+  version = {0.6.3},
+  url     = {https://github.com/Altilano/structured-optics}
+}
+```
+See also `CITATION.cff` or use GitHub's "Cite this repository" button.
 
 ## To do
 

{structured_optics-0.6.2 → structured_optics-0.6.4}/README.md

@@ -81,6 +81,18 @@ Issues and pull requests are welcome at
 This project is licensed under the BSD-3-Clause License. See `LICENSE` for details.
 
 ## Citation
+If you use this package in your research, please cite it:
+
+```bibtex
+@software{barbosa_structured_optics,
+  author  = {Barbosa, Altilano C.},
+  title   = {structured\_optics: Package for Structured Light simulation},
+  year    = {2026},
+  version = {0.6.3},
+  url     = {https://github.com/Altilano/structured-optics}
+}
+```
+See also `CITATION.cff` or use GitHub's "Cite this repository" button.
 
 ## To do
 

{structured_optics-0.6.2 → structured_optics-0.6.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "structured_optics"
-version = "0.6.2"
+version = "0.6.4"
 description = "Package for Structured Light simulation"
 readme = "README.md"
 license = "BSD-3-Clause"

{structured_optics-0.6.2 → structured_optics-0.6.4}/structured_optics/diagnostics.py

@@ -62,7 +62,7 @@ class BeamDiagnostics:
             Polarization component into which the resulting intensity profile is measured. Default is sum of 
             all intensity components.
 
-        Return
+        Returns
         ------
         ndarray
             Array with intensity profile (x,y).
@@ -104,12 +104,12 @@ class BeamDiagnostics:
         """ 
         Compute the intensity-weighted center of mass of the field in physical x and y coordinates. 
         
-        Parameters 
+        Parameters
         ---------- 
         pol_index : int, optional 
             Polarization component to use; None uses total intensity. 
             
-        Returns 
+        Returns
         ------- 
         tuple (x_cm, y_cm) 
             center-of-mass coordinates in physical units. """ 
@@ -142,7 +142,7 @@ class BeamDiagnostics:
         Calculate the intensity-weighted spatial standard deviation
         along x and y.
 
-        Parameters 
+        Parameters
         ---------- 
         pol_index : int, optional 
             Polarization component to use; None uses total intensity. 

{structured_optics-0.6.2 → structured_optics-0.6.4}/structured_optics/hologram.py

@@ -77,7 +77,7 @@ def dmd_hologram(beam, cx:float, cy:float, sign:int=1, input:object=None)-> np.n
     """ 
     Generate a binary-amplitude DMD hologram. 
     
-    Parameters 
+    Parameters
     ---------- 
     beam : Beam 
         Desired output beam. Its Ex component defines the target amplitude and phase. 
@@ -89,7 +89,7 @@ def dmd_hologram(beam, cx:float, cy:float, sign:int=1, input:object=None)-> np.n
         Optional Incident beam illuminating the DMD. If None, the incident beam is assumed 
         to have uniform amplitude and zero phase, reproducing the original behavior. 
     
-    Returns 
+    Returns
     ------- 
     H : ndarray 
         Binary DMD hologram. 

{structured_optics-0.6.2 → structured_optics-0.6.4}/structured_optics/masks.py

@@ -127,9 +127,12 @@ class AstigmaticLens(SpatialMask):
 
 
 class TiltedLens(AstigmaticLens):
-    """A spherical lens viewed at an angle, modeled as an equivalent
-    AstigmaticLens with effective (fx, fy) derived from the tilt angle."""
-    def __init__(self, f: float, phi: float, f0: tuple = (0, 0), flip_axis: bool = False):
+    """A thin spherical lens tilted about the y axis, modeled as an equivalent
+    AstigmaticLens with effective (fx, fy) derived from the tilt angle and
+    refractive index."""
+
+    def __init__(self, f: float, phi: float, n: float = 1.5,
+                 f0: tuple = (0, 0), flip_axis: bool = False):
         """
         Parameters
         ----------
@@ -137,16 +140,26 @@ class TiltedLens(AstigmaticLens):
             Nominal (untilted) focal length of the lens.
         phi : float
             Tilt angle, in radians.
+        n : float, optional
+            Refractive index of the lens material. Defaults to 1.5.
         f0 : tuple, optional
             (x, y) offset of the lens center. Defaults to (0, 0).
         flip_axis : bool, optional
-            If True, swap the roles of the tilted/untilted axes.
-            Defaults to False.
+            If True, the tilt is about the x axis instead of y
+            (swaps fx and fy). Defaults to False.
         """
+        if n <= 1:
+            raise ValueError("n must be greater than 1")
+
+        denom = np.sqrt(n**2 - np.sin(phi)**2) - np.cos(phi)
+        fy = f * (n - 1) / denom
+        fx = fy * np.cos(phi) ** 2
 
-        fx, fy = f * np.cos(phi) ** 3, f * np.cos(phi)
         if flip_axis:
             fx, fy = fy, fx
+
+        self.n = n
+        self.phi = phi
         super().__init__(fx, fy, f0)
 
 

{structured_optics-0.6.2 → structured_optics-0.6.4}/structured_optics/struct_opt.py

@@ -10,7 +10,7 @@ from .prop_methods import(  propagate_fresnel_conv, propagate_fresnel_fft, propa
 from .modes import (hg, hg_astigmatic, lg, nbessel, gbessel, lg_prod, frac_oam, frac_oam_qs,
                     IG_even, IG_odd, HInceG, circle, square, triangle, lp, lp_hel)
 
-from .tools import _build_from_coefs_and_basis
+from .utils import _build_from_coefs_and_basis
 from .diagnostics import BeamDiagnostics
 
 __all__ = ["Beam"]
@@ -320,7 +320,7 @@ class Beam(BeamDiagnostics):
 
         Reference
         ---------
-        .. [1] https://en.wikipedia.org/wiki/Gaussian_beam
+           [1] https://en.wikipedia.org/wiki/Gaussian_beam
         """
         return self._set_mode(hg(self, n, m, z, angle=angle),  polarization=polarization)
 
@@ -347,6 +347,11 @@ class Beam(BeamDiagnostics):
         -------
         Beam
             self, with field set to the requested mode.
+
+        Reference
+        ---------
+            [1] Arnaud, Jacques A., and Herwig Kogelnik. "Gaussian light beams with general astigmatism." 
+            Applied optics 8.8 (1969): 1687-1693.
         """
         return self._set_mode(hg_astigmatic(self, n, m, wx, wy, z, angle=angle),  polarization=polarization)
 
@@ -374,7 +379,7 @@ class Beam(BeamDiagnostics):
 
         Reference
         ---------
-        .. [1] https://en.wikipedia.org/wiki/Gaussian_beam
+           [1] https://en.wikipedia.org/wiki/Gaussian_beam
         """
         return self._set_mode(lg(self, l, p, z, angle=angle),  polarization=polarization)
 

{structured_optics-0.6.2 → structured_optics-0.6.4}/structured_optics/tools.py

@@ -257,45 +257,4 @@ def bessel_basis(Beam, Nmax, waist=None, norm1=False):
         basis = basis / np.max(np.abs(basis))
     return basis
 
-def _build_from_coefs_and_basis(Beam, coefs, basis, pol_index = 0):
-    """
-    Reconstruct a field as a weighted sum of basis modes and store it
-    into `Beam.field`.
-
-    Internal helper (not in `__all__`); used to turn a modal
-    decomposition (e.g. from `hg_proj`/`lg_proj`) plus its basis
-    (e.g. from `hg_basis`/`lg_basis`/`bessel_basis`) back into an
-    actual field.
-
-    Parameters
-    ----------
-    Beam : object
-        Beam instance whose `.field` will be overwritten with the
-        reconstructed field.
-    coefs : np.ndarray
-        2D array of complex coefficients, shape (N, N), one per basis
-        mode.
-    basis : np.ndarray
-        Array of basis mode fields, shape (N, N, Dy, Dx), matching
-        `coefs` in its first two dimensions (e.g. as returned by
-        `hg_basis` or `lg_basis`).
-    pol_index : int, optional
-        Polarization/field-component index of `Beam.field` (and of the
-        internal auxiliary field) that the reconstructed sum is
-        written into. Defaults to 0.
-
-    Returns
-    -------
-    Beam : object
-        `Beam`, with `Beam.field` set to the auxiliary field after
-        accumulating `sum(coefs[i, j] * basis[i, j])` into component
-        `pol_index`.
-    """
-    N = len(coefs)
-    aux = Beam.copy_clean()
-    for i in range(N):
-        for j in range(N):
-            aux.field[pol_index] = aux.field[pol_index] + coefs[i,j] * basis[i,j]
-    Beam.field = aux.field
-    return Beam
 

{structured_optics-0.6.2 → structured_optics-0.6.4}/structured_optics/utils.py

@@ -880,4 +880,42 @@ def zernikes_phase(beam, coefs, strengths,):
 
     for (n, m), strength in zip(coefs, strengths):
         phase += strength * zernike(n, m, r, phi)
-    return np.exp(1j * phase)
+    return np.exp(1j * phase)
+
+
+#builder util
+def _build_from_coefs_and_basis(Beam, coefs, basis, pol_index=0):
+    """
+    Reconstruct a field as a weighted sum of basis modes.
+
+    Parameters
+    ----------
+    Beam : object
+        Beam instance whose `.field` will be overwritten.
+    coefs : np.ndarray
+        Complex coefficient array, shape (N, N).
+    basis : np.ndarray
+        Basis modes, shape (N, N, Dy, Dx).
+    pol_index : int or None, optional
+        Polarization/field-component index to reconstruct. If None,
+        the reconstructed field is assigned to all polarization
+        components.
+
+    Returns
+    -------
+    Beam
+        Beam with the reconstructed field.
+    """
+    field = np.einsum(
+        "ij,ijyx->yx",
+        coefs,
+        basis,
+        optimize=True,
+    )
+
+    if pol_index is None:
+        Beam.field[...] = field
+    else:
+        Beam.field[pol_index] = field
+
+    return Beam

{structured_optics-0.6.2 → structured_optics-0.6.4/structured_optics.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: structured_optics
-Version: 0.6.2
+Version: 0.6.4
 Summary: Package for Structured Light simulation
 Author: Altilano C. Barbosa
 License-Expression: BSD-3-Clause
@@ -95,6 +95,18 @@ Issues and pull requests are welcome at
 This project is licensed under the BSD-3-Clause License. See `LICENSE` for details.
 
 ## Citation
+If you use this package in your research, please cite it:
+
+```bibtex
+@software{barbosa_structured_optics,
+  author  = {Barbosa, Altilano C.},
+  title   = {structured\_optics: Package for Structured Light simulation},
+  year    = {2026},
+  version = {0.6.3},
+  url     = {https://github.com/Altilano/structured-optics}
+}
+```
+See also `CITATION.cff` or use GitHub's "Cite this repository" button.
 
 ## To do