Skip to content

Commit 7bbc124

Browse files
sdebionnevallsv
authored andcommitted
Document image_bin_mode attribute
1 parent 28afb48 commit 7bbc124

1 file changed

Lines changed: 21 additions & 18 deletions

File tree

doc/index.rst

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -369,24 +369,27 @@ saving_zbuffer_<field> rw ... The allocation parameters for saving
369369

370370
Image
371371
`````
372-
=========================== ======= ======================= =======================================================================================
373-
Attribute name RW Type Description
374-
=========================== ======= ======================= =======================================================================================
375-
image_type ro DevString Return the current image data type, bit per pixel signed or unsigned:
376-
- Bpp8, Bpp8S, Bpp10, Bpp10S, Bpp12, Bpp12S, Bpp14,
377-
- Bpp14S, Bpp16, Bpp16S, Bpp32, Bpp32S , Bpp32F.
378-
image_width ro DevLong Width size of the detector in pixel
379-
image_height ro DevLong Height size of the detector in pixel
380-
image_sizes ro DevULong[4] Signed(0-unsigned,1-signed), depth(nb bytes), width and height
381-
image_max_dim ro DevULong[2] Maximum image dimension, width and height in pixel
382-
image_roi rw DevLong[4] Region Of Interest on image, [0] = Begin X, [1] = Begin Y,
383-
[2] = Width, [3] = Height, default ROI is [0,0,0,0] (no ROI)
384-
image_bin rw DevLong[2] Binning on image, [0] = Binning factor on X, [1] =
385-
Binning factor on Y. Default binning is 1 x 1
386-
image_flip rw DevBoolean[2] Flip on the image, [0] = flip over X axis, [1] flip over Y
387-
axis. Default flip is False x False
388-
image_rotation rw DevString Rotate the image: "0", "90", "180" or "270"
389-
=========================== ======= ======================= =======================================================================================
372+
======================= ======= ======================= =======================================================================================
373+
Attribute name RW Type Description
374+
======================= ======= ======================= =======================================================================================
375+
image_type ro DevString Return the current image data type, bit per pixel signed or unsigned:
376+
- Bpp8, Bpp8S, Bpp10, Bpp10S, Bpp12, Bpp12S, Bpp14,
377+
- Bpp14S, Bpp16, Bpp16S, Bpp32, Bpp32S , Bpp32F.
378+
image_width ro DevLong Width size of the detector in pixel
379+
image_height ro DevLong Height size of the detector in pixel
380+
image_sizes ro DevULong[4] Signed(0-unsigned,1-signed), depth(nb bytes), width and height
381+
image_max_dim ro DevULong[2] Maximum image dimension, width and height in pixel
382+
image_roi rw DevLong[4] Region Of Interest on image, [0] = Begin X, [1] = Begin Y,
383+
[2] = Width, [3] = Height, default ROI is [0,0,0,0] (no ROI)
384+
image_bin rw DevLong[2] Binning on image, [0] = Binning factor on X, [1] =
385+
Binning factor on Y. Default binning is 1 x 1
386+
image_bin_mode rw DevString Set the operation applied to each bins over the accumulated pixels
387+
- **SUM** returns the sum of the pixel intensities (Default)
388+
- **MEAN** returns the arithmetic mean of the pixel intensities
389+
image_flip rw DevBoolean[2] Flip on the image, [0] = flip over X axis, [1] flip over Y
390+
axis. Default flip is False x False
391+
image_rotation rw DevString Rotate the image: "0", "90", "180" or "270"
392+
======================= ======= ======================= =======================================================================================
390393

391394
Shutter
392395
```````

0 commit comments

Comments
 (0)