Files
Jungfraujoch/broker/gen/model/Calibration_quality.cpp
T
leonarski_fandClaude Opus 5 6fe3f30ab4 api: define the powder calibration result as calibration_output
The JSON a calibration writes was a shape invented at its writer, described
only by the comments around it. That is enough for a file somebody reads with
jq and not enough for anything else: a client cannot type it, and an endpoint
returning it later would have to declare the shape a second time and keep the
two in step by hand.

So declare it where every other shape in this system is declared.
calibration_output holds dataset_settings and a calibration member; the latter
is calibration_quality, which nests calibration_fit_sigma and
calibration_spot_check. The descriptions carry what a reader has to know to use
the numbers rather than only what they are named - that beam_x_pxl is the PONI
and the direct beam is elsewhere, that the rotations travel together because a
body omitting them states a flat detector, that a tilt below about three sigma
was declined and pinned, and that the two correlations approach 1 as the tilt
stops being separable from the beam centre.

Nothing references it yet. It is declared now because /powder_calibration will
return exactly this, and because the file rugnux already writes is decodable
today: jfjoch_client's CalibrationOutput.from_dict reads it as it stands, with
o.calibration.fit_sigma.correlation_beam_x_rot1 and the rest typed.

Generated clients regenerated from the spec, as the spec requires: the C++
server model (four new pairs under broker/gen/model), the TypeScript frontend
client, and broker/redoc-static.html. Both regenerations are purely additive -
no existing generated file changed except to export the new names. The python
client regenerates from the same spec and is gitignored.

The test now validates the WHOLE file against the generated Calibration_output
rather than only its geometry member against Dataset_settings, so the quality
block is under the same contract: a field renamed or newly required in
jfjoch_api.yaml fails here rather than at a client.

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

453 lines
14 KiB
C++

/**
* Jungfraujoch
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms.
*
* The version of the OpenAPI document: 1.0.0-rc.166
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
#include "Calibration_quality.h"
#include "Helpers.h"
#include <sstream>
namespace org::openapitools::server::model
{
Calibration_quality::Calibration_quality()
{
m_Calibrant = "";
m_CalibrantIsSet = false;
m_Method = "";
m_MethodIsSet = false;
m_Ring_points = 0L;
m_Ring_pointsIsSet = false;
m_Rms_radial_pxl = 0.0f;
m_Rms_radial_pxlIsSet = false;
m_Beam_sigma_pxl = 0.0f;
m_Beam_sigma_pxlIsSet = false;
m_Direct_beam_x_pxl = 0.0f;
m_Direct_beam_x_pxlIsSet = false;
m_Direct_beam_y_pxl = 0.0f;
m_Direct_beam_y_pxlIsSet = false;
m_Header_distance_mm = 0.0f;
m_Header_distance_mmIsSet = false;
m_Ring_seed_distance_mm = 0.0f;
m_Ring_seed_distance_mmIsSet = false;
m_Tilt_refined = false;
m_Tilt_refinedIsSet = false;
m_Tilt_significance = 0.0f;
m_Tilt_significanceIsSet = false;
m_Fit_sigmaIsSet = false;
m_Spot_cross_checkIsSet = false;
}
void Calibration_quality::validate() const
{
std::stringstream msg;
if (!validate(msg))
{
throw org::openapitools::server::helpers::ValidationException(msg.str());
}
}
bool Calibration_quality::validate(std::stringstream& msg) const
{
return validate(msg, "");
}
bool Calibration_quality::validate(std::stringstream& msg, const std::string& pathPrefix) const
{
bool success = true;
const std::string _pathPrefix = pathPrefix.empty() ? "Calibration_quality" : pathPrefix;
return success;
}
bool Calibration_quality::operator==(const Calibration_quality& rhs) const
{
return
((!calibrantIsSet() && !rhs.calibrantIsSet()) || (calibrantIsSet() && rhs.calibrantIsSet() && getCalibrant() == rhs.getCalibrant())) &&
((!methodIsSet() && !rhs.methodIsSet()) || (methodIsSet() && rhs.methodIsSet() && getMethod() == rhs.getMethod())) &&
((!ringPointsIsSet() && !rhs.ringPointsIsSet()) || (ringPointsIsSet() && rhs.ringPointsIsSet() && getRingPoints() == rhs.getRingPoints())) &&
((!rmsRadialPxlIsSet() && !rhs.rmsRadialPxlIsSet()) || (rmsRadialPxlIsSet() && rhs.rmsRadialPxlIsSet() && getRmsRadialPxl() == rhs.getRmsRadialPxl())) &&
((!beamSigmaPxlIsSet() && !rhs.beamSigmaPxlIsSet()) || (beamSigmaPxlIsSet() && rhs.beamSigmaPxlIsSet() && getBeamSigmaPxl() == rhs.getBeamSigmaPxl())) &&
((!directBeamXPxlIsSet() && !rhs.directBeamXPxlIsSet()) || (directBeamXPxlIsSet() && rhs.directBeamXPxlIsSet() && getDirectBeamXPxl() == rhs.getDirectBeamXPxl())) &&
((!directBeamYPxlIsSet() && !rhs.directBeamYPxlIsSet()) || (directBeamYPxlIsSet() && rhs.directBeamYPxlIsSet() && getDirectBeamYPxl() == rhs.getDirectBeamYPxl())) &&
((!headerDistanceMmIsSet() && !rhs.headerDistanceMmIsSet()) || (headerDistanceMmIsSet() && rhs.headerDistanceMmIsSet() && getHeaderDistanceMm() == rhs.getHeaderDistanceMm())) &&
((!ringSeedDistanceMmIsSet() && !rhs.ringSeedDistanceMmIsSet()) || (ringSeedDistanceMmIsSet() && rhs.ringSeedDistanceMmIsSet() && getRingSeedDistanceMm() == rhs.getRingSeedDistanceMm())) &&
((!tiltRefinedIsSet() && !rhs.tiltRefinedIsSet()) || (tiltRefinedIsSet() && rhs.tiltRefinedIsSet() && isTiltRefined() == rhs.isTiltRefined())) &&
((!tiltSignificanceIsSet() && !rhs.tiltSignificanceIsSet()) || (tiltSignificanceIsSet() && rhs.tiltSignificanceIsSet() && getTiltSignificance() == rhs.getTiltSignificance())) &&
((!fitSigmaIsSet() && !rhs.fitSigmaIsSet()) || (fitSigmaIsSet() && rhs.fitSigmaIsSet() && getFitSigma() == rhs.getFitSigma())) &&
((!spotCrossCheckIsSet() && !rhs.spotCrossCheckIsSet()) || (spotCrossCheckIsSet() && rhs.spotCrossCheckIsSet() && getSpotCrossCheck() == rhs.getSpotCrossCheck()))
;
}
bool Calibration_quality::operator!=(const Calibration_quality& rhs) const
{
return !(*this == rhs);
}
void to_json(nlohmann::json& j, const Calibration_quality& o)
{
j = nlohmann::json::object();
if(o.calibrantIsSet())
j["calibrant"] = o.m_Calibrant;
if(o.methodIsSet())
j["method"] = o.m_Method;
if(o.ringPointsIsSet())
j["ring_points"] = o.m_Ring_points;
if(o.rmsRadialPxlIsSet())
j["rms_radial_pxl"] = o.m_Rms_radial_pxl;
if(o.beamSigmaPxlIsSet())
j["beam_sigma_pxl"] = o.m_Beam_sigma_pxl;
if(o.directBeamXPxlIsSet())
j["direct_beam_x_pxl"] = o.m_Direct_beam_x_pxl;
if(o.directBeamYPxlIsSet())
j["direct_beam_y_pxl"] = o.m_Direct_beam_y_pxl;
if(o.headerDistanceMmIsSet())
j["header_distance_mm"] = o.m_Header_distance_mm;
if(o.ringSeedDistanceMmIsSet())
j["ring_seed_distance_mm"] = o.m_Ring_seed_distance_mm;
if(o.tiltRefinedIsSet())
j["tilt_refined"] = o.m_Tilt_refined;
if(o.tiltSignificanceIsSet())
j["tilt_significance"] = o.m_Tilt_significance;
if(o.fitSigmaIsSet())
j["fit_sigma"] = o.m_Fit_sigma;
if(o.spotCrossCheckIsSet())
j["spot_cross_check"] = o.m_Spot_cross_check;
}
void from_json(const nlohmann::json& j, Calibration_quality& o)
{
if(j.find("calibrant") != j.end())
{
j.at("calibrant").get_to(o.m_Calibrant);
o.m_CalibrantIsSet = true;
}
if(j.find("method") != j.end())
{
j.at("method").get_to(o.m_Method);
o.m_MethodIsSet = true;
}
if(j.find("ring_points") != j.end())
{
j.at("ring_points").get_to(o.m_Ring_points);
o.m_Ring_pointsIsSet = true;
}
if(j.find("rms_radial_pxl") != j.end())
{
j.at("rms_radial_pxl").get_to(o.m_Rms_radial_pxl);
o.m_Rms_radial_pxlIsSet = true;
}
if(j.find("beam_sigma_pxl") != j.end())
{
j.at("beam_sigma_pxl").get_to(o.m_Beam_sigma_pxl);
o.m_Beam_sigma_pxlIsSet = true;
}
if(j.find("direct_beam_x_pxl") != j.end())
{
j.at("direct_beam_x_pxl").get_to(o.m_Direct_beam_x_pxl);
o.m_Direct_beam_x_pxlIsSet = true;
}
if(j.find("direct_beam_y_pxl") != j.end())
{
j.at("direct_beam_y_pxl").get_to(o.m_Direct_beam_y_pxl);
o.m_Direct_beam_y_pxlIsSet = true;
}
if(j.find("header_distance_mm") != j.end())
{
j.at("header_distance_mm").get_to(o.m_Header_distance_mm);
o.m_Header_distance_mmIsSet = true;
}
if(j.find("ring_seed_distance_mm") != j.end())
{
j.at("ring_seed_distance_mm").get_to(o.m_Ring_seed_distance_mm);
o.m_Ring_seed_distance_mmIsSet = true;
}
if(j.find("tilt_refined") != j.end())
{
j.at("tilt_refined").get_to(o.m_Tilt_refined);
o.m_Tilt_refinedIsSet = true;
}
if(j.find("tilt_significance") != j.end())
{
j.at("tilt_significance").get_to(o.m_Tilt_significance);
o.m_Tilt_significanceIsSet = true;
}
if(j.find("fit_sigma") != j.end())
{
j.at("fit_sigma").get_to(o.m_Fit_sigma);
o.m_Fit_sigmaIsSet = true;
}
if(j.find("spot_cross_check") != j.end())
{
j.at("spot_cross_check").get_to(o.m_Spot_cross_check);
o.m_Spot_cross_checkIsSet = true;
}
}
std::string Calibration_quality::getCalibrant() const
{
return m_Calibrant;
}
void Calibration_quality::setCalibrant(std::string const& value)
{
m_Calibrant = value;
m_CalibrantIsSet = true;
}
bool Calibration_quality::calibrantIsSet() const
{
return m_CalibrantIsSet;
}
void Calibration_quality::unsetCalibrant()
{
m_CalibrantIsSet = false;
}
std::string Calibration_quality::getMethod() const
{
return m_Method;
}
void Calibration_quality::setMethod(std::string const& value)
{
m_Method = value;
m_MethodIsSet = true;
}
bool Calibration_quality::methodIsSet() const
{
return m_MethodIsSet;
}
void Calibration_quality::unsetMethod()
{
m_MethodIsSet = false;
}
int64_t Calibration_quality::getRingPoints() const
{
return m_Ring_points;
}
void Calibration_quality::setRingPoints(int64_t const value)
{
m_Ring_points = value;
m_Ring_pointsIsSet = true;
}
bool Calibration_quality::ringPointsIsSet() const
{
return m_Ring_pointsIsSet;
}
void Calibration_quality::unsetRing_points()
{
m_Ring_pointsIsSet = false;
}
float Calibration_quality::getRmsRadialPxl() const
{
return m_Rms_radial_pxl;
}
void Calibration_quality::setRmsRadialPxl(float const value)
{
m_Rms_radial_pxl = value;
m_Rms_radial_pxlIsSet = true;
}
bool Calibration_quality::rmsRadialPxlIsSet() const
{
return m_Rms_radial_pxlIsSet;
}
void Calibration_quality::unsetRms_radial_pxl()
{
m_Rms_radial_pxlIsSet = false;
}
float Calibration_quality::getBeamSigmaPxl() const
{
return m_Beam_sigma_pxl;
}
void Calibration_quality::setBeamSigmaPxl(float const value)
{
m_Beam_sigma_pxl = value;
m_Beam_sigma_pxlIsSet = true;
}
bool Calibration_quality::beamSigmaPxlIsSet() const
{
return m_Beam_sigma_pxlIsSet;
}
void Calibration_quality::unsetBeam_sigma_pxl()
{
m_Beam_sigma_pxlIsSet = false;
}
float Calibration_quality::getDirectBeamXPxl() const
{
return m_Direct_beam_x_pxl;
}
void Calibration_quality::setDirectBeamXPxl(float const value)
{
m_Direct_beam_x_pxl = value;
m_Direct_beam_x_pxlIsSet = true;
}
bool Calibration_quality::directBeamXPxlIsSet() const
{
return m_Direct_beam_x_pxlIsSet;
}
void Calibration_quality::unsetDirect_beam_x_pxl()
{
m_Direct_beam_x_pxlIsSet = false;
}
float Calibration_quality::getDirectBeamYPxl() const
{
return m_Direct_beam_y_pxl;
}
void Calibration_quality::setDirectBeamYPxl(float const value)
{
m_Direct_beam_y_pxl = value;
m_Direct_beam_y_pxlIsSet = true;
}
bool Calibration_quality::directBeamYPxlIsSet() const
{
return m_Direct_beam_y_pxlIsSet;
}
void Calibration_quality::unsetDirect_beam_y_pxl()
{
m_Direct_beam_y_pxlIsSet = false;
}
float Calibration_quality::getHeaderDistanceMm() const
{
return m_Header_distance_mm;
}
void Calibration_quality::setHeaderDistanceMm(float const value)
{
m_Header_distance_mm = value;
m_Header_distance_mmIsSet = true;
}
bool Calibration_quality::headerDistanceMmIsSet() const
{
return m_Header_distance_mmIsSet;
}
void Calibration_quality::unsetHeader_distance_mm()
{
m_Header_distance_mmIsSet = false;
}
float Calibration_quality::getRingSeedDistanceMm() const
{
return m_Ring_seed_distance_mm;
}
void Calibration_quality::setRingSeedDistanceMm(float const value)
{
m_Ring_seed_distance_mm = value;
m_Ring_seed_distance_mmIsSet = true;
}
bool Calibration_quality::ringSeedDistanceMmIsSet() const
{
return m_Ring_seed_distance_mmIsSet;
}
void Calibration_quality::unsetRing_seed_distance_mm()
{
m_Ring_seed_distance_mmIsSet = false;
}
bool Calibration_quality::isTiltRefined() const
{
return m_Tilt_refined;
}
void Calibration_quality::setTiltRefined(bool const value)
{
m_Tilt_refined = value;
m_Tilt_refinedIsSet = true;
}
bool Calibration_quality::tiltRefinedIsSet() const
{
return m_Tilt_refinedIsSet;
}
void Calibration_quality::unsetTilt_refined()
{
m_Tilt_refinedIsSet = false;
}
float Calibration_quality::getTiltSignificance() const
{
return m_Tilt_significance;
}
void Calibration_quality::setTiltSignificance(float const value)
{
m_Tilt_significance = value;
m_Tilt_significanceIsSet = true;
}
bool Calibration_quality::tiltSignificanceIsSet() const
{
return m_Tilt_significanceIsSet;
}
void Calibration_quality::unsetTilt_significance()
{
m_Tilt_significanceIsSet = false;
}
org::openapitools::server::model::Calibration_fit_sigma Calibration_quality::getFitSigma() const
{
return m_Fit_sigma;
}
void Calibration_quality::setFitSigma(org::openapitools::server::model::Calibration_fit_sigma const& value)
{
m_Fit_sigma = value;
m_Fit_sigmaIsSet = true;
}
bool Calibration_quality::fitSigmaIsSet() const
{
return m_Fit_sigmaIsSet;
}
void Calibration_quality::unsetFit_sigma()
{
m_Fit_sigmaIsSet = false;
}
org::openapitools::server::model::Calibration_spot_check Calibration_quality::getSpotCrossCheck() const
{
return m_Spot_cross_check;
}
void Calibration_quality::setSpotCrossCheck(org::openapitools::server::model::Calibration_spot_check const& value)
{
m_Spot_cross_check = value;
m_Spot_cross_checkIsSet = true;
}
bool Calibration_quality::spotCrossCheckIsSet() const
{
return m_Spot_cross_checkIsSet;
}
void Calibration_quality::unsetSpot_cross_check()
{
m_Spot_cross_checkIsSet = false;
}
} // namespace org::openapitools::server::model