topolino 0.1.0__tar.gz

topolino-0.1.0/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, Dream Beam
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

topolino-0.1.0/PKG-INFO

@@ -0,0 +1,30 @@
+Metadata-Version: 2.4
+Name: topolino
+Version: 0.1.0
+Summary: Fourier optics and wave propagation utilities
+Author-email: Rachel Migdal <rmigdal2007@gmail.com>
+License-Expression: MIT
+Project-URL: Repository, https://github.com/dream-beam/Topolino
+Keywords: fourier optics,wave propagation,physics,optics
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: scikit-image
+Provides-Extra: dev
+Requires-Dist: jupyter; extra == "dev"
+Requires-Dist: matplotlib; extra == "dev"
+Dynamic: license-file
+
+# Topolino
+ramigdal@lbl.gov, awojdyla@lbl.gov
+![Topolino](assets/topolino_logo.png)
+
+This repository is a Python toolkit for exploring paraxial wave propagation and related optical phenomena. At its core is a Fresnel propagator `propTF` that uses NumPy's FFT to propagate a complex field through space. The package includes routines for generating Gaussian beams, extracting the RMS beam radius from intensity moments, and directly comparing the numerical propagation to the analytical Gaussian‑beam law.
+A collection of Jupyter notebooks demonstrates a range of topics: a thin‑lens model, creation and propagation of spiral beams, diffraction patterns of transmission gratings, and a full grating‑experiment simulation that includes a light source, propagation to a grating, and observation of resulting orders. The notebooks expose parameters (wavelength , aperture size, grating period, vortex charge, ...), visualize results with 1‑D plots, RMS‑size versus distance curves, and 2‑D intensity maps, and provide side‑by‑side comparisons with analytical predictions where available.
+
+![Propagation](assets/propagation.png)

topolino-0.1.0/README.md

@@ -0,0 +1,8 @@
+# Topolino
+ramigdal@lbl.gov, awojdyla@lbl.gov
+![Topolino](assets/topolino_logo.png)
+
+This repository is a Python toolkit for exploring paraxial wave propagation and related optical phenomena. At its core is a Fresnel propagator `propTF` that uses NumPy's FFT to propagate a complex field through space. The package includes routines for generating Gaussian beams, extracting the RMS beam radius from intensity moments, and directly comparing the numerical propagation to the analytical Gaussian‑beam law.
+A collection of Jupyter notebooks demonstrates a range of topics: a thin‑lens model, creation and propagation of spiral beams, diffraction patterns of transmission gratings, and a full grating‑experiment simulation that includes a light source, propagation to a grating, and observation of resulting orders. The notebooks expose parameters (wavelength , aperture size, grating period, vortex charge, ...), visualize results with 1‑D plots, RMS‑size versus distance curves, and 2‑D intensity maps, and provide side‑by‑side comparisons with analytical predictions where available.
+
+![Propagation](assets/propagation.png)

topolino-0.1.0/pyproject.toml

@@ -0,0 +1,35 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "topolino"
+version = "0.1.0"
+description = "Fourier optics and wave propagation utilities"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+authors = [
+    { name = "Rachel Migdal", email = "rmigdal2007@gmail.com" },
+]
+keywords = ["fourier optics", "wave propagation", "physics", "optics"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Science/Research",
+    "Programming Language :: Python :: 3",
+    "Topic :: Scientific/Engineering :: Physics",
+]
+dependencies = [
+    "numpy",
+    "scikit-image",
+]
+
+[project.urls]
+Repository = "https://github.com/dream-beam/Topolino"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["topolino*"]
+
+[project.optional-dependencies]
+dev = ["jupyter", "matplotlib"]

topolino-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

topolino-0.1.0/topolino/__init__.py

@@ -0,0 +1,11 @@
+from .fourier import ft, ift, fs, setfreq
+from .propagation import propTF, propTF2
+from .beam import gaussian, rms_width, generate_speckle
+from .analysis import azimuthal_avg, circsum
+
+__all__ = [
+    "ft", "ift", "fs", "setfreq",
+    "propTF", "propTF2",
+    "gaussian", "rms_width", "generate_speckle",
+    "azimuthal_avg", "circsum",
+]

topolino-0.1.0/topolino/analysis.py

@@ -0,0 +1,36 @@
+import numpy as np
+from skimage.transform import warp_polar
+
+
+def azimuthal_avg(data_2d):
+    """
+    Azimuthal average of a 2D square image.
+
+    Parameters
+    ----------
+    data_2d : 2D ndarray
+        Square array (intensity or amplitude).
+
+    Returns
+    -------
+    1D ndarray
+        Radial profile from centre to edge (length = floor((N+1)/2) - 1).
+    """
+    Np = int(np.floor((len(data_2d) + 1) / 2))
+    return np.sum(warp_polar(data_2d), axis=0)[: Np - 1]
+
+
+def circsum(field):
+    """
+    Radial power spectrum via azimuthal sum of |field|².
+
+    Parameters
+    ----------
+    field : 2D ndarray
+        Complex or real field.
+
+    Returns
+    -------
+    1D ndarray
+    """
+    return np.sum(warp_polar(np.abs(field) ** 2), axis=0)

topolino-0.1.0/topolino/beam.py

@@ -0,0 +1,94 @@
+import numpy as np
+
+from .fourier import ft, ift, fs
+from .propagation import propTF
+
+
+def gaussian(x, mean, fwhm):
+    """
+    1D Gaussian parameterised by FWHM.
+
+    Parameters
+    ----------
+    x : array_like
+        Evaluation points (any units).
+    mean : float
+        Centre (same units as x).
+    fwhm : float
+        Full width at half maximum (same units as x).
+
+    Returns
+    -------
+    ndarray
+    """
+    sigma = fwhm / (2 * np.sqrt(2 * np.log(2)))
+    return np.exp(-((x - mean) / (np.sqrt(2) * sigma)) ** 2)
+
+
+def rms_width(field, x):
+    """
+    RMS width of a 1D field distribution.
+
+    Parameters
+    ----------
+    field : array_like
+        Complex or real field (intensity is |field|²).
+    x : array_like
+        Spatial axis (same length as field).
+
+    Returns
+    -------
+    float
+        RMS width in the same units as x.
+    """
+    x = np.asarray(x)
+    I = np.abs(field) ** 2
+    I = I / I.sum()
+    xc = np.sum(I * x)
+    return np.sqrt(np.sum(I * (x - xc) ** 2))
+
+
+def generate_speckle(dx_m, Dx_m, z_m, fwhm_m=500e-6, lambda_m=1e-6, fc_cpm=1e6, wfe_w=1 / 20):
+    """
+    Simulate a speckle intensity pattern after free-space propagation.
+
+    Parameters
+    ----------
+    dx_m : float
+        Pixel size in metres.
+    Dx_m : float
+        Field extent in metres.
+    z_m : float
+        Propagation distance in metres.
+    fwhm_m : float
+        Beam FWHM at the source plane (metres).
+    lambda_m : float
+        Wavelength (metres).
+    fc_cpm : float
+        Speckle spatial-frequency cutoff (cycles per metre).
+    wfe_w : float
+        Wavefront error amplitude in waves (peak-to-valley).
+
+    Returns
+    -------
+    I : 2D ndarray
+        Intensity at the output plane.
+    """
+    x_m = np.linspace(-Dx_m / 2, Dx_m / 2, int(np.ceil(Dx_m / dx_m)))
+    N = len(x_m)
+    X_m, Y_m = np.meshgrid(x_m, x_m)
+
+    f_cpm = fs(x_m)
+    Fx, Fy = np.meshgrid(f_cpm, f_cpm)
+
+    GFILT = gaussian(Fx, 0, fc_cpm) * gaussian(Fy, 0, fc_cpm)
+
+    noise = np.random.randn(N, N)
+    noise_filt = np.abs(ift(ft(noise) * GFILT))
+    noise_filt = noise_filt / np.std(noise_filt)
+
+    E0 = gaussian(X_m, 0, fwhm_m) * gaussian(Y_m, 0, fwhm_m)
+    E1 = E0 * np.exp(1j * 2 * np.pi * noise_filt * wfe_w)
+
+    E2 = propTF(E1, Dx_m, lambda_m, z_m)
+    return np.abs(E2) ** 2

topolino-0.1.0/topolino/fourier.py

@@ -0,0 +1,49 @@
+import numpy as np
+
+
+def ft(t):
+    """Centered 2D FFT: ifftshift → fft2 → fftshift."""
+    return np.fft.fftshift(np.fft.fft2(np.fft.ifftshift(t)))
+
+
+def ift(t):
+    """Centered 2D IFFT: ifftshift → ifft2 → fftshift."""
+    return np.fft.fftshift(np.fft.ifft2(np.fft.ifftshift(t)))
+
+
+def fs(t):
+    """Frequency axis (cycles per unit) matching a centered spatial axis t."""
+    N = len(t)
+    df = 1 / (t[-1] - t[0])
+    return np.fft.fftshift(
+        np.array([df * n if n < N / 2 else df * (n - N) for n in range(N)])
+    )
+
+
+def setfreq(px_size_m, img_size_m):
+    """
+    Build spatial and frequency axes for a square image.
+
+    Parameters
+    ----------
+    px_size_m : float
+        Pixel size in metres.
+    img_size_m : float
+        Full image extent in metres.
+
+    Returns
+    -------
+    dx_m, Dx_m, f_cpm, px_size_m, x_m, Nfft, df_cpm, Df_cpm
+    """
+    dx_m = px_size_m
+    Dx_m = img_size_m
+    x_m = np.linspace(-Dx_m / 2, Dx_m / 2, int(Dx_m / dx_m) + 1)
+    f_sample = 1 / (x_m[1] - x_m[0])
+    Nfft = len(x_m)
+    df_cpm = f_sample / Nfft
+    f_cpm = np.linspace(0, f_sample - df_cpm, Nfft) - (
+        f_sample - np.mod(Nfft, 2) * df_cpm
+    ) / 2
+    df_cpm = f_cpm[1] - f_cpm[0]
+    Df_cpm = f_cpm[-1] - f_cpm[0]
+    return dx_m, Dx_m, f_cpm, px_size_m, x_m, Nfft, df_cpm, Df_cpm

topolino-0.1.0/topolino/propagation.py

@@ -0,0 +1,69 @@
+import numpy as np
+
+from .fourier import ft, fs
+
+
+def propTF(E_in, L_m, lambda_m, z_m):
+    """
+    Angular-spectrum (transfer-function) Fresnel propagation — square window.
+
+    Parameters
+    ----------
+    E_in : 2D array
+        Input complex field.
+    L_m : float
+        Full side length of the square window in metres.
+    lambda_m : float
+        Wavelength in metres.
+    z_m : float
+        Propagation distance in metres.
+
+    Returns
+    -------
+    E_out : 2D array
+        Output complex field at distance z_m.
+    """
+    Nx, Ny = np.shape(E_in)
+    dx = L_m / Nx
+
+    fx = fs(np.arange(Nx) * dx)
+    fy = fs(np.arange(Ny) * dx) if Ny > 2 else np.zeros(1)
+
+    FX, FY = np.meshgrid(fx, fy)
+    H = np.exp(-1j * np.pi * lambda_m * z_m * (FX**2 + FY**2))
+
+    return ft(ft(E_in) * H)
+
+
+def propTF2(E_in, Lx_m, Ly_m, lambda_m, z_m):
+    """
+    Angular-spectrum Fresnel propagation — rectangular window.
+
+    Parameters
+    ----------
+    E_in : 2D array (Ny, Nx)
+        Input complex field.
+    Lx_m, Ly_m : float
+        Physical window sizes in x and y (metres).
+    lambda_m : float
+        Wavelength in metres.
+    z_m : float
+        Propagation distance in metres.
+
+    Returns
+    -------
+    E_out : 2D array
+        Output complex field at distance z_m.
+    """
+    Ny, Nx = E_in.shape
+    dx = Lx_m / Nx
+    dy = Ly_m / Ny
+
+    fx = np.fft.fftshift(np.fft.fftfreq(Nx, d=dx))
+    fy = np.fft.fftshift(np.fft.fftfreq(Ny, d=dy))
+    FX, FY = np.meshgrid(fx, fy)
+
+    H = np.exp(-1j * np.pi * lambda_m * z_m * (FX**2 + FY**2))
+
+    Uin = np.fft.fft2(np.fft.fftshift(E_in))
+    return np.fft.ifftshift(np.fft.ifft2(H * Uin))

topolino-0.1.0/topolino.egg-info/PKG-INFO

@@ -0,0 +1,30 @@
+Metadata-Version: 2.4
+Name: topolino
+Version: 0.1.0
+Summary: Fourier optics and wave propagation utilities
+Author-email: Rachel Migdal <rmigdal2007@gmail.com>
+License-Expression: MIT
+Project-URL: Repository, https://github.com/dream-beam/Topolino
+Keywords: fourier optics,wave propagation,physics,optics
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: scikit-image
+Provides-Extra: dev
+Requires-Dist: jupyter; extra == "dev"
+Requires-Dist: matplotlib; extra == "dev"
+Dynamic: license-file
+
+# Topolino
+ramigdal@lbl.gov, awojdyla@lbl.gov
+![Topolino](assets/topolino_logo.png)
+
+This repository is a Python toolkit for exploring paraxial wave propagation and related optical phenomena. At its core is a Fresnel propagator `propTF` that uses NumPy's FFT to propagate a complex field through space. The package includes routines for generating Gaussian beams, extracting the RMS beam radius from intensity moments, and directly comparing the numerical propagation to the analytical Gaussian‑beam law.
+A collection of Jupyter notebooks demonstrates a range of topics: a thin‑lens model, creation and propagation of spiral beams, diffraction patterns of transmission gratings, and a full grating‑experiment simulation that includes a light source, propagation to a grating, and observation of resulting orders. The notebooks expose parameters (wavelength , aperture size, grating period, vortex charge, ...), visualize results with 1‑D plots, RMS‑size versus distance curves, and 2‑D intensity maps, and provide side‑by‑side comparisons with analytical predictions where available.
+
+![Propagation](assets/propagation.png)

topolino-0.1.0/topolino.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE
+README.md
+pyproject.toml
+topolino/__init__.py
+topolino/analysis.py
+topolino/beam.py
+topolino/fourier.py
+topolino/propagation.py
+topolino.egg-info/PKG-INFO
+topolino.egg-info/SOURCES.txt
+topolino.egg-info/dependency_links.txt
+topolino.egg-info/requires.txt
+topolino.egg-info/top_level.txt

topolino-0.1.0/topolino.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

topolino-0.1.0/topolino.egg-info/requires.txt

@@ -0,0 +1,6 @@
+numpy
+scikit-image
+
+[dev]
+jupyter
+matplotlib

topolino-0.1.0/topolino.egg-info/top_level.txt

@@ -0,0 +1 @@
+topolino