diff --git a/broker/OpenAPIConvert.cpp b/broker/OpenAPIConvert.cpp index 8da187f9..1590c531 100644 --- a/broker/OpenAPIConvert.cpp +++ b/broker/OpenAPIConvert.cpp @@ -694,6 +694,18 @@ DatasetSettings Convert(const org::openapitools::server::model::Dataset_settings ret.FluorescenceSpectrum({fl.getEnergyEV(), fl.getData()}); } + if (input.smargonIsSet()) { + auto sm = input.getSmargon(); + SmargonPosition smargon; + smargon.phi_deg = sm.getPhiDeg(); + smargon.chi_deg = sm.getChiDeg(); + if (sm.phiAxisIsSet()) + smargon.phi_axis = ConvertOpenAPI(sm.getPhiAxis()); + if (sm.chiAxisIsSet()) + smargon.chi_axis = ConvertOpenAPI(sm.getChiAxis()); + ret.Smargon(smargon); + } + return ret; } diff --git a/broker/gen/model/Dataset_settings.cpp b/broker/gen/model/Dataset_settings.cpp index ac39310b..f0b54006 100644 --- a/broker/gen/model/Dataset_settings.cpp +++ b/broker/gen/model/Dataset_settings.cpp @@ -80,6 +80,7 @@ Dataset_settings::Dataset_settings() m_Unit_cellIsSet = false; m_Spot_finding = true; m_Spot_findingIsSet = false; + m_SmargonIsSet = false; m_Max_spot_count = 250; m_Max_spot_countIsSet = false; m_Detect_ice_rings = false; @@ -406,7 +407,7 @@ bool Dataset_settings::validate(std::stringstream& msg, const std::string& pathP } } - + if (maxSpotCountIsSet()) { const int32_t& value = m_Max_spot_count; @@ -537,6 +538,9 @@ bool Dataset_settings::operator==(const Dataset_settings& rhs) const ((!spotFindingIsSet() && !rhs.spotFindingIsSet()) || (spotFindingIsSet() && rhs.spotFindingIsSet() && isSpotFinding() == rhs.isSpotFinding())) && + ((!smargonIsSet() && !rhs.smargonIsSet()) || (smargonIsSet() && rhs.smargonIsSet() && getSmargon() == rhs.getSmargon())) && + + ((!maxSpotCountIsSet() && !rhs.maxSpotCountIsSet()) || (maxSpotCountIsSet() && rhs.maxSpotCountIsSet() && getMaxSpotCount() == rhs.getMaxSpotCount())) && @@ -623,6 +627,8 @@ void to_json(nlohmann::json& j, const Dataset_settings& o) j["unit_cell"] = o.m_Unit_cell; if(o.spotFindingIsSet()) j["spot_finding"] = o.m_Spot_finding; + if(o.smargonIsSet()) + j["smargon"] = o.m_Smargon; if(o.maxSpotCountIsSet()) j["max_spot_count"] = o.m_Max_spot_count; if(o.detectIceRingsIsSet()) @@ -790,6 +796,11 @@ void from_json(const nlohmann::json& j, Dataset_settings& o) j.at("spot_finding").get_to(o.m_Spot_finding); o.m_Spot_findingIsSet = true; } + if(j.find("smargon") != j.end()) + { + j.at("smargon").get_to(o.m_Smargon); + o.m_SmargonIsSet = true; + } if(j.find("max_spot_count") != j.end()) { j.at("max_spot_count").get_to(o.m_Max_spot_count); @@ -1355,6 +1366,23 @@ void Dataset_settings::unsetSpot_finding() { m_Spot_findingIsSet = false; } +org::openapitools::server::model::Dataset_settings_smargon Dataset_settings::getSmargon() const +{ + return m_Smargon; +} +void Dataset_settings::setSmargon(org::openapitools::server::model::Dataset_settings_smargon const& value) +{ + m_Smargon = value; + m_SmargonIsSet = true; +} +bool Dataset_settings::smargonIsSet() const +{ + return m_SmargonIsSet; +} +void Dataset_settings::unsetSmargon() +{ + m_SmargonIsSet = false; +} int32_t Dataset_settings::getMaxSpotCount() const { return m_Max_spot_count; diff --git a/broker/gen/model/Dataset_settings.h b/broker/gen/model/Dataset_settings.h index d6fd651f..d8256cae 100644 --- a/broker/gen/model/Dataset_settings.h +++ b/broker/gen/model/Dataset_settings.h @@ -21,6 +21,7 @@ #include "Grid_scan.h" #include +#include "Dataset_settings_smargon.h" #include "Rotation_axis.h" #include "Unit_cell.h" #include @@ -294,6 +295,13 @@ public: bool spotFindingIsSet() const; void unsetSpot_finding(); /// + /// + /// + org::openapitools::server::model::Dataset_settings_smargon getSmargon() const; + void setSmargon(org::openapitools::server::model::Dataset_settings_smargon const& value); + bool smargonIsSet() const; + void unsetSmargon(); + /// /// Maximum number of spots that are saved/used for indexing; spots with highest intensity are selected /// int32_t getMaxSpotCount() const; @@ -393,6 +401,8 @@ protected: bool m_Unit_cellIsSet; bool m_Spot_finding; bool m_Spot_findingIsSet; + org::openapitools::server::model::Dataset_settings_smargon m_Smargon; + bool m_SmargonIsSet; int32_t m_Max_spot_count; bool m_Max_spot_countIsSet; bool m_Detect_ice_rings; diff --git a/broker/gen/model/Dataset_settings_smargon.cpp b/broker/gen/model/Dataset_settings_smargon.cpp new file mode 100644 index 00000000..f81ac15e --- /dev/null +++ b/broker/gen/model/Dataset_settings_smargon.cpp @@ -0,0 +1,242 @@ +/** +* 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.155 +* 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 "Dataset_settings_smargon.h" +#include "Helpers.h" + +#include + +namespace org::openapitools::server::model +{ + +Dataset_settings_smargon::Dataset_settings_smargon() +{ + m_Phi_deg = 0.0f; + m_Chi_deg = 0.0f; + m_Phi_axisIsSet = false; + m_Chi_axisIsSet = false; + +} + +void Dataset_settings_smargon::validate() const +{ + std::stringstream msg; + if (!validate(msg)) + { + throw org::openapitools::server::helpers::ValidationException(msg.str()); + } +} + +bool Dataset_settings_smargon::validate(std::stringstream& msg) const +{ + return validate(msg, ""); +} + +bool Dataset_settings_smargon::validate(std::stringstream& msg, const std::string& pathPrefix) const +{ + bool success = true; + const std::string _pathPrefix = pathPrefix.empty() ? "Dataset_settings_smargon" : pathPrefix; + + + + /* Chi_deg */ { + const float& value = m_Chi_deg; + const std::string currentValuePath = _pathPrefix + ".chiDeg"; + + + if (value < static_cast(0.0)) + { + success = false; + msg << currentValuePath << ": must be greater than or equal to 0.0;"; + } + if (value > static_cast(90.0)) + { + success = false; + msg << currentValuePath << ": must be less than or equal to 90.0;"; + } + + } + + if (phiAxisIsSet()) + { + const std::vector& value = m_Phi_axis; + const std::string currentValuePath = _pathPrefix + ".phiAxis"; + + + if (value.size() < 3) + { + success = false; + msg << currentValuePath << ": must have at least 3 elements;"; + } + if (value.size() > 3) + { + success = false; + msg << currentValuePath << ": must have at most 3 elements;"; + } + { // Recursive validation of array elements + const std::string oldValuePath = currentValuePath; + int i = 0; + for (const float& value : value) + { + const std::string currentValuePath = oldValuePath + "[" + std::to_string(i) + "]"; + + + + i++; + } + } + + } + + if (chiAxisIsSet()) + { + const std::vector& value = m_Chi_axis; + const std::string currentValuePath = _pathPrefix + ".chiAxis"; + + + if (value.size() < 3) + { + success = false; + msg << currentValuePath << ": must have at least 3 elements;"; + } + if (value.size() > 3) + { + success = false; + msg << currentValuePath << ": must have at most 3 elements;"; + } + { // Recursive validation of array elements + const std::string oldValuePath = currentValuePath; + int i = 0; + for (const float& value : value) + { + const std::string currentValuePath = oldValuePath + "[" + std::to_string(i) + "]"; + + + + i++; + } + } + + } + + return success; +} + +bool Dataset_settings_smargon::operator==(const Dataset_settings_smargon& rhs) const +{ + return + + + (getPhiDeg() == rhs.getPhiDeg()) + && + + (getChiDeg() == rhs.getChiDeg()) + && + + + ((!phiAxisIsSet() && !rhs.phiAxisIsSet()) || (phiAxisIsSet() && rhs.phiAxisIsSet() && getPhiAxis() == rhs.getPhiAxis())) && + + + ((!chiAxisIsSet() && !rhs.chiAxisIsSet()) || (chiAxisIsSet() && rhs.chiAxisIsSet() && getChiAxis() == rhs.getChiAxis())) + + ; +} + +bool Dataset_settings_smargon::operator!=(const Dataset_settings_smargon& rhs) const +{ + return !(*this == rhs); +} + +void to_json(nlohmann::json& j, const Dataset_settings_smargon& o) +{ + j = nlohmann::json::object(); + j["phi_deg"] = o.m_Phi_deg; + j["chi_deg"] = o.m_Chi_deg; + if(o.phiAxisIsSet() || !o.m_Phi_axis.empty()) + j["phi_axis"] = o.m_Phi_axis; + if(o.chiAxisIsSet() || !o.m_Chi_axis.empty()) + j["chi_axis"] = o.m_Chi_axis; + +} + +void from_json(const nlohmann::json& j, Dataset_settings_smargon& o) +{ + j.at("phi_deg").get_to(o.m_Phi_deg); + j.at("chi_deg").get_to(o.m_Chi_deg); + if(j.find("phi_axis") != j.end()) + { + j.at("phi_axis").get_to(o.m_Phi_axis); + o.m_Phi_axisIsSet = true; + } + if(j.find("chi_axis") != j.end()) + { + j.at("chi_axis").get_to(o.m_Chi_axis); + o.m_Chi_axisIsSet = true; + } + +} + +float Dataset_settings_smargon::getPhiDeg() const +{ + return m_Phi_deg; +} +void Dataset_settings_smargon::setPhiDeg(float const value) +{ + m_Phi_deg = value; +} +float Dataset_settings_smargon::getChiDeg() const +{ + return m_Chi_deg; +} +void Dataset_settings_smargon::setChiDeg(float const value) +{ + m_Chi_deg = value; +} +std::vector Dataset_settings_smargon::getPhiAxis() const +{ + return m_Phi_axis; +} +void Dataset_settings_smargon::setPhiAxis(std::vector const value) +{ + m_Phi_axis = value; + m_Phi_axisIsSet = true; +} +bool Dataset_settings_smargon::phiAxisIsSet() const +{ + return m_Phi_axisIsSet; +} +void Dataset_settings_smargon::unsetPhi_axis() +{ + m_Phi_axisIsSet = false; +} +std::vector Dataset_settings_smargon::getChiAxis() const +{ + return m_Chi_axis; +} +void Dataset_settings_smargon::setChiAxis(std::vector const value) +{ + m_Chi_axis = value; + m_Chi_axisIsSet = true; +} +bool Dataset_settings_smargon::chiAxisIsSet() const +{ + return m_Chi_axisIsSet; +} +void Dataset_settings_smargon::unsetChi_axis() +{ + m_Chi_axisIsSet = false; +} + + +} // namespace org::openapitools::server::model + diff --git a/broker/gen/model/Dataset_settings_smargon.h b/broker/gen/model/Dataset_settings_smargon.h new file mode 100644 index 00000000..69d2f6e6 --- /dev/null +++ b/broker/gen/model/Dataset_settings_smargon.h @@ -0,0 +1,102 @@ +/** +* 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.155 +* 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. +*/ +/* + * Dataset_settings_smargon.h + * + * Geometry of Smargon goniometer at SLS 2.0 / MX beamlines. Assuming that Smargon is used as static positioner and not moving during the scan, allowing to reconstruct geometry. + */ + +#ifndef Dataset_settings_smargon_H_ +#define Dataset_settings_smargon_H_ + + +#include +#include + +namespace org::openapitools::server::model +{ + +/// +/// Geometry of Smargon goniometer at SLS 2.0 / MX beamlines. Assuming that Smargon is used as static positioner and not moving during the scan, allowing to reconstruct geometry. +/// +class Dataset_settings_smargon +{ +public: + Dataset_settings_smargon(); + virtual ~Dataset_settings_smargon() = default; + + + /// + /// Validate the current data in the model. Throws a ValidationException on failure. + /// + void validate() const; + + /// + /// Validate the current data in the model. Returns false on error and writes an error + /// message into the given stringstream. + /// + bool validate(std::stringstream& msg) const; + + /// + /// Helper overload for validate. Used when one model stores another model and calls it's validate. + /// Not meant to be called outside that case. + /// + bool validate(std::stringstream& msg, const std::string& pathPrefix) const; + + bool operator==(const Dataset_settings_smargon& rhs) const; + bool operator!=(const Dataset_settings_smargon& rhs) const; + + ///////////////////////////////////////////// + /// Dataset_settings_smargon members + + /// + /// Phi angle in degrees + /// + float getPhiDeg() const; + void setPhiDeg(float const value); + /// + /// Chi angle in degrees + /// + float getChiDeg() const; + void setChiDeg(float const value); + /// + /// Phi rotation axis (defaults to the omega axis) + /// + std::vector getPhiAxis() const; + void setPhiAxis(std::vector const value); + bool phiAxisIsSet() const; + void unsetPhi_axis(); + /// + /// Chi rotation axis + /// + std::vector getChiAxis() const; + void setChiAxis(std::vector const value); + bool chiAxisIsSet() const; + void unsetChi_axis(); + + friend void to_json(nlohmann::json& j, const Dataset_settings_smargon& o); + friend void from_json(const nlohmann::json& j, Dataset_settings_smargon& o); +protected: + float m_Phi_deg; + + float m_Chi_deg; + + std::vector m_Phi_axis; + bool m_Phi_axisIsSet; + std::vector m_Chi_axis; + bool m_Chi_axisIsSet; + +}; + +} // namespace org::openapitools::server::model + +#endif /* Dataset_settings_smargon_H_ */ diff --git a/broker/jfjoch_api.yaml b/broker/jfjoch_api.yaml index 8e78be09..03e7e892 100644 --- a/broker/jfjoch_api.yaml +++ b/broker/jfjoch_api.yaml @@ -567,6 +567,43 @@ components: type: boolean description: Enable spot finding and save spots default: true + smargon: + type: object + description: | + Geometry of Smargon goniometer at SLS 2.0 / MX beamlines. + Assuming that Smargon is used as static positioner and not moving during the scan, allowing to reconstruct geometry. + required: + - phi_deg + - chi_deg + properties: + phi_deg: + type: number + format: float + description: Phi angle in degrees + chi_deg: + minimum: 0.0 + maximum: 90.0 + type: number + format: float + description: Chi angle in degrees + phi_axis: + type: array + description: Phi rotation axis (defaults to the omega axis) + example: [ 1, 0, 0 ] + items: + type: number + format: float + minItems: 3 + maxItems: 3 + chi_axis: + type: array + description: Chi rotation axis + example: [ 0, 0, 1 ] + items: + type: number + format: float + minItems: 3 + maxItems: 3 max_spot_count: type: integer minimum: 10 diff --git a/broker/redoc-static.html b/broker/redoc-static.html index d7262869..1301cb42 100644 --- a/broker/redoc-static.html +++ b/broker/redoc-static.html @@ -503,6 +503,8 @@ If parameter is not provided calibration will be saved only if more than 4 image poni_rot3_rad
number <float> [ -6.28318530718 .. 6.28318530718 ]
Default: 0

PONI angle rot3 (see PyFAI documentation for details) in radians

object (unit_cell)

Unit cell parameters. Necessary to run indexing. Units of angstrom and degree

spot_finding
boolean
Default: true

Enable spot finding and save spots

+
object

Geometry of Smargon goniometer at SLS 2.0 / MX beamlines. +Assuming that Smargon is used as static positioner and not moving during the scan, allowing to reconstruct geometry.

max_spot_count
integer [ 10 .. 2000 ]
Default: 250

Maximum number of spots that are saved/used for indexing; spots with highest intensity are selected

detect_ice_rings
boolean

Flag spots as ice rings and reduce their effect on indexing

async_start
boolean
Default: false

When set to true, /start will not wait for detector and Jungfraujoch to be ready for the measurement.

@@ -510,7 +512,7 @@ If parameter is not provided calibration will be saved only if more than 4 image

Request samples

Content type
application/json
{
  • "images_per_trigger": 1,
  • "ntrigger": 1,
  • "image_time_us": 0,
  • "beam_x_pxl": 0.1,
  • "beam_y_pxl": 0.1,
  • "detector_distance_mm": 0.1,
  • "incident_energy_keV": 0.001,
  • "file_prefix": "",
  • "images_per_file": 1000,
  • "space_group_number": 1,
  • "sample_name": "",
  • "compression": "bslz4",
  • "total_flux": 0.1,
  • "transmission": 1,
  • "goniometer": {
    },
  • "grid_scan": {
    },
  • "header_appendix": null,
  • "image_appendix": null,
  • "data_reduction_factor_serialmx": 1,
  • "pixel_value_low_threshold": 0,
  • "run_number": 0,
  • "run_name": "string",
  • "experiment_group": "string",
  • "poisson_compression": 16,
  • "write_nxmx_hdf5_master": true,
  • "save_calibration": true,
  • "polarization_factor": -1,
  • "ring_current_mA": 0.1,
  • "sample_temperature_K": 0.1,
  • "poni_rot1_rad": 0,
  • "poni_rot2_rad": 0,
  • "poni_rot3_rad": 0,
  • "unit_cell": {
    },
  • "spot_finding": true,
  • "max_spot_count": 250,
  • "detect_ice_rings": true,
  • "async_start": false,
  • "xray_fluorescence_spectrum": {
    }
}

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Wait for acquisition running

Block execution of external script till detector and Jungfraujoch are ready to collect data. +

http://localhost:5232/start

Request samples

Content type
application/json
{
  • "images_per_trigger": 1,
  • "ntrigger": 1,
  • "image_time_us": 0,
  • "beam_x_pxl": 0.1,
  • "beam_y_pxl": 0.1,
  • "detector_distance_mm": 0.1,
  • "incident_energy_keV": 0.001,
  • "file_prefix": "",
  • "images_per_file": 1000,
  • "space_group_number": 1,
  • "sample_name": "",
  • "compression": "bslz4",
  • "total_flux": 0.1,
  • "transmission": 1,
  • "goniometer": {
    },
  • "grid_scan": {
    },
  • "header_appendix": null,
  • "image_appendix": null,
  • "data_reduction_factor_serialmx": 1,
  • "pixel_value_low_threshold": 0,
  • "run_number": 0,
  • "run_name": "string",
  • "experiment_group": "string",
  • "poisson_compression": 16,
  • "write_nxmx_hdf5_master": true,
  • "save_calibration": true,
  • "polarization_factor": -1,
  • "ring_current_mA": 0.1,
  • "sample_temperature_K": 0.1,
  • "poni_rot1_rad": 0,
  • "poni_rot2_rad": 0,
  • "poni_rot3_rad": 0,
  • "unit_cell": {
    },
  • "spot_finding": true,
  • "smargon": {
    },
  • "max_spot_count": 250,
  • "detect_ice_rings": true,
  • "async_start": false,
  • "xray_fluorescence_spectrum": {
    }
}

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Wait for acquisition running

Block execution of external script till detector and Jungfraujoch are ready to collect data. To not block web server for a indefinite period of time, the procedure is provided with a timeout. Extending timeout is possible, but requires to ensure safety that client will not close the connection and retry the connection.

query Parameters
timeout
integer [ 0 .. 3600 ]
Default: 60

Timeout in seconds (0 == immediate response)

@@ -937,7 +939,7 @@ then image might be replaced in the buffer between calling /images and /image.cb