Files
Jungfraujoch/docs/python_client/docs/MeasurementStatistics.md
Filip Leonarski 64002f1e29
Some checks failed
Build Packages / build:rpm (rocky8_nocuda) (push) Successful in 11m14s
Build Packages / build:rpm (ubuntu2204_nocuda) (push) Successful in 10m43s
Build Packages / build:rpm (rocky9_nocuda) (push) Successful in 11m35s
Build Packages / build:rpm (ubuntu2404_nocuda) (push) Successful in 9m20s
Build Packages / build:rpm (rocky8_sls9) (push) Successful in 10m23s
Build Packages / Generate python client (push) Successful in 39s
Build Packages / build:rpm (rocky9_sls9) (push) Successful in 11m24s
Build Packages / Create release (push) Has been skipped
Build Packages / Build documentation (push) Successful in 1m0s
Build Packages / build:rpm (rocky8) (push) Successful in 10m35s
Build Packages / build:rpm (ubuntu2204) (push) Successful in 10m35s
Build Packages / build:rpm (rocky9) (push) Successful in 11m17s
Build Packages / build:rpm (ubuntu2404) (push) Successful in 9m9s
Build Packages / Unit tests (push) Failing after 1h18m57s
v1.0.0-rc.129 (#36)
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: Significant improvements in TCP image socket, as a viable alternative for ZeroMQ sockets (only a single port on broker side, dynamically change number of writers, acknowledgments for written files)
* jfjoch_broker: Delta phi is calculated also for still data in Bragg prediction
* jfjoch_broker: Image pusher statistics are accessible via the REST interface
* jfjoch_writer: Supports TCP image socket and for these auto-forking option

Reviewed-on: #36
Co-authored-by: Filip Leonarski <filip.leonarski@psi.ch>
Co-committed-by: Filip Leonarski <filip.leonarski@psi.ch>
2026-03-05 22:13:12 +01:00

3.1 KiB

MeasurementStatistics

Properties

Name Type Description Notes
file_prefix str [optional]
run_number int Number of data collection run. This can be either automatically incremented or provided externally for each data collection. [optional]
experiment_group str Name of group owning the data (e.g. p-group or proposal number). [optional]
images_expected int [optional]
images_collected int Images collected by the receiver. This number will be lower than images expected if there were issues with data collection performance. [optional]
images_sent int Images sent to the writer. The value does not include images discarded by lossy compression filter and images not forwarded due to full ZeroMQ queue. [optional]
images_written int Images successfully written to disk. The value is live updated for TCP/IP socket and direct HDF5 writer, while for ZeroMQ it is only updated at the end of experiment. [optional]
images_discarded_lossy_compression int Images discarded by the lossy compression filter [optional]
max_image_number_sent int [optional]
collection_efficiency float [optional]
compression_ratio float [optional]
cancelled bool [optional]
max_receiver_delay int [optional]
indexing_rate float [optional]
detector_width int [optional]
detector_height int [optional]
detector_pixel_depth int [optional]
bkg_estimate float [optional]
unit_cell str [optional]
error_pixels float Moving average of 1000 images counting number of error pixels on the detector [optional]
saturated_pixels float Moving average of 1000 images counting number of saturated pixels on the detector [optional]
roi_beam_pixels float If there is an ROI defined with name &quot;beam&quot;, this number will hold moving average of 1000 images for number of valid pixels within this ROI [optional]
roi_beam_sum float If there is an ROI defined with name &quot;beam&quot;, this number will hold moving average of 1000 images for sum of valid pixels within this ROI [optional]

Example

from jfjoch_client.models.measurement_statistics import MeasurementStatistics

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

# convert the object into a dict
measurement_statistics_dict = measurement_statistics_instance.to_dict()
# create an instance of MeasurementStatistics from a dict
measurement_statistics_from_dict = MeasurementStatistics.from_dict(measurement_statistics_dict)

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