v1.0.0-rc.81
This commit is contained in:
@@ -72,6 +72,9 @@ There are minor differences at the moment:
|
||||
| az_int_bin_to_two_theta | Array(float) | Two theta angle value for each azimuthal integration bin \[deg\] | |
|
||||
| az_int_bin_to_phi | Array(float) | Phi_rad value for each azimuthal integration bin \[deg\] | |
|
||||
| summation | uint64 | Factor of frame summation | |
|
||||
| xray_fluorescence | object (optional) | X-ray fluorescence spectrum collected at start | |
|
||||
| - energy | Array(float) | Energy of measuring point \[eV\] | |
|
||||
| - data | Array(float) | Fluorescence scan result `data` \[arbitrary units\]; must be strictly the same length as energy | |
|
||||
| user_data | string | JSON serialized to string that can contain the following fields (all fields are optional): | X |
|
||||
| - file_prefix | string | File prefix | |
|
||||
| - images_per_file | string | Number of images written per file | |
|
||||
@@ -102,6 +105,7 @@ There are minor differences at the moment:
|
||||
| - socket_number | uint64 | Number of ZeroMQ socket (on `jfjoch_broker` side) used for transmission | |
|
||||
| - xfel_pulse_id | bool | Pulse IDs and event codes are recorded for images | |
|
||||
| - ring_current_mA | float | Ring current at the start of the measurement | |
|
||||
| - detect_ice_rings | bool | Ice ring detection feature is enabled | |
|
||||
| - sample_temperature_K | float | Sample temperature | |
|
||||
| - indexing_algorithm | string | Indexing algorithm used on-the-fly; allowed values for Jungfraujoch: ffbidx, fft, none | |
|
||||
| - geom_refinement_algorithm | string | Post-indexing detector geometry refinement algorithm used on-the-fly; allowed values for Jungfraujoch: none, beam_center, beam_center_tetragonal | |
|
||||
|
||||
@@ -1,4 +1,17 @@
|
||||
# Changelog
|
||||
## 1.0.0.rc.81
|
||||
This is an UNSTABLE release. This release introduces new features, which usually means these need more field testing before enough maturity.
|
||||
For production use we recommend waiting for a future bug-fix release.
|
||||
|
||||
* jfjoch_broker: Add option to detect ice rings, adjust width of ice ring and change of logic to exclude ice rings in indexing
|
||||
* jfjoch_broker: Add FFTW based indexer for CPU only indexing
|
||||
* jfjoch_broker: Enable saving X-ray fluorescence spectra
|
||||
* jfjoch_writer: Write total spot count (before filtering)
|
||||
* jfjoch_viewer: Add more information on source, sample, and buttom to show ice rings
|
||||
* jfjoch_viewer: Enable data processing inside the viewer
|
||||
|
||||
CI: Moving from Gitlab to Gitea at PSI
|
||||
|
||||
## 1.0.0.rc.80
|
||||
This is an UNSTABLE release.
|
||||
|
||||
|
||||
+1
-1
@@ -9,7 +9,7 @@
|
||||
project = 'Jungfraujoch'
|
||||
copyright = '2024, Paul Scherrer Institute'
|
||||
author = 'Filip Leonarski'
|
||||
release = '1.0.0-rc.80'
|
||||
release = '1.0.0-rc.81'
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
||||
|
||||
@@ -22,8 +22,8 @@ communicate through network calls or other mechanisms.
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 1.0.0-rc.80
|
||||
- Package version: 1.0.0-rc.80
|
||||
- API version: 1.0.0-rc.81
|
||||
- Package version: 1.0.0-rc.81
|
||||
- Generator version: 7.8.0
|
||||
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
||||
|
||||
@@ -167,6 +167,7 @@ Class | Method | HTTP request | Description
|
||||
- [BrokerStatus](docs/BrokerStatus.md)
|
||||
- [CalibrationStatisticsInner](docs/CalibrationStatisticsInner.md)
|
||||
- [DatasetSettings](docs/DatasetSettings.md)
|
||||
- [DatasetSettingsXrayFluorescenceSpectrum](docs/DatasetSettingsXrayFluorescenceSpectrum.md)
|
||||
- [Detector](docs/Detector.md)
|
||||
- [DetectorList](docs/DetectorList.md)
|
||||
- [DetectorListElement](docs/DetectorListElement.md)
|
||||
|
||||
@@ -40,6 +40,8 @@ Name | Type | Description | Notes
|
||||
**unit_cell** | [**UnitCell**](UnitCell.md) | | [optional]
|
||||
**spot_finding** | **bool** | Enable spot finding and save spots | [optional] [default to True]
|
||||
**max_spot_count** | **int** | Maximum number of spots that are saved/used for indexing; spots with highest intensity are selected | [optional] [default to 250]
|
||||
**detect_ice_rings** | **bool** | Flag spots as ice rings and reduce their effect on indexing | [optional]
|
||||
**xray_fluorescence_spectrum** | [**DatasetSettingsXrayFluorescenceSpectrum**](DatasetSettingsXrayFluorescenceSpectrum.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
# DatasetSettingsXrayFluorescenceSpectrum
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**energy_e_v** | **List[float]** | X-ray fluorescence scan energy for each measurement point |
|
||||
**data** | **List[float]** | X-ray fluorescence scan result in arbitrary units; must be exactly the same length, as energy_eV |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from jfjoch_client.models.dataset_settings_xray_fluorescence_spectrum import DatasetSettingsXrayFluorescenceSpectrum
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of DatasetSettingsXrayFluorescenceSpectrum from a JSON string
|
||||
dataset_settings_xray_fluorescence_spectrum_instance = DatasetSettingsXrayFluorescenceSpectrum.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(DatasetSettingsXrayFluorescenceSpectrum.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
dataset_settings_xray_fluorescence_spectrum_dict = dataset_settings_xray_fluorescence_spectrum_instance.to_dict()
|
||||
# create an instance of DatasetSettingsXrayFluorescenceSpectrum from a dict
|
||||
dataset_settings_xray_fluorescence_spectrum_from_dict = DatasetSettingsXrayFluorescenceSpectrum.from_dict(dataset_settings_xray_fluorescence_spectrum_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)
|
||||
|
||||
|
||||
@@ -8,6 +8,8 @@ Selection of an indexing algorithm used by Jungfraujoch
|
||||
|
||||
* `FFT` (value: `'FFT'`)
|
||||
|
||||
* `FFTW` (value: `'FFTW'`)
|
||||
|
||||
* `AUTO` (value: `'Auto'`)
|
||||
|
||||
* `NONE` (value: `'None'`)
|
||||
|
||||
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
|
||||
**thread_count** | **int** | Thread count for indexing algorithm |
|
||||
**geom_refinement_algorithm** | [**GeomRefinementAlgorithm**](GeomRefinementAlgorithm.md) | |
|
||||
**unit_cell_dist_tolerance** | **float** | Relative distance tolerance for unit cell vs. reference; Lattices outside given tolerance will be ignored | [default to 0.05]
|
||||
**index_ice_rings** | **bool** | Include spots marked as ice rings in the indexing run. If `dataset_settings` doesn't have `detect_ice_rings` on, this option will have no effect on processing. | [default to False]
|
||||
|
||||
## Example
|
||||
|
||||
|
||||
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
|
||||
**low_resolution_limit** | **float** | Low resolution limit for spot finding [Angstrom] |
|
||||
**high_resolution_limit_for_spot_count_low_res** | **float** | High resolution threshold to consider spot \"low resolution\" [Angstrom] |
|
||||
**quick_integration** | **bool** | Quick integration of Bragg spots in diffraction images. If enabled it will likely reduce performance of Jungfraujoch for datasets with a very high indexing rate. (experimental feature) | [default to False]
|
||||
**ice_ring_width_q_recip_a** | **float** | Width of ice ring in q-space in reciprocal space | [default to 0.02]
|
||||
|
||||
## Example
|
||||
|
||||
|
||||
Reference in New Issue
Block a user