113 lines
3.7 KiB
C++
113 lines
3.7 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.
|
|
*
|
|
* 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.
|
|
*/
|
|
/*
|
|
* Indexing_settings.h
|
|
*
|
|
* Settings for crystallography indexing
|
|
*/
|
|
|
|
#ifndef Indexing_settings_H_
|
|
#define Indexing_settings_H_
|
|
|
|
|
|
#include "Indexing_algorithm.h"
|
|
#include <nlohmann/json.hpp>
|
|
|
|
namespace org::openapitools::server::model
|
|
{
|
|
|
|
/// <summary>
|
|
/// Settings for crystallography indexing
|
|
/// </summary>
|
|
class Indexing_settings
|
|
{
|
|
public:
|
|
Indexing_settings();
|
|
virtual ~Indexing_settings() = 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 Indexing_settings& rhs) const;
|
|
bool operator!=(const Indexing_settings& rhs) const;
|
|
|
|
/////////////////////////////////////////////
|
|
/// Indexing_settings members
|
|
|
|
/// <summary>
|
|
///
|
|
/// </summary>
|
|
org::openapitools::server::model::Indexing_algorithm getAlgorithm() const;
|
|
void setAlgorithm(org::openapitools::server::model::Indexing_algorithm const& value);
|
|
/// <summary>
|
|
/// Largest unit cell to be indexed by FFT algorithm; parameter value affects execution time of FFT
|
|
/// </summary>
|
|
float getFftMaxUnitCellA() const;
|
|
void setFftMaxUnitCellA(float const value);
|
|
/// <summary>
|
|
/// Smallest unit cell to be indexed by FFT algorithm; parameter value affects execution time of FFT
|
|
/// </summary>
|
|
float getFftMinUnitCellA() const;
|
|
void setFftMinUnitCellA(float const value);
|
|
/// <summary>
|
|
/// Highest resolution of spots used for FFT algorithm; parameter value affects execution time of FFT. There is also correlation between smallest unit cell and max resolution, which need to be checked for very small systems.
|
|
/// </summary>
|
|
float getFftHighResolutionA() const;
|
|
void setFftHighResolutionA(float const value);
|
|
/// <summary>
|
|
/// Number of search directions for the FFT algorithm; parameter value affects execution time of FFT.
|
|
/// </summary>
|
|
int64_t getFftNumVectors() const;
|
|
void setFftNumVectors(int64_t const value);
|
|
/// <summary>
|
|
/// Acceptance tolerance for spots after the indexing run - the larger the number, the more spots will be accepted
|
|
/// </summary>
|
|
float getTolerance() const;
|
|
void setTolerance(float const value);
|
|
|
|
friend void to_json(nlohmann::json& j, const Indexing_settings& o);
|
|
friend void from_json(const nlohmann::json& j, Indexing_settings& o);
|
|
protected:
|
|
org::openapitools::server::model::Indexing_algorithm m_Algorithm;
|
|
|
|
float m_Fft_max_unit_cell_A;
|
|
|
|
float m_Fft_min_unit_cell_A;
|
|
|
|
float m_Fft_high_resolution_A;
|
|
|
|
int64_t m_Fft_num_vectors;
|
|
|
|
float m_Tolerance;
|
|
|
|
|
|
};
|
|
|
|
} // namespace org::openapitools::server::model
|
|
|
|
#endif /* Indexing_settings_H_ */
|