Files
Jungfraujoch/docs/python_client/docs/DarkMaskSettings.md
Filip Leonarski 4dbbf0e365
Some checks failed
Build Packages / build:rpm (ubuntu2404_nocuda) (push) Successful in 8m11s
Build Packages / build:rpm (ubuntu2204_nocuda) (push) Successful in 9m9s
Build Packages / build:rpm (rocky8_nocuda) (push) Successful in 9m18s
Build Packages / build:rpm (rocky9_nocuda) (push) Successful in 10m14s
Build Packages / build:rpm (rocky8_sls9) (push) Successful in 10m3s
Build Packages / Generate python client (push) Successful in 15s
Build Packages / Build documentation (push) Successful in 50s
Build Packages / Create release (push) Has been skipped
Build Packages / build:rpm (rocky8) (push) Successful in 8m31s
Build Packages / build:rpm (ubuntu2204) (push) Successful in 8m21s
Build Packages / build:rpm (ubuntu2404) (push) Successful in 7m42s
Build Packages / build:rpm (rocky9) (push) Successful in 9m11s
Build Packages / Unit tests (push) Failing after 1h13m19s
v1.0.0-rc.97
This is an UNSTABLE release and not recommended for production use (please use rc.96 instead).

* jfjoch_broker: For DECTRIS detectors add dark data collection during initialization for bad pixel mask
* jfjoch_broker: Refactor of calibration logic for more clear code (likely to introduce problems)
* jfjoch_viewer: Add option to handle user pixel mask (experimental)
* jfjoch_viewer: More options for ROI
* jfjoch_viewer: Add window to display calibration

Reviewed-on: #2
Co-authored-by: Filip Leonarski <filip.leonarski@psi.ch>
Co-committed-by: Filip Leonarski <filip.leonarski@psi.ch>
2025-11-09 12:42:27 +01:00

35 lines
1.5 KiB
Markdown

# DarkMaskSettings
Settings for collection of dark images to be used for mask calculation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**detector_threshold_ke_v** | **float** | Energy threshold for dark image collection | [default to 3.5]
**frame_time_us** | **int** | Time between frames for dark image collection | [default to 10000]
**number_of_frames** | **int** | Number of frames for dark image collection; zero means no dark collection | [default to 1000]
**max_allowed_pixel_count** | **int** | Maximum count in a pixel considered normal (not-masked) | [default to 1]
**max_frames_with_signal** | **int** | Maximum number of frames with signal in a pixel considered normal (not-masked) | [default to 10]
## Example
```python
from jfjoch_client.models.dark_mask_settings import DarkMaskSettings
# TODO update the JSON string below
json = "{}"
# create an instance of DarkMaskSettings from a JSON string
dark_mask_settings_instance = DarkMaskSettings.from_json(json)
# print the JSON string representation of the object
print(DarkMaskSettings.to_json())
# convert the object into a dict
dark_mask_settings_dict = dark_mask_settings_instance.to_dict()
# create an instance of DarkMaskSettings from a dict
dark_mask_settings_from_dict = DarkMaskSettings.from_dict(dark_mask_settings_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)