ccd.h

Go to the documentation of this file.

#ifndef CCD_H
#define CCD_H
 
#include <horiba_cpp_sdk/communication/communicator.h>
#include <horiba_cpp_sdk/devices/single_devices/device.h>
 
#include <any>
#include <memory>
#include <nlohmann/json.hpp>
#include <stdexcept>
#include <string>
#include <unordered_map>
#include <vector>
 
namespace horiba::devices::single_devices {
class ChargeCoupledDevice final : public Device {
 public:
  enum class AcquisitionFormat : int {
    SPECTRA = 0,
    IMAGE,
    CROP,
    FAST_KINETICS,
  };

  enum class XAxisConversionType : int {
    NONE = 0,
    FROM_CCD_FIRMWARE,
    FROM_ICL_SETTINGS_INI
  };
 
  enum class CleanCountMode : int {
    NEVER = 0,
    FIRST_ONLY = 1,
    BETWEEN_ONLY = 2,
    EACH = 3,
    MODE_UNKNOWN = 238,
  };
 
  enum class TimerResolution : int {
    THOUSAND_MICROSECONDS = 0,
    ONE_MICROSECOND
  };
 
  ChargeCoupledDevice(
      int id, std::shared_ptr<communication::Communicator> communicator);
  ~ChargeCoupledDevice() override = default;

  void open() noexcept(false) override;

  void close() noexcept(false) override;

  bool is_open() noexcept(false);

  void restart() noexcept(false);

  nlohmann::json get_configuration();

  int get_gain_token() noexcept(false);

  void set_gain(int gain_token) noexcept(false);

  int get_speed_token() noexcept(false);

  void set_speed(int speed_token) noexcept(false);

  int get_parallel_speed_token() noexcept(false);

  void set_parallel_speed(int parallel_speed_token) noexcept(false);

  std::vector<int> get_fit_parameters() noexcept(false);

  ChargeCoupledDevice::TimerResolution get_timer_resolution() noexcept(false);

  void set_timer_resolution(
      ChargeCoupledDevice::TimerResolution timer_resolution) noexcept(false);

  void set_acquisition_format(
      int number_of_rois, AcquisitionFormat acquisition_format) noexcept(false);

  XAxisConversionType get_x_axis_conversion_type() noexcept(false);

  void set_x_axis_conversion_type(XAxisConversionType conversion_type) noexcept(
      false);

  int get_acquisition_count() noexcept(false);

  void set_acquisition_count(int count) noexcept(false);

  std::pair<int, ChargeCoupledDevice::CleanCountMode>
  get_clean_count() noexcept(false);

  void set_clean_count(
      int count, ChargeCoupledDevice::CleanCountMode mode) noexcept(false);

  int get_acquisition_data_size() noexcept(false);

  double get_temperature() noexcept(false);

  std::pair<int, int> get_chip_size() noexcept(false);

  int get_exposure_time() noexcept(false);

  void set_exposure_time(int exposure_time_ms) noexcept(false);

  std::tuple<bool, int, int, int> get_trigger_input() noexcept(false);

  void set_trigger_input(bool enabled, int address, int event,
                         int signal_type) noexcept(false);

  std::tuple<bool, int, int, int> get_signal_output() noexcept(false);

  void set_signal_output(bool enabled, int address, int event,
                         int signal_type) noexcept(false);

  bool get_acquisition_ready() noexcept(false);

  void set_acquisition_start(bool open_shutter) noexcept(false);

  void set_region_of_interest(int roi_index = 1, int x_origin = 0,
                              int y_origin = 0, int x_size = 1024,
                              int y_size = 256, int x_bin = 1,
                              int y_bin = 256) noexcept(false);

  std::any get_acquisition_data() noexcept(false);

  bool get_acquisition_busy() noexcept(false);

  void abort_acquisition() noexcept(false);

  void set_center_wavelength(int monochromator_id,
                             double wavelength) noexcept(false);

  std::vector<double> range_mode_center_wavelenghts(
      int monochromator_id, double start_wavelength, double end_wavelength,
      double pixel_overlap) noexcept(false);
};
} /* namespace horiba::devices::single_devices */
#endif /* ifndef CCD_H */