Source code for PyMieSim.experiment.scatterer.sphere

#!/usr/bin/env python
# -*- coding: utf-8 -*-
from typing import List
import numpy as np
from PyOptik.material.base_class import BaseMaterial

from PyMieSim.units import Length, RefractiveIndex
from PyMieSim.binary.interface_experiment import SphereSet
from PyMieSim.experiment.scatterer.base import BaseScatterer
from PyMieSim.experiment.source.base import BaseSource
from PyMieSim.experiment.utils import Sequential



class Sphere(BaseScatterer, Sequential):
    """
    A data class that represents a spherical scatterer configuration used in PyMieSim simulations.

    This class provides specific implementations for setting up and binding spherical scatterers
    with their refractive_index to a simulation environment. It extends the `BaseScatterer` class by
    adding spherical-specific attributes and methods for handling simulation setups.

    Parameters
    ----------
    source : PyMieSim.experiment.source.base.BaseSource
        Light source configuration for the simulation.
    diameter : Length
        Diameter(s) of the spherical scatterers in meters.
    refractive_index : List[BaseMaterial] | List[RefractiveIndex]
        Refractive index or indices of the spherical scatterers themselves.
    medium_refractive_index : List, optional
        BaseMaterial(s) defining the medium, used if `medium_index` is not provided.
    """
    available_measure_list = [
        "Qsca",
        "Qext",
        "Qabs",
        "Qratio",
        "Qforward",
        "Qback",
        "Qpr",
        "Csca",
        "Cext",
        "Cabs",
        "Cratio",
        "Cforward",
        "Cback",
        "Cpr",
        "a1",
        "a2",
        "a3",
        "b1",
        "b2",
        "b3",
        "g",
        "coupling",
    ]

    attributes = ["diameter", "refractive_index", "medium_refractive_index"]

    def __init__(
        self,
        source: BaseSource,
        diameter: Length,
        refractive_index: List[BaseMaterial] | List[RefractiveIndex],
        medium_refractive_index: List[BaseMaterial] | List[RefractiveIndex]
    ):
        self.source = source

        self.diameter = np.atleast_1d(diameter)
        self.refractive_index = np.atleast_1d(refractive_index)
        self.medium_refractive_index = np.atleast_1d(medium_refractive_index)

        medium_refractive_index = self._add_refractive_index(
            name="medium", refractive_index=self.medium_refractive_index
        )

        refractive_index = self._add_refractive_index(
            name="scatterer", refractive_index=self.refractive_index
        )

        self.binding_kwargs = dict(
            diameter=self.diameter,
            is_sequential=self.is_sequential,
            medium_refractive_index=medium_refractive_index,
            refractive_index=refractive_index,
        )

        self.set = SphereSet(**self.binding_kwargs)