ess.reduce.live.raw.project_onto_cylinder#

ess.reduce.live.raw.project_onto_cylinder(position, *, axis='z', radius=None)[source]#

Project positions onto the mantle of an axis-aligned cylinder.

This is useful for cylindrical detectors. The cylinder axis is one of the coordinate axes; for axis='z' the cylinder is aligned along the beam.

Parameters:

position (Variable) – Positions to project.
axis (Literal['x', 'y', 'z'], default: 'z') – Coordinate axis the cylinder is aligned with. phi is measured in the perpendicular plane, increasing right-handed about axis.
radius (Variable | None, default: None) – Radius of the cylinder. If None, the minimum radius of the positions is used.

Return type:

dict[str, Variable]