pyextal.roi

Region of Interest (ROI) Management.

This module provides classes for defining, managing, and sampling Regions of Interest (ROIs) from experimental and simulated diffraction patterns. It includes base classes and specific implementations for Convergent Beam Electron Diffraction (CBED) and Large Angle Rocking Beam Electron Diffraction (LARBED).

The core functionalities include: - Defining ROIs with geometric shapes. - Generating sampling grids for both simulation and experiment. - Handling coordinate transformations (rotation, scaling, shifting). - Creating interpolation functions for experimental data. - Extracting intensity templates from experimental patterns.

Functions

pix2Tilt(param, pixsiz)	Converts a pixel displacement to a tilt vector in simulation units.
rotation(vec, theta)	Rotates a 2D vector by a given angle.
split_array_by_lengths(A, B[, axis])	Splits an array into subarrays of specified lengths.

Classes

BaseROI(dinfo, rotation, gx, gInclude)	Base class for defining and managing a Region of Interest (ROI).
CBEDROI(dinfo, rotation, gx, gInclude, ...)	A Region of Interest (ROI) class specifically for CBED patterns.
LARBEDROI(dinfo, rotation, gx, gInclude[, probe])	A Region of Interest (ROI) class specifically for LARBED patterns.
ROITYPE(value)	Enumeration for the type of Region of Interest.