Scatterers

class Sphere(*, source, diameter, property, medium_property)

Bases: 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 properties 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 (Quantity) – Diameter(s) of the spherical scatterers in meters.

• property (List[BaseMaterial] | List[Quantity]) – Refractive index or indices of the spherical scatterers themselves.

• medium_property (List, optional) – BaseMaterial(s) defining the medium, used if medium_index is not provided.

attributes = ['diameter', 'property', 'medium_property']

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']

binding = None

binding_kwargs = None

classmethod build_sequential(total_size=None, **kwargs)

Broadcast scalar or single-element parameters to NumPy arrays of uniform length and construct a new instance of the class.

Each parameter passed via keyword arguments may be provided as a scalar or as a list/array. Scalars or single-element lists/arrays will be repeated to match the length of the longest parameter. If any parameter is given as a list/array with more than one element, its length must equal the maximum length among all parameters (or the explicit total_size if provided); otherwise, a ValueError is raised.

Additionally, if a keyword argument ‘source’ is provided, it is removed from the broadcasted parameters and passed directly to the class constructor.

Parameters:

• total_size (int, optional) – The explicit target size for broadcasting. Must be a positive integer if provided. If not specified, the target size is determined by the maximum size among the input parameters.

• **kwargs (dict) – Arbitrary keyword arguments mapping parameter names to values. Each value may be a scalar or a list/array of values. Examples include parameters such as source, diameter, property, or medium_property.

Returns:

A new instance of the class with all provided parameters broadcasted as NumPy arrays of equal length. If ‘source’ is provided, it is passed directly to the class constructor.

Return type:

object

Raises:

ValueError – If any parameter provided as a list/array has a length greater than one that does not match the target size.

diameter: Quantity

is_sequential = False

mapping = None

medium_property: List[BaseMaterial] | List[Quantity]

property: List[BaseMaterial] | List[Quantity]

source: BaseSource

class Cylinder(*, source, diameter, property, medium_property)

Bases: BaseScatterer, Sequential

Represents a cylindrical scatterer configuration for PyMieSim simulations.

Parameters:

• source (PyMieSim.experiment.source.base.BaseSource) – Light source configuration for the simulation.

• diameter (Quantity) – Diameter(s) of the cylinder in meters.

• property (List[BaseMaterial] | List[Quantity]) – Refractive index or indices of the spherical scatterers themselves.

• medium_property (List[BaseMaterial] | List[Quantity]) – BaseMaterial(s) defining the medium, used if medium_index is not provided.

attributes = ['diameter', 'property', 'medium_property']

available_measure_list = ['Qsca', 'Qext', 'Qabs', 'Csca', 'Cext', 'Cabs', 'a11', 'a21', 'a12', 'a22', 'a13', 'a23', 'b11', 'b21', 'b12', 'b22', 'b13', 'b23', 'coupling']

binding = None

binding_kwargs = None

classmethod build_sequential(total_size=None, **kwargs)

Broadcast scalar or single-element parameters to NumPy arrays of uniform length and construct a new instance of the class.

Each parameter passed via keyword arguments may be provided as a scalar or as a list/array. Scalars or single-element lists/arrays will be repeated to match the length of the longest parameter. If any parameter is given as a list/array with more than one element, its length must equal the maximum length among all parameters (or the explicit total_size if provided); otherwise, a ValueError is raised.

Additionally, if a keyword argument ‘source’ is provided, it is removed from the broadcasted parameters and passed directly to the class constructor.

Parameters:

• total_size (int, optional) – The explicit target size for broadcasting. Must be a positive integer if provided. If not specified, the target size is determined by the maximum size among the input parameters.

• **kwargs (dict) – Arbitrary keyword arguments mapping parameter names to values. Each value may be a scalar or a list/array of values. Examples include parameters such as source, diameter, property, or medium_property.

Returns:

A new instance of the class with all provided parameters broadcasted as NumPy arrays of equal length. If ‘source’ is provided, it is passed directly to the class constructor.

Return type:

object

Raises:

ValueError – If any parameter provided as a list/array has a length greater than one that does not match the target size.

diameter: Quantity

is_sequential = False

mapping = None

medium_property: List[BaseMaterial] | List[Quantity]

property: List[BaseMaterial] | List[Quantity]

source: BaseSource

class CoreShell(*, source, core_diameter, shell_thickness, core_property, shell_property, medium_property)

Bases: BaseScatterer, Sequential

A data class representing a core-shell scatterer configuration used in PyMieSim simulations.

This class facilitates the setup and manipulation of core-shell scatterers by providing structured attributes and methods that ensure the scatterers are configured correctly for simulations. It extends the BaseScatterer class, adding specific attributes and methods relevant to core-shell geometries.

Parameters:

• source (PyMieSim.experiment.source.base.BaseSource) – Light source configuration for the simulation.

• core_diameter (Quantity) – Diameters of the core components.

• shell_thickness (Quantity) – Thicknesses of the shell components.

• core_property (List[BaseMaterial] | List[Quantity]) – Refractive index or indices of the core.

• shell_property (List[BaseMaterial] | List[Quantity]) – Refractive index or indices of the shell.

• medium_property (List[BaseMaterial] | List[Quantity]) – BaseMaterial(s) defining the medium, used if medium_index is not provided.

attributes = ['core_diameter', 'shell_thickness', 'core_property', 'shell_property', 'medium_property']

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']

binding = None

binding_kwargs = None

classmethod build_sequential(total_size=None, **kwargs)

Broadcast scalar or single-element parameters to NumPy arrays of uniform length and construct a new instance of the class.

Each parameter passed via keyword arguments may be provided as a scalar or as a list/array. Scalars or single-element lists/arrays will be repeated to match the length of the longest parameter. If any parameter is given as a list/array with more than one element, its length must equal the maximum length among all parameters (or the explicit total_size if provided); otherwise, a ValueError is raised.

Additionally, if a keyword argument ‘source’ is provided, it is removed from the broadcasted parameters and passed directly to the class constructor.

Parameters:

• total_size (int, optional) – The explicit target size for broadcasting. Must be a positive integer if provided. If not specified, the target size is determined by the maximum size among the input parameters.

• **kwargs (dict) – Arbitrary keyword arguments mapping parameter names to values. Each value may be a scalar or a list/array of values. Examples include parameters such as source, diameter, property, or medium_property.

Returns:

A new instance of the class with all provided parameters broadcasted as NumPy arrays of equal length. If ‘source’ is provided, it is passed directly to the class constructor.

Return type:

object

Raises:

ValueError – If any parameter provided as a list/array has a length greater than one that does not match the target size.

core_diameter: Quantity

core_property: List[BaseMaterial] | List[Quantity]

is_sequential = False

mapping = None

medium_property: List[BaseMaterial] | List[Quantity]

shell_property: List[BaseMaterial] | List[Quantity]

shell_thickness: Quantity

source: BaseSource