From 49b323c4563bba288f806595efcc533d331afbf5 Mon Sep 17 00:00:00 2001 From: steppke_a Date: Mon, 24 Oct 2022 19:41:10 +0000 Subject: [PATCH] Extended ROI documentation --- src/cristallina/utils.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/cristallina/utils.py b/src/cristallina/utils.py index a8574f2..d9dfb4c 100644 --- a/src/cristallina/utils.py +++ b/src/cristallina/utils.py @@ -137,9 +137,13 @@ def process_run(run_number, rois,detector='JF16T03V01', calculate =None, only_sh Parallel(n_jobs=n_jobs,verbose=10)(delayed(process_step)(i) for i in range(len(scan))) class ROI: - """Definition of region of interest (ROI) in image coordinates. + """Definition of region of interest (ROI) in image coordinates. + (For images from detector as 2d array with convention bottom == 0th row, left == 0th column). - Example: ROI(left=10, right=20, bottom=100, top=200) + Examples: + - ROI(left=10, right=20, bottom=100, top=200) + - ROI(center_x=15, width=10, center_y=150, height=100, name='peak 1') + """ def __init__(