v1.0.0-rc.40

docs/python_client/docs/IndexingSettings.md

@@ -0,0 +1,35 @@
+# IndexingSettings
+
+Settings for crystallography indexing
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**algorithm** | [**IndexingAlgorithm**](IndexingAlgorithm.md) |  | [default to IndexingAlgorithm.FFBIDX]
+**fft_max_unit_cell_a** | **float** | Largest unit cell to be indexed by FFT algorithm; parameter value affects execution time of FFT | [default to 250]
+**fft_min_unit_cell_a** | **float** | Smallest unit cell to be indexed by FFT algorithm; parameter value affects execution time of FFT | [default to 10.0]
+**fft_high_resolution_a** | **float** | Highest resolution of spots used for FFT algorithm; parameter value affects execution time of FFT. There is also correlation between smallest unit cell and max resolution, which need to be checked for very small systems.  | [default to 2.0]
+**fft_num_vectors** | **int** | Number of search directions for the FFT algorithm; parameter value affects execution time of FFT. | [default to 16384]
+**tolerance** | **float** | Acceptance tolerance for spots after the indexing run - the larger the number, the more spots will be accepted | 
+
+## Example
+
+```python
+from jfjoch_client.models.indexing_settings import IndexingSettings
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of IndexingSettings from a JSON string
+indexing_settings_instance = IndexingSettings.from_json(json)
+# print the JSON string representation of the object
+print(IndexingSettings.to_json())
+
+# convert the object into a dict
+indexing_settings_dict = indexing_settings_instance.to_dict()
+# create an instance of IndexingSettings from a dict
+indexing_settings_from_dict = IndexingSettings.from_dict(indexing_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)
+
+