mx/Jungfraujoch
0
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases 37 Wiki Activity
Files
7ad4a3337bf51ec9c5a0f71c92c9aff9e538fc48
Jungfraujoch/broker/gen/model/Measurement_statistics.h
leonarski_f 7ad4a3337b v1.0.0-rc.58
2025-07-03 15:10:04 +02:00

269 lines
8.7 KiB
C++
Raw Blame History

/**
* 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.
*
* The version of the OpenAPI document: 1.0.0-rc.58
* 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.
*/
/*
* Measurement_statistics.h
*
*
*/
#ifndef Measurement_statistics_H_
#define Measurement_statistics_H_
#include <string>
#include <nlohmann/json.hpp>
namespace org::openapitools::server::model
{
/// <summary>
///
/// </summary>
class Measurement_statistics
{
public:
Measurement_statistics();
virtual ~Measurement_statistics() = default;
/// <summary>
/// Validate the current data in the model. Throws a ValidationException on failure.
/// </summary>
void validate() const;
/// <summary>
/// Validate the current data in the model. Returns false on error and writes an error
/// message into the given stringstream.
/// </summary>
bool validate(std::stringstream& msg) const;
/// <summary>
/// Helper overload for validate. Used when one model stores another model and calls it's validate.
/// Not meant to be called outside that case.
/// </summary>
bool validate(std::stringstream& msg, const std::string& pathPrefix) const;
bool operator==(const Measurement_statistics& rhs) const;
bool operator!=(const Measurement_statistics& rhs) const;
/////////////////////////////////////////////
/// Measurement_statistics members
/// <summary>
///
/// </summary>
std::string getFilePrefix() const;
void setFilePrefix(std::string const& value);
bool filePrefixIsSet() const;
void unsetFile_prefix();
/// <summary>
/// Number of data collection run. This can be either automatically incremented or provided externally for each data collection.
/// </summary>
int64_t getRunNumber() const;
void setRunNumber(int64_t const value);
bool runNumberIsSet() const;
void unsetRun_number();
/// <summary>
/// Name of group owning the data (e.g. p-group or proposal number).
/// </summary>
std::string getExperimentGroup() const;
void setExperimentGroup(std::string const& value);
bool experimentGroupIsSet() const;
void unsetExperiment_group();
/// <summary>
///
/// </summary>
int64_t getImagesExpected() const;
void setImagesExpected(int64_t const value);
bool imagesExpectedIsSet() const;
void unsetImages_expected();
/// <summary>
/// Images collected by the receiver. This number will be lower than images expected if there were issues with data collection performance.
/// </summary>
int64_t getImagesCollected() const;
void setImagesCollected(int64_t const value);
bool imagesCollectedIsSet() const;
void unsetImages_collected();
/// <summary>
/// Images sent to the writer. The value does not include images discarded by lossy compression filter and images not forwarded due to full ZeroMQ queue.
/// </summary>
int64_t getImagesSent() const;
void setImagesSent(int64_t const value);
bool imagesSentIsSet() const;
void unsetImages_sent();
/// <summary>
/// Images discarded by the lossy compression filter
/// </summary>
int64_t getImagesDiscardedLossyCompression() const;
void setImagesDiscardedLossyCompression(int64_t const value);
bool imagesDiscardedLossyCompressionIsSet() const;
void unsetImages_discarded_lossy_compression();
/// <summary>
///
/// </summary>
int64_t getMaxImageNumberSent() const;
void setMaxImageNumberSent(int64_t const value);
bool maxImageNumberSentIsSet() const;
void unsetMax_image_number_sent();
/// <summary>
///
/// </summary>
float getCollectionEfficiency() const;
void setCollectionEfficiency(float const value);
bool collectionEfficiencyIsSet() const;
void unsetCollection_efficiency();
/// <summary>
///
/// </summary>
float getCompressionRatio() const;
void setCompressionRatio(float const value);
bool compressionRatioIsSet() const;
void unsetCompression_ratio();
/// <summary>
///
/// </summary>
bool isCancelled() const;
void setCancelled(bool const value);
bool cancelledIsSet() const;
void unsetCancelled();
/// <summary>
///
/// </summary>
int64_t getMaxReceiverDelay() const;
void setMaxReceiverDelay(int64_t const value);
bool maxReceiverDelayIsSet() const;
void unsetMax_receiver_delay();
/// <summary>
///
/// </summary>
float getIndexingRate() const;
void setIndexingRate(float const value);
bool indexingRateIsSet() const;
void unsetIndexing_rate();
/// <summary>
///
/// </summary>
int64_t getDetectorWidth() const;
void setDetectorWidth(int64_t const value);
bool detectorWidthIsSet() const;
void unsetDetector_width();
/// <summary>
///
/// </summary>
int64_t getDetectorHeight() const;
void setDetectorHeight(int64_t const value);
bool detectorHeightIsSet() const;
void unsetDetector_height();
/// <summary>
///
/// </summary>
int64_t getDetectorPixelDepth() const;
void setDetectorPixelDepth(int64_t const value);
bool detectorPixelDepthIsSet() const;
void unsetDetector_pixel_depth();
/// <summary>
///
/// </summary>
float getBkgEstimate() const;
void setBkgEstimate(float const value);
bool bkgEstimateIsSet() const;
void unsetBkg_estimate();
/// <summary>
///
/// </summary>
std::string getUnitCell() const;
void setUnitCell(std::string const& value);
bool unitCellIsSet() const;
void unsetUnit_cell();
/// <summary>
/// Moving average of 1000 images counting number of error pixels on the detector
/// </summary>
float getErrorPixels() const;
void setErrorPixels(float const value);
bool errorPixelsIsSet() const;
void unsetError_pixels();
/// <summary>
/// Moving average of 1000 images counting number of saturated pixels on the detector
/// </summary>
float getSaturatedPixels() const;
void setSaturatedPixels(float const value);
bool saturatedPixelsIsSet() const;
void unsetSaturated_pixels();
/// <summary>
/// If there is an ROI defined with name \&quot;beam\&quot;, this number will hold moving average of 1000 images for number of valid pixels within this ROI
/// </summary>
float getRoiBeamPixels() const;
void setRoiBeamPixels(float const value);
bool roiBeamPixelsIsSet() const;
void unsetRoi_beam_pixels();
/// <summary>
/// If there is an ROI defined with name \&quot;beam\&quot;, this number will hold moving average of 1000 images for sum of valid pixels within this ROI
/// </summary>
float getRoiBeamSum() const;
void setRoiBeamSum(float const value);
bool roiBeamSumIsSet() const;
void unsetRoi_beam_sum();
friend void to_json(nlohmann::json& j, const Measurement_statistics& o);
friend void from_json(const nlohmann::json& j, Measurement_statistics& o);
protected:
std::string m_File_prefix;
bool m_File_prefixIsSet;
int64_t m_Run_number;
bool m_Run_numberIsSet;
std::string m_Experiment_group;
bool m_Experiment_groupIsSet;
int64_t m_Images_expected;
bool m_Images_expectedIsSet;
int64_t m_Images_collected;
bool m_Images_collectedIsSet;
int64_t m_Images_sent;
bool m_Images_sentIsSet;
int64_t m_Images_discarded_lossy_compression;
bool m_Images_discarded_lossy_compressionIsSet;
int64_t m_Max_image_number_sent;
bool m_Max_image_number_sentIsSet;
float m_Collection_efficiency;
bool m_Collection_efficiencyIsSet;
float m_Compression_ratio;
bool m_Compression_ratioIsSet;
bool m_Cancelled;
bool m_CancelledIsSet;
int64_t m_Max_receiver_delay;
bool m_Max_receiver_delayIsSet;
float m_Indexing_rate;
bool m_Indexing_rateIsSet;
int64_t m_Detector_width;
bool m_Detector_widthIsSet;
int64_t m_Detector_height;
bool m_Detector_heightIsSet;
int64_t m_Detector_pixel_depth;
bool m_Detector_pixel_depthIsSet;
float m_Bkg_estimate;
bool m_Bkg_estimateIsSet;
std::string m_Unit_cell;
bool m_Unit_cellIsSet;
float m_Error_pixels;
bool m_Error_pixelsIsSet;
float m_Saturated_pixels;
bool m_Saturated_pixelsIsSet;
float m_Roi_beam_pixels;
bool m_Roi_beam_pixelsIsSet;
float m_Roi_beam_sum;
bool m_Roi_beam_sumIsSet;
};
} // namespace org::openapitools::server::model
#endif /* Measurement_statistics_H_ */
Reference in New Issue View Git Blame Copy Permalink