set_ROI_mesh#

VirtualImageGenerator.set_ROI_mesh(vector1_norm, vector2_norm, vector_norm_max, angle=0.0, shear=0.0, ROI_radius=None)[source]#

Set and display a mesh of ROI in the signal space. The ROIs are stored in the roi_list attribute and will be by the get_virtual_images_from_mesh method.

Parameters:

vector1_norm, vector2_norm (float) – The norm of one of the two vectors of the mesh. The position of the other vector is defined by the shear parameter.
vector_norm_max (float) – The maximum value for the norm of each vector.
angle (float, optional) – The rotation of the mesh in degree.
shear (float, optional) – The shear of the mesh. It must be in the interval [0, 1]. The default is 0.0.
ROI_radius (None or float, optional) – The radius of the ROI. If None, half of the minimum value between vector1_norm and vector1_norm is used. The default is None.

Return type:

None.