Files
Jungfraujoch/docs/python_client/docs/PowderCalibrationOutput.md
T
leonarski_fandClaude Opus 5 7c00731992 docs: publish the powder calibration schemas in the python client docs
docs/python_client is tracked and is what readthedocs publishes, but it is
generated - update_version.sh copies it out of python-client after regenerating
the client - so adding schemas to the spec left it four files behind. The
README's model list did not name them and their pages did not exist.

Copied the way update_version.sh copies them. The four new pages and four lines
in the README, nothing else: the generator's README is built from the spec, so
the stale Calibration* pages it had left on disk under the old names are absent
from it and were removed before copying rather than published alongside their
replacements.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NfuDvf5ipV3Hi8TiCUKD27
2026-08-31 19:02:12 +02:00

1.8 KiB

PowderCalibrationOutput

The result of a powder-ring detector calibration - what rugnux --mode calibration writes as .json, and what a calibration run over the image buffer would return. dataset_settings holds the geometry and nothing else, under the property names this API gives them, so it can be POSTed or merged without translating a field. Its beam_x_pxl/beam_y_pxl is the PONI, the foot of the perpendicular from the sample; where the beam actually lands is calibration.direct_beam_x_pxl. The poni_rot*_rad are present whenever any of them is non-zero and absent when all are zero, since a body omitting them states a FLAT detector rather than an unstated one.

Properties

Name Type Description Notes
dataset_settings DatasetSettings
calibration PowderCalibrationQuality [optional]
jfjoch_version str Version of the program that produced this [optional]

Example

from jfjoch_client.models.powder_calibration_output import PowderCalibrationOutput

# TODO update the JSON string below
json = "{}"
# create an instance of PowderCalibrationOutput from a JSON string
powder_calibration_output_instance = PowderCalibrationOutput.from_json(json)
# print the JSON string representation of the object
print(PowderCalibrationOutput.to_json())

# convert the object into a dict
powder_calibration_output_dict = powder_calibration_output_instance.to_dict()
# create an instance of PowderCalibrationOutput from a dict
powder_calibration_output_from_dict = PowderCalibrationOutput.from_dict(powder_calibration_output_dict)

[Back to Model list] [Back to API list] [Back to README]