Skip to content

Commit 7e5409f

Browse files
sdebionnesdebionne
committed
Merge branch '79-missing-doc-for-saving_statistics_log_enable' into 'master'
Resolve "Missing doc for saving_statistics_log_enable" Closes #79 See merge request limagroup/Lima-tango-python!128
2 parents e121437 + 26a542d commit 7e5409f

1 file changed

Lines changed: 51 additions & 55 deletions

File tree

‎doc/index.rst‎

Lines changed: 51 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -311,61 +311,57 @@ acc_hw_nb_buffers rw DevLong Number of buffers al
311311
Saving
312312
``````
313313

314-
=========================== ======= ======================= =======================================================================================
315-
Attribute name RW Type Description
316-
=========================== ======= ======================= =======================================================================================
317-
saving_mode rw DevString Saving mode:
318-
- **Manual**, no automatic saving, a command will
319-
be implemented in a next release to be able to
320-
save an acquired image.
321-
- **Auto_Frame**, Frames are automatically saved
322-
according the saving parameters (see below).
323-
- **Auto_header**, Frames are only saved when the
324-
setImageHeader() is called in order to set
325-
header information with image data.
326-
327-
saving_directory rw DevString The directory where to save the image files
328-
saving_prefix rw DevString The image file prefix
329-
saving_suffix rw DevString The image file suffix
330-
saving_next_number rw DevLong The image next number
331-
The full image file name is:
332-
/saving_directory/saving_prefix+sprintf("%04d",saving_next_number)+saving_suffix
333-
334-
saving_format rw DevString The data format for saving:
335-
- :code:`RAW`, save in binary format
336-
- :code:`EDF`, save in ESRF Data Format
337-
- :code:`EDFGZ` (or edf.gz), EDF with Deflate filter compression
338-
- :code:`EDFLZ4` (or edf.lz4), EDF with BS/LZ4 filter compression
339-
- :code:`TIFF`, The famous TIFF format
340-
- :code:`CBF`, save in CBF format (a compressed format for crystallography)
341-
- :code:`HDF5` save in Nexus HDF5 format
342-
- :code:`HDF5GZ` save in Nexus HDF5 format with Deflate filter compression
343-
- :code:`HDF5BS` save in Nexus HDF5 format with BS/LZ4 filter compression
344-
345-
346-
saving_overwrite_policy rw DevString In case of existing files an overwite policy is mandatory:
347-
- **Abort**, if the file exists the saving is aborted
348-
- **Overwrite**, if the file exists it is overwritten
349-
- **Append**, if the file exists the image is append to the file
350-
351-
saving_frame_per_file rw DevLong Number of frames saved in each file
352-
saving_common_header rw DevString[] Common header with multiple entries
353-
saving_header_delimiter rw DevString[] The header delimiters, [0] = key header delimiter, [1] = entry header delimiter,
354-
[2] = image number header delimiter.
355-
Default : [0] = "=", [1] = "\n", [2] = ";"
356-
saving_max_writing_task rw DevShort Set the max. tasks for saving file, default is 1
357-
saving_statistics ro DevDouble[] Return stats: saving speed, compression ratio,
358-
compression speed and incoming speed (speed in byte/s)
359-
saving_statistics_history rw DevLong Set size of history for stats calculation, default is 16 frames
360-
saving_managed_mode rw DevString On some detectors, saving can be managed by the hardware (sdk), you can switch
361-
the mode using these attribute values:
362-
- HARDWARE, lima will not manage the saving but set the camera to do the job
363-
- SOFTWARE, (default) Lima is managing the saving
364-
saving_every_n_frames rw DevLong if positive it does save frame every N frames, if negative it does NOT save every N
365-
frames, for instance -2 means frames 0,2,4.. are not saved
366-
saving_use_hw_comp rw DevBoolean Try to use the compressed image blob injected by the HW plugin (like the Dectris/Eiger)
367-
saving_zbuffer_<field> rw ... The allocation parameters for saving compression buffers
368-
=========================== ======= ======================= =======================================================================================
314+
============================ ======= ======================= =======================================================================================
315+
Attribute name RW Type Description
316+
============================ ======= ======================= =======================================================================================
317+
saving_mode rw DevString Saving mode:
318+
- **Manual**, no automatic saving, a command will
319+
be implemented in a next release to be able to
320+
save an acquired image.
321+
- **Auto_Frame**, Frames are automatically saved
322+
according the saving parameters (see below).
323+
- **Auto_header**, Frames are only saved when the
324+
setImageHeader() is called in order to set
325+
header information with image data.
326+
saving_directory rw DevString The directory where to save the image files
327+
saving_prefix rw DevString The image file prefix
328+
saving_suffix rw DevString The image file suffix
329+
saving_next_number rw DevLong The image next number
330+
The full image file path is:
331+
/saving_directory/saving_prefix+sprintf("%04d",saving_next_number)+saving_suffix
332+
saving_format rw DevString The data format for saving:
333+
- :code:`RAW`, save in binary format
334+
- :code:`EDF`, save in ESRF Data Format
335+
- :code:`EDFGZ` (or edf.gz), EDF with Deflate filter compression
336+
- :code:`EDFLZ4` (or edf.lz4), EDF with BS/LZ4 filter compression
337+
- :code:`TIFF`, The famous TIFF format
338+
- :code:`CBF`, save in CBF format (a compressed format for crystallography)
339+
- :code:`HDF5` save in Nexus HDF5 format
340+
- :code:`HDF5GZ` save in Nexus HDF5 format with Deflate filter compression
341+
- :code:`HDF5BS` save in Nexus HDF5 format with BS/LZ4 filter compression
342+
saving_overwrite_policy rw DevString In case of existing files an overwite policy is mandatory:
343+
- **Abort**, if the file exists the saving is aborted
344+
- **Overwrite**, if the file exists it is overwritten
345+
- **Append**, if the file exists the image is append to the file
346+
saving_frame_per_file rw DevLong Number of frames saved in each file
347+
saving_common_header rw DevString[] Common header with multiple entries
348+
saving_header_delimiter rw DevString[] The header delimiters, [0] = key header delimiter, [1] = entry header delimiter,
349+
[2] = image number header delimiter.
350+
Default : [0] = "=", [1] = "\n", [2] = ";"
351+
saving_max_writing_task rw DevShort Set the max. tasks for saving file, default is 1
352+
saving_statistics ro DevDouble[] Return stats: saving speed, compression ratio,
353+
compression speed and incoming speed (speed in byte/s)
354+
saving_statistics_history rw DevLong Set size of history for stats calculation, default is 16 frames
355+
saving_statistics_log_enable rw DevBoolean Enable the generation of the saving statistics log file
356+
saving_managed_mode rw DevString On some detectors, saving can be managed by the hardware (SDK), you can switch
357+
the mode using these attribute values:
358+
- HARDWARE, lima will not manage the saving but set the camera to do the job
359+
- SOFTWARE, (default) Lima is managing the saving
360+
saving_every_n_frames rw DevLong If positive it does save frame every N frames, if negative it does NOT save every N
361+
frames, for instance -2 means frames 0,2,4.. are not saved
362+
saving_use_hw_comp rw DevBoolean Try to use the compressed image blob injected by the HW plugin (like the Dectris/Eiger)
363+
saving_zbuffer_<field> rw ... The allocation parameters for saving compression buffers
364+
============================ ======= ======================= =======================================================================================
369365

370366
Image
371367
`````

0 commit comments

Comments
 (0)