File spot_diagram.py has 470 lines of code (exceeds 250 allowed). Consider refactoring.

Open

"""Spot Diagram Analysis
 
This module provides a spot diagram analysis for optical systems.
 
Kramer Harrison, 2024

File wavefront.py has 417 lines of code (exceeds 250 allowed). Consider refactoring.

Open

"""Wavefront Module
 
This module defines the `Wavefront` class, which is designed to analyze the
wavefront of an optical system. It supports the evaluation of wavefront
aberrations using Zernike polynomials, the generation of wavefront maps for

File optic.py has 395 lines of code (exceeds 250 allowed). Consider refactoring.

Open

"""Optic Module
 
This is the core module of Optiland, which provides the class to define
generic optical systems. The Optic class encapsulates the core properties
of an optical system, such as the aperture, fields, surfaces, and

File zemax_handler.py has 382 lines of code (exceeds 250 allowed). Consider refactoring.

Open

"""Zemax File Handler
 
This module provides functionality for reading Zemax files and converting the
data into Optiland Optic instances. The `load_zemax_file` function can be used
to load a Zemax file and return an Optiland Optic object.

Optic has 33 functions (exceeds 20 allowed). Consider refactoring.

Open

class Optic:
    """The Optic class represents an optical system.
 
    Attributes:
        aperture (Aperture): The aperture of the optical system.

ZemaxFileReader has 30 functions (exceeds 20 allowed). Consider refactoring.

Open

class ZemaxFileReader:
    """A class for reading Zemax files and extracting optical data.
 
    Args:
        source (str): The source of the .zmx file, either a filename or a URL.

SurfaceGroup has 28 functions (exceeds 20 allowed). Consider refactoring.

Open

class SurfaceGroup:
    """Represents a group of surfaces in an optical system.
 
    Attributes:
        surfaces (list): List of surfaces in the group.

File mtf.py has 292 lines of code (exceeds 250 allowed). Consider refactoring.

Open

"""Modulation Transfer Function (MTF) Module
 
This module provides various classes for the computation of the modulation
transfer function (MTF) of an optical system.
 
 

File material_file.py has 292 lines of code (exceeds 250 allowed). Consider refactoring.

Open

"""Material File
 
This module contains a class for representing a material based on a material
YAML file from the refractiveindex.info database.
 
 

File zernike.py has 289 lines of code (exceeds 250 allowed). Consider refactoring.

Open

"""Zernike Geometry
 
The Zernike polynomial geometry represents a surface defined by a Zernike
polynomial in two dimensions. The surface is defined as:
 
 

AberrationOperand has 25 functions (exceeds 20 allowed). Consider refactoring.

Open

class AberrationOperand:
    """A class that provides methods to calculate various aberration values for
        an optic.
 
    Methods:

File coatings.py has 277 lines of code (exceeds 250 allowed). Consider refactoring.

Open

"""Coatings Module
 
The coatings module contains classes for modeling optical coatings.
 
Kramer Harrison, 2024

Function generate_database has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.

Open

def generate_database(output_file):
    # load the catalog
    filename = "catalog-nk.yml"
 
    with open(filename, encoding="utf-8") as file:

• Read up
  Read up

File ray.py has 264 lines of code (exceeds 250 allowed). Consider refactoring.

Open

"""Ray Operands Module
 
This module provides a class that calculates various ray tracing values for an
optical system. It is used in conjunction with the optimization module to
optimize optical systems.

File surface_group.py has 264 lines of code (exceeds 250 allowed). Consider refactoring.

Open

"""Surface Group
 
This module contains the SurfaceGroup class, which represents a group of
surfaces in an optical system. The SurfaceGroup class provides methods for
tracing rays through the surfaces, adding and removing surfaces, and

File lens.py has 262 lines of code (exceeds 250 allowed). Consider refactoring.

Open

"""Lens Visualization Module
 
This module contains classes for visualizing lenses in 2D and 3D.
 
Kramer Harrison, 2024

Function _generate_indices has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.

Open

    def _generate_indices():
        """Generate the indices for the Zernike terms.
 
        Returns:
            list: List of tuples representing the indices (n, m) of the

• Read up
  Read up

Paraxial has 21 functions (exceeds 20 allowed). Consider refactoring.

Open

class Paraxial:
    """A class representing a paraxial optical system.
 
    This class provides methods to calculate various properties of the optical
    system, such as focal lengths, entrance pupil location, exit pupil

Function plot has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.

Open

    def plot(
        self,
        ax,
        fields="all",
        wavelengths="primary",

• Read up
  Read up

Function _read_file has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.

Open

    def _read_file(self):
        """Reads the Zemax file and extracts the optical data."""
        encodings = ["utf-16", "utf-8", "iso-8859-1"]
        success = False
        for encoding in encodings:

• Read up
  Read up