v1.0.0-rc.34
This commit is contained in:
@@ -56,8 +56,11 @@ Method | HTTP request | Description
|
||||
[**plot_receiver_delay_get**](DefaultApi.md#plot_receiver_delay_get) | **GET** /plot/receiver_delay | Generate receiver delay plot
|
||||
[**plot_receiver_free_send_buffers_get**](DefaultApi.md#plot_receiver_free_send_buffers_get) | **GET** /plot/receiver_free_send_buffers | Generate receiver free send buffer plot
|
||||
[**plot_roi_max_count_get**](DefaultApi.md#plot_roi_max_count_get) | **GET** /plot/roi_max_count | Generate plot of ROI max count
|
||||
[**plot_roi_mean_get**](DefaultApi.md#plot_roi_mean_get) | **GET** /plot/roi_mean | Generate plot of ROI mean value
|
||||
[**plot_roi_sum_get**](DefaultApi.md#plot_roi_sum_get) | **GET** /plot/roi_sum | Generate ROI sum plot
|
||||
[**plot_roi_valid_pixels_get**](DefaultApi.md#plot_roi_valid_pixels_get) | **GET** /plot/roi_valid_pixels | Generate plot of ROI valid pixels
|
||||
[**plot_roi_x_get**](DefaultApi.md#plot_roi_x_get) | **GET** /plot/roi_x | Generate plot of ROI weighted X-coordinate
|
||||
[**plot_roi_y_get**](DefaultApi.md#plot_roi_y_get) | **GET** /plot/roi_y | Generate plot of ROI weighted Y-coordinate
|
||||
[**plot_spot_count_get**](DefaultApi.md#plot_spot_count_get) | **GET** /plot/spot_count | Generate spot count plot
|
||||
[**plot_strong_pixel_get**](DefaultApi.md#plot_strong_pixel_get) | **GET** /plot/strong_pixel | Generate strong pixels plot
|
||||
[**preview_calibration_tiff_get**](DefaultApi.md#preview_calibration_tiff_get) | **GET** /preview/calibration.tiff | Get last preview image in TIFF format for calibration with PyFAI/Dioptas
|
||||
@@ -3487,6 +3490,77 @@ with jfjoch_client.ApiClient(configuration) as api_client:
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**binning** | **int**| Binning of frames for the plot (0 = default binning) | [optional]
|
||||
**compression** | **bool**| Enable DEFLATE compression of output data. | [optional] [default to True]
|
||||
|
||||
### Return type
|
||||
|
||||
[**Plots**](Plots.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, text/plain
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | Response will be by default compressed with deflate algorithm, if using curl, use --compressed option. | - |
|
||||
**400** | Input parsing or validation error | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **plot_roi_mean_get**
|
||||
> Plots plot_roi_mean_get(binning=binning, compression=compression)
|
||||
|
||||
Generate plot of ROI mean value
|
||||
|
||||
Mean of pixels within a ROI area; pixels with special values (overload, bad pixel) are excluded; binning is configurable; number will be wrong if multipixels are included!
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import jfjoch_client
|
||||
from jfjoch_client.models.plots import Plots
|
||||
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.DefaultApi(api_client)
|
||||
binning = 56 # int | Binning of frames for the plot (0 = default binning) (optional)
|
||||
compression = True # bool | Enable DEFLATE compression of output data. (optional) (default to True)
|
||||
|
||||
try:
|
||||
# Generate plot of ROI mean value
|
||||
api_response = api_instance.plot_roi_mean_get(binning=binning, compression=compression)
|
||||
print("The response of DefaultApi->plot_roi_mean_get:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling DefaultApi->plot_roi_mean_get: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
@@ -3629,6 +3703,148 @@ with jfjoch_client.ApiClient(configuration) as api_client:
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**binning** | **int**| Binning of frames for the plot (0 = default binning) | [optional]
|
||||
**compression** | **bool**| Enable DEFLATE compression of output data. | [optional] [default to True]
|
||||
|
||||
### Return type
|
||||
|
||||
[**Plots**](Plots.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, text/plain
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | Response will be by default compressed with deflate algorithm, if using curl, use --compressed option. | - |
|
||||
**400** | Input parsing or validation error | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **plot_roi_x_get**
|
||||
> Plots plot_roi_x_get(binning=binning, compression=compression)
|
||||
|
||||
Generate plot of ROI weighted X-coordinate
|
||||
|
||||
Pixel X weighted by measured counts; pixels with special values (overload, bad pixel) are excluded; binning is configurable
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import jfjoch_client
|
||||
from jfjoch_client.models.plots import Plots
|
||||
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.DefaultApi(api_client)
|
||||
binning = 56 # int | Binning of frames for the plot (0 = default binning) (optional)
|
||||
compression = True # bool | Enable DEFLATE compression of output data. (optional) (default to True)
|
||||
|
||||
try:
|
||||
# Generate plot of ROI weighted X-coordinate
|
||||
api_response = api_instance.plot_roi_x_get(binning=binning, compression=compression)
|
||||
print("The response of DefaultApi->plot_roi_x_get:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling DefaultApi->plot_roi_x_get: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**binning** | **int**| Binning of frames for the plot (0 = default binning) | [optional]
|
||||
**compression** | **bool**| Enable DEFLATE compression of output data. | [optional] [default to True]
|
||||
|
||||
### Return type
|
||||
|
||||
[**Plots**](Plots.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, text/plain
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | Response will be by default compressed with deflate algorithm, if using curl, use --compressed option. | - |
|
||||
**400** | Input parsing or validation error | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **plot_roi_y_get**
|
||||
> Plots plot_roi_y_get(binning=binning, compression=compression)
|
||||
|
||||
Generate plot of ROI weighted Y-coordinate
|
||||
|
||||
Pixel Y weighted by measured counts; pixels with special values (overload, bad pixel) are excluded; binning is configurable
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import jfjoch_client
|
||||
from jfjoch_client.models.plots import Plots
|
||||
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.DefaultApi(api_client)
|
||||
binning = 56 # int | Binning of frames for the plot (0 = default binning) (optional)
|
||||
compression = True # bool | Enable DEFLATE compression of output data. (optional) (default to True)
|
||||
|
||||
try:
|
||||
# Generate plot of ROI weighted Y-coordinate
|
||||
api_response = api_instance.plot_roi_y_get(binning=binning, compression=compression)
|
||||
print("The response of DefaultApi->plot_roi_y_get:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling DefaultApi->plot_roi_y_get: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user