xopto.mcml.mcdetector.radialpl module

class RadialPl(raxis: xopto.mcbase.mcutil.axis.Axis, plaxis: Optional[xopto.mcbase.mcutil.axis.Axis] = None, position: Tuple[float, float] = (0.0, 0.0), cosmin: float = 0.0, direction: Tuple[float, float, float] = (0.0, 0.0, 1.0))

Bases: xopto.mcml.mcdetector.base.Detector

Radial path-length reflectance-transmittance accumulator.

Parameters

• raxis (axis.Axis or axis.RadialAxis) – Object that defines the accumulators along the radial axis (this axis supports log-scale).

• plaxis (axis.Axis) – Object that defines the accumulators along the optical path length axis (this axis supports log-scale).

• position ((float, float)) – Position of the center of the radial accumulator.

• cosmin (float) – Cosine of the maximum acceptance angle (relative to the direction of the detector) of the accumulator.

• direction ((float, float, float)) – Reverence direction / orientation of the detector.

Note

The first dimension of the accumulator represents the optical path length axis, the second dimension represents the radial axis.

cl_declaration(mc: xopto.mcbase.mcobject.McObject) → str

Structure that defines the detector in the Monte Carlo simulator.

cl_implementation(mc: xopto.mcbase.mcobject.McObject) → str

Implementation of the detector accumulator in the Monte Carlo simulator.

cl_options(mc, target=None) → List[Tuple[str, str]]

OpenCL kernel options defined by this object.

cl_pack(mc: xopto.mcbase.mcobject.McObject, target: Optional[xopto.cl.cltypes.Structure] = None) → xopto.cl.cltypes.Structure

Fills the structure (target) with the data required by the Monte Carlo simulator. See the RadialPl.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

cltypes.Structure

static cl_type(mc: xopto.mcbase.mcobject.McObject) → xopto.cl.cltypes.Structure

property cosmin: Tuple[float, float]

Cosine of the maximum acceptance angle.

property direction: Tuple[float, float, float]

Detector reference direction.

static fromdict(data: dict) → xopto.mcml.mcdetector.radialpl.RadialPl

Create an accumulator instance from a dictionary.

Parameters

data (dict) – Dictionary created by the RadialPl.todict() method.

property normalized: numpy.ndarray

Normalized.

property npl

Number of accumulators in the optical pathlength axis.

property nr: int

Number of accumulators in the radial axis.

property pl

Centers of the optical pathlength axis accumulators.

property plaxis: xopto.mcbase.mcutil.axis.Axis

Path length axis object.

property pledges

Edges of the optical pathlength axis accumulators.

property position: Tuple[float, float]

Position of the radial accumulator as a tuple (x, y).

property r: numpy.ndarray

Centers of the radial axis accumulators.

property raxis: xopto.mcbase.mcutil.axis.Axis

Radial axis object.

property redges: numpy.ndarray

Edges of the radial axis accumulators.

property reflectance: numpy.ndarray

Reflectance.

property rlogscale: bool

Radial axis scale.

todict() → dict

Save the accumulator configuration without the accumulator data to a dictionary. Use the Radial.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.