.. _program_listing_file_include_dx2_goniometer.hpp:

Program Listing for File goniometer.hpp
=======================================

|exhale_lsh| :ref:`Return to documentation for file <file_include_dx2_goniometer.hpp>` (``include/dx2/goniometer.hpp``)

.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS

.. code-block:: cpp

   #pragma once
   
   #include <Eigen/Dense>
   #include <nlohmann/json.hpp>
   
   using json = nlohmann::json;
   using Eigen::Matrix3d;
   using Eigen::Vector3d;
   
   Matrix3d axis_and_angle_as_matrix(Vector3d axis, double angle,
                                     bool deg = false);
   
   class Goniometer {
     // A class to represent a multi-axis goniometer.
     // A single-axis goniometer just doesn't have axes and angles defined.
   public:
     Goniometer() = default;
     Goniometer(std::vector<Vector3d> axes, std::vector<double> angles,
                std::vector<std::string> names, std::size_t scan_axis);
     Goniometer(json goniometer_data);
     Goniometer(Matrix3d sample_rotation, Vector3d axis,
                Matrix3d setting_rotation);
     Matrix3d get_setting_rotation() const;
     Matrix3d get_sample_rotation() const;
     Vector3d get_rotation_axis() const;
     json to_json() const;
   
   protected:
     void init(); // Sets the matrices from the axes and angles for multi-axis
                  // goniometers.
     // These two functions calculate F and S for multi-axis goniometers.
     Matrix3d calculate_setting_rotation();
     Matrix3d calculate_sample_rotation();
     // The core 2 matrices and rotation axis that define a goniometer.
     Matrix3d sample_rotation_{{1, 0, 0}, {0, 1, 0}, {0, 0, 1}};  // F
     Vector3d rotation_axis_{{1.0, 0.0, 0.0}};                    // R'
     Matrix3d setting_rotation_{{1, 0, 0}, {0, 1, 0}, {0, 0, 1}}; // S
     // The next three quantities do not get non-empty defaults - only needed
     // to hold additional information for multi-axis goniometers.
     std::vector<Vector3d> axes_{};
     std::vector<double> angles_{};
     std::vector<std::string> names_{};
     std::size_t scan_axis_ = 0;
   };