VERSION: 1.0.0-rc.161

docs/python_client/docs/AzimIntSettings.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **polarization_corr** | **bool** | Apply polarization correction for azimuthal integration (polarization factor must be configured in dataset settings) | [default to True]
 **solid_angle_corr** | **bool** | Apply solid angle correction for azimuthal integration | [default to True]
-**high_q_recip_a** | **float** |  | 
+**high_q_recip_a** | **float** | Upper q limit of the azimuthal integration [1/Angstrom]. Optional: if omitted, the integration (and the adaptive spot detection that shares these q bins) extends to the highest q the detector reaches.  | [optional] 
 **low_q_recip_a** | **float** |  | 
 **q_spacing** | **float** |  | 
 **azimuthal_bins** | **int** | Numer of azimuthal (phi) bins; 1 = standard 1D azimuthal integration | [optional] [default to 1]

docs/python_client/docs/BraggIntegrationSettings.md

@@ -0,0 +1,30 @@
+# BraggIntegrationSettings
+
+Settings for Bragg spot integration
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**integration_model** | [**IntegrationModel**](IntegrationModel.md) |  | [default to IntegrationModel.PROFILEGAUSSIAN]
+
+## Example
+
+```python
+from jfjoch_client.models.bragg_integration_settings import BraggIntegrationSettings
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of BraggIntegrationSettings from a JSON string
+bragg_integration_settings_instance = BraggIntegrationSettings.from_json(json)
+# print the JSON string representation of the object
+print(BraggIntegrationSettings.to_json())
+
+# convert the object into a dict
+bragg_integration_settings_dict = bragg_integration_settings_instance.to_dict()
+# create an instance of BraggIntegrationSettings from a dict
+bragg_integration_settings_from_dict = BraggIntegrationSettings.from_dict(bragg_integration_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)
+
+

docs/python_client/docs/ColorScale.md

@@ -1,16 +0,0 @@
-# ColorScale
-
-
-## Enum
-
-* `INDIGO` (value: `'Indigo'`)
-
-* `VIRIDIS` (value: `'Viridis'`)
-
-* `BLACKWHITE` (value: `'BlackWhite'`)
-
-* `HEAT` (value: `'Heat'`)
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
-
-

docs/python_client/docs/GridScanResultImagesInner.md

@@ -1,36 +0,0 @@
-# GridScanResultImagesInner
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**efficiency** | **float** |  | 
-**number** | **int** | Detector image number for a given cell | 
-**bkg** | **float** | Background estimate | [optional] 
-**spots** | **int** | Spot count | [optional] 
-**index** | **int** | Indexing solution | [optional] 
-**mos** | **float** | Mosaicity estimate | [optional] 
-**b** | **float** | B-Factor estimate | [optional] 
-**uc** | [**UnitCell**](UnitCell.md) |  | [optional] 
-
-## Example
-
-```python
-from jfjoch_client.models.grid_scan_result_images_inner import GridScanResultImagesInner
-
-# TODO update the JSON string below
-json = "{}"
-# create an instance of GridScanResultImagesInner from a JSON string
-grid_scan_result_images_inner_instance = GridScanResultImagesInner.from_json(json)
-# print the JSON string representation of the object
-print(GridScanResultImagesInner.to_json())
-
-# convert the object into a dict
-grid_scan_result_images_inner_dict = grid_scan_result_images_inner_instance.to_dict()
-# create an instance of GridScanResultImagesInner from a dict
-grid_scan_result_images_inner_from_dict = GridScanResultImagesInner.from_dict(grid_scan_result_images_inner_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)
-
-

docs/python_client/docs/IntegrationModel.md

@@ -0,0 +1,15 @@
+# IntegrationModel
+
+Bragg spot integration model. ProfileGaussian - profile fit with a measured-width Gaussian (Kabsch-style), the default; more   accurate intensities than box summation. ProfileEmpirical - profile fit with a per-resolution-shell empirical profile learned from strong spots. BoxSum - classical uniform box summation minus a ring-mean background; the simpler, faster fallback. 
+
+## Enum
+
+* `PROFILEGAUSSIAN` (value: `'ProfileGaussian'`)
+
+* `PROFILEEMPIRICAL` (value: `'ProfileEmpirical'`)
+
+* `BOXSUM` (value: `'BoxSum'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

docs/python_client/docs/JfjochBrokerApi.md

@@ -1,77 +0,0 @@
-# jfjoch_client.JfjochBrokerApi
-
-All URIs are relative to *http://localhost:5232*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**config_zeromq_metadata_put**](JfjochBrokerApi.md#config_zeromq_metadata_put) | **PUT** /config/zeromq_metadata | Set ZeroMQ metadata settings
-
-
-# **config_zeromq_metadata_put**
-> config_zeromq_metadata_put(zeromq_metadata_settings=zeromq_metadata_settings)
-
-Set ZeroMQ metadata settings
-
-Jungfraujoch can generate metadata message stream on ZeroMQ PUB socket. This stream covers all images. Here settings of the socket can be adjusted. While the data structure contains also socket_address, this cannot be changed via HTTP and is ignore in PUT request. 
-
-### Example
-
-
-```python
-import jfjoch_client
-from jfjoch_client.models.zeromq_metadata_settings import ZeromqMetadataSettings
-from jfjoch_client.rest import ApiException
-from pprint import pprint
-
-# Defining the host is optional and defaults to http://localhost:5232
-# See configuration.py for a list of all supported configuration parameters.
-configuration = jfjoch_client.Configuration(
-    host = "http://localhost:5232"
-)
-
-
-# Enter a context with an instance of the API client
-with jfjoch_client.ApiClient(configuration) as api_client:
-    # Create an instance of the API class
-    api_instance = jfjoch_client.JfjochBrokerApi(api_client)
-    zeromq_metadata_settings = jfjoch_client.ZeromqMetadataSettings() # ZeromqMetadataSettings |  (optional)
-
-    try:
-        # Set ZeroMQ metadata settings
-        api_instance.config_zeromq_metadata_put(zeromq_metadata_settings=zeromq_metadata_settings)
-    except Exception as e:
-        print("Exception when calling JfjochBrokerApi->config_zeromq_metadata_put: %s\n" % e)
-```
-
-
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **zeromq_metadata_settings** | [**ZeromqMetadataSettings**](ZeromqMetadataSettings.md)|  | [optional] 
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: text/plain, application/json
-
-### HTTP response details
-
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | Everything OK |  -  |
-**400** | Input parsing or validation error |  -  |
-**500** | Error within Jungfraujoch code - see output message. |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-

docs/python_client/docs/SpotFindingSettings.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **photon_count_threshold** | **int** |  | 
 **min_pix_per_spot** | **int** |  | 
 **max_pix_per_spot** | **int** |  | 
-**high_resolution_limit** | **float** | High resolution limit for spot finding [Angstrom] | 
+**high_resolution_limit** | **float** | High resolution limit for spot finding [Angstrom]. Optional: if omitted, spot finding extends as far as the detector reaches, i.e. the detection is not clipped in resolution.  | [optional] 
 **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]