Files
Jungfraujoch/docs/python_client/docs/ImageBufferStatus.md
leonarski_f f3e0a15d26
All checks were successful
Build Packages / build:rpm (rocky8_nocuda) (push) Successful in 10m51s
Build Packages / build:rpm (ubuntu2404_nocuda) (push) Successful in 8m0s
Build Packages / build:rpm (ubuntu2204_nocuda) (push) Successful in 9m6s
Build Packages / build:rpm (rocky9_nocuda) (push) Successful in 10m7s
Build Packages / build:rpm (rocky8_sls9) (push) Successful in 9m47s
Build Packages / Generate python client (push) Successful in 29s
Build Packages / Build documentation (push) Successful in 43s
Build Packages / Create release (push) Has been skipped
Build Packages / build:rpm (rocky9_sls9) (push) Successful in 10m46s
Build Packages / build:rpm (rocky8) (push) Successful in 9m33s
Build Packages / Unit tests (push) Has been skipped
Build Packages / build:rpm (ubuntu2204) (push) Successful in 8m47s
Build Packages / build:rpm (rocky9) (push) Successful in 9m55s
Build Packages / build:rpm (ubuntu2404) (push) Successful in 9m4s
v1.0.0-rc.127 (#34)
This is an UNSTABLE release. The release has significant modifications and bug fixes, if things go wrong, it is better to revert to 1.0.0-rc.124.

* jfjoch_broker: Default EIGER readout time is 20 microseconds
* jfjoch_broker: Multiple improvements regarding performance
* jfjoch_broker: Image buffer allows to track frames in preparation and sending
* jfjoch_broker: Dedicated thread for ZeroMQ transmission to better utilize the image buffer
* jfjoch_broker: Experimental implementation of transmission with raw TCP/IP sockets
* jfjoch_writer: Fixes regarding properly closing files in long data collections
* jfjoch_process: Scale & merge has been significantly improved, but it is not yet integrated into mainstream code

Reviewed-on: #34
2026-03-02 15:57:12 +01:00

1.9 KiB

ImageBufferStatus

Properties

Name Type Description Notes
min_image_number int Smallest image number available in the buffer
max_image_number int Largest image number available in the buffer
image_numbers List[int] Image numbers currently present in the buffer.
total_slots int Number of slots in the image buffer. This number, compared to number of images in data collection and frame rate will determine "retention" rate of the image buffer.
available_slots int Slots available for the data collection
in_preparation_slots int Number of slots in the image buffer that are currently in preparation for sending.
in_sending_slots int Number of slots in the image buffer that are currently sending/writing data.
current_counter int Counter of changes in the image buffer - either new start message or new image added. For optimization one can only load new images/datasets from the HTTP if this value changes. Counter is optional as it was not implemented in older versions to avoid breaking change [optional]

Example

from jfjoch_client.models.image_buffer_status import ImageBufferStatus

# TODO update the JSON string below
json = "{}"
# create an instance of ImageBufferStatus from a JSON string
image_buffer_status_instance = ImageBufferStatus.from_json(json)
# print the JSON string representation of the object
print(ImageBufferStatus.to_json())

# convert the object into a dict
image_buffer_status_dict = image_buffer_status_instance.to_dict()
# create an instance of ImageBufferStatus from a dict
image_buffer_status_from_dict = ImageBufferStatus.from_dict(image_buffer_status_dict)

[Back to Model list] [Back to API list] [Back to README]