35 lines
1.5 KiB
Plaintext
35 lines
1.5 KiB
Plaintext
# RoiAzimuthal
|
|
|
|
ROI as Q-range (or resolution range), optionally restricted to an azimuthal-angle sector
|
|
|
|
## Properties
|
|
|
|
Name | Type | Description | Notes
|
|
------------ | ------------- | ------------- | -------------
|
|
**name** | **str** | Name for the ROI; used in the plots |
|
|
**q_min_recip_a** | **float** | Minimum Q-range for the ROI |
|
|
**q_max_recip_a** | **float** | Maximum Q-range for the ROI |
|
|
**phi_min_deg** | **float** | Lower azimuthal-angle bound of the sector [degrees]. Optional: provide both phi_min_deg and phi_max_deg to restrict the ROI to an angular sector, or omit both for a full ring. A sector with phi_min_deg > phi_max_deg wraps across 0. | [optional]
|
|
**phi_max_deg** | **float** | Upper azimuthal-angle bound of the sector [degrees]. Optional; see phi_min_deg. | [optional]
|
|
|
|
## Example
|
|
|
|
```python
|
|
from jfjoch_client.models.roi_azimuthal import RoiAzimuthal
|
|
|
|
# TODO update the JSON string below
|
|
json = "{}"
|
|
# create an instance of RoiAzimuthal from a JSON string
|
|
roi_azimuthal_instance = RoiAzimuthal.from_json(json)
|
|
# print the JSON string representation of the object
|
|
print(RoiAzimuthal.to_json())
|
|
|
|
# convert the object into a dict
|
|
roi_azimuthal_dict = roi_azimuthal_instance.to_dict()
|
|
# create an instance of RoiAzimuthal from a dict
|
|
roi_azimuthal_from_dict = RoiAzimuthal.from_dict(roi_azimuthal_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)
|
|
|
|
|