Detectors#

class Photodiode(NA, gamma_offset, phi_offset, cache_NA=<Quantity([0.], 'dimensionless')>, sampling=<Quantity([200], 'dimensionless')>, polarization_filter=<Quantity([nan], 'degree')>, mode_number=<factory>, rotation=<Quantity([0], 'degree')>)[source]#

Bases: BaseDetector, Sequential

Photodiode detector tailored for Mie scattering simulations, extending BaseDetector with specific features.

Parameters:

  • NA (Union[List[float], float]) – Numerical aperture(s) of the detector.

  • gamma_offset (Quantity) – Gamma angular offset (in degrees).

  • phi_offset (Quantity) – Phi angular offset (in degrees).

  • polarization_filter (Optional[Quantity]) – Polarization filter angle (in degrees).

  • sampling (Union[List[int], int]) – Sampling rate(s) for the detector.

  • mean_coupling (bool) – Whether mean coupling is used. Defaults to True.

  • rotation (Quantity) – Rotation angle of the detector. Defaults to 0 degrees.

  • coherent (bool) – Indicates if the detection is coherent. Defaults to False.

  • mode_number (str) – Mode number of the detector. Defaults to ‘NC00’.

  • cache_NA (Quantity)

NA: Quantity#
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.

cache_NA: Quantity = <Quantity([0.], 'dimensionless')>#
coherent: bool = False#
gamma_offset: Quantity#
is_sequential = False#
mean_coupling: bool = False#
mode_number: Tuple[str]#
phi_offset: Quantity#
polarization_filter: Quantity | None = <Quantity([nan], 'degree')>#
rotation: Quantity = <Quantity([0], 'degree')>#
sampling: Quantity | None = <Quantity([200], 'dimensionless')>#
classmethod validate_angle_quantity(value)#

Ensures that angular quantities (gamma_offset, phi_offset, rotation) are correctly formatted as Quantities with angle units.

Parameters:

value (Any) – The input value for the angle.

Returns:

A NumPy array containing the validated and converted angle value.

Return type:

numpy.ndarray

classmethod validate_au_quantity(value)#

Ensures that numerical values such as numerical aperture (NA) and sampling rate are correctly cast into NumPy arrays.

Parameters:

value (Any) – The input value to be validated.

Returns:

A NumPy array representing the validated input value.

Return type:

numpy.ndarray

classmethod validate_polarization(value)#

Validates the polarization filter. If not provided, defaults to NaN degrees. Ensures the value has angular units (degree or radian).

Parameters:

value (Any) – The input value for polarization filter.

Returns:

A NumPy array containing the validated and converted polarization filter value.

Return type:

numpy.ndarray

class CoherentMode(mode_number, NA, gamma_offset, phi_offset, rotation, mean_coupling=False, coherent=True, cache_NA=<Quantity([0.], 'dimensionless')>, sampling=<Quantity([200], 'dimensionless')>, polarization_filter=<Quantity([nan], 'degree')>)[source]#

Bases: BaseDetector, Sequential

Coherent mode detector for Mie scattering simulations, handling coherent detection modes.

This detector is designed specifically for coherent modes, such as LP, HG, LG, and NC modes, which require specific handling in Mie scattering experiments.

Parameters:

  • mode_number (Union[List[str], str]) – Mode number(s) involved in the detection.

  • NA (Union[List[float], float]) – Numerical aperture(s) of the detector.

  • gamma_offset (Quantity) – Gamma angular offset (in degrees).

  • phi_offset (Quantity) – Phi angular offset (in degrees).

  • rotation (Quantity) – Rotation angle of the detector.

  • sampling (Union[List[int], int]) – Sampling rate(s) for the detector.

  • polarization_filter (Optional[Quantity]) – Polarization filter angle (in degrees).

  • mean_coupling (Optional[bool]) – Whether mean coupling is used. Defaults to False.

  • coherent (bool) – Specifies if the detection is coherent. Defaults to True.

  • cache_NA (Quantity)

NA: Quantity#
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.

cache_NA: Quantity = <Quantity([0.], 'dimensionless')>#
coherent: bool = True#
gamma_offset: Quantity#
is_sequential = False#
mean_coupling: bool | None = False#
mode_number: List[str] | str#
phi_offset: Quantity#
polarization_filter: Quantity | None = <Quantity([nan], 'degree')>#
rotation: Quantity#
sampling: Quantity | None = <Quantity([200], 'dimensionless')>#
classmethod validate_angle_quantity(value)#

Ensures that angular quantities (gamma_offset, phi_offset, rotation) are correctly formatted as Quantities with angle units.

Parameters:

value (Any) – The input value for the angle.

Returns:

A NumPy array containing the validated and converted angle value.

Return type:

numpy.ndarray

classmethod validate_au_quantity(value)#

Ensures that numerical values such as numerical aperture (NA) and sampling rate are correctly cast into NumPy arrays.

Parameters:

value (Any) – The input value to be validated.

Returns:

A NumPy array representing the validated input value.

Return type:

numpy.ndarray

classmethod validate_polarization(value)#

Validates the polarization filter. If not provided, defaults to NaN degrees. Ensures the value has angular units (degree or radian).

Parameters:

value (Any) – The input value for polarization filter.

Returns:

A NumPy array containing the validated and converted polarization filter value.

Return type:

numpy.ndarray