xopto.mcml.mcdetector.probe.fiberarray module¶
- class FiberArray(fibers: List[xopto.mcbase.mcutil.fiber.FiberLayout])[source]¶
Bases:
xopto.mcml.mcdetector.base.Detector
Optical fiber probe detector with an array of optical fibers that are optionally tilted(direction parameter). The optical fibers are always polished in a way that forms a tight optical contact with the surface of the sample.
- Parameters
fiber (List[FiberLayout]) – List of optical fiber configuration that form the fiber array.
- cl_declaration(mc: xopto.mcbase.mcobject.McObject) → str[source]¶
Structure that defines the detector in the Monte Carlo simulator.
- cl_implementation(mc: xopto.mcbase.mcobject.McObject) → str[source]¶
Implementation of the detector in the Monte Carlo simulator.
- cl_pack(mc: xopto.mcbase.mcobject.McObject, target: Optional[xopto.cl.cltypes.Structure] = None) → xopto.cl.cltypes.Structure[source]¶
Fills the structure (target) with the data required by the Monte Carlo simulator. See the
FiberArray.cl_type()
method for a detailed list of fields.- Parameters
mc (mcobject.McObject) – Monte Carlo simulator instance.
target (cltypes.Structure) – Ctypes structure that is filled with the source data.
- Returns
target – Filled structure received as an input argument or a new instance if the input argument target is None.
- Return type
- fiber_position(index: int) → Tuple[float, float][source]¶
Returns the position of the fiber center as a tuple (x, y).
- Parameters
index (int) – Fiber index from 0 to n -1.
- Returns
position – The position of the fiber center as a tuple (x, y).
- Return type
(float, float)
- property fibers: List[xopto.mcbase.mcutil.fiber.FiberLayout]¶
List of optical fibers.
- static fromdict(data)[source]¶
Create an accumulator instance from a dictionary.
- Parameters
data (dict) – Dictionary created by the
FiberArray.todict()
method.
- property n: int¶
Number of optical fiber in the array.
- property normalized: numpy.ndarray¶
Normalized.
- property reflectance: numpy.ndarray¶
Reflectance.
- todict()[source]¶
Save the accumulator configuration without the accumulator data to a dictionary. Use the
FiberArray.fromdict()
method to create a new accumulator instance from the returned data.- Returns
data – Accumulator configuration as a dictionary.
- Return type
dict
- property transmittance: numpy.ndarray¶
Transmittance.
- update(other: xopto.mcml.mcdetector.probe.fiberarray.FiberArray)[source]¶
Update this detector configuration from the other detector. The other detector must be of the same type as this detector or a dict with appropriate fields.
- Parameters
other (FiberArray or dict) – This source is updated with the configuration of the other source.