LineROI#
xrdimageutil.roi.LineROI#
The LineROI class provides a 1D line segment region that can be applied
to 3D datasets. Users can define the coordinate enpoints for the region, define a
calculation to be carried out on the selected region, and then apply the ROI
to multple datasets. This tool is scriptable, and the region endpoints/calculation
can be modified at any point.
In the Image GUI widget (refer to the Viewing Image Data tutorial),
there is a graphical version of the LineROI object that is built on the backend
class, but it does not provide the same scriptability, only being available for single
datasets at a time.
Attributes#
- xrdimageutil.roi.LineROI.endpoints: dict#
Coordinate endpoints for line segment.
- xrdimageutil.roi.LineROI.calculation: dict#
Output calculation and the dims to calculate across.
- xrdimageutil.roi.LineROI.output: dict#
Output data and coordinates.
Functions#
- xrdimageutil.roi.LineROI.__init__(self, dims: list = None)#
- xrdimageutil.roi.LineROI.set_endpoints(self, endpoint_A: dict, endpoint_B: dict)#
- xrdimageutil.roi.LineROI.set_calculation(self, output: str, dims: list)#
- xrdimageutil.roi.LineROI.apply(self, data, coords)#
- xrdimageutil.roi.LineROI.apply_to_scan(self, scan, data_type)#
- xrdimageutil.roi.LineROI.get_output(self)#