Class cuvis::AcquisitionContext

ClassList > cuvis > AcquisitionContext

• #include <cuvis.hpp>

Classes

Type	Name
struct	component_state_info_t

Public Types

Type	Name
typedef std::pair< std::string, bool >	component_state_t
typedef std::function< void(Measurement)>	mesu_callback_t
typedef std::function< void(hardware_state_t, std::map< int_t, component_state_info_t >)>	state_callback_t

Public Functions

Type	Name
	ACQ_STUB_0a (fps, cuvis_acq_cont_fps, double, double)
	ACQ_STUB_0a (integration_time, cuvis_acq_cont_integration_time, double, double)
	ACQ_STUB_0a (auto_exp, cuvis_acq_cont_auto_exp, int_t, bool)
	ACQ_STUB_0a (auto_exp_comp, cuvis_acq_cont_auto_exp_comp, double, double)
	ACQ_STUB_0a (operation_mode, cuvis_acq_cont_operation_mode, cuvis_operation_mode_t, operation_mode_t)
	ACQ_STUB_0a (average, cuvis_acq_cont_average, int_t, int)
	ACQ_STUB_0a (bandwidth, cuvis_acq_cont_bandwidth, int_t, int)
	ACQ_STUB_0a (queue_size, cuvis_acq_cont_queue_size, int_t, int)
	ACQ_STUB_0a (queue_used, cuvis_acq_cont_queue_used, int_t, int)
	ACQ_STUB_0b (fps, cuvis_acq_cont_fps, double, double)
	ACQ_STUB_0b (integration_time, cuvis_acq_cont_integration_time, double, double)
	ACQ_STUB_0b (auto_exp, cuvis_acq_cont_auto_exp, int_t, bool)
	ACQ_STUB_0b (auto_exp_comp, cuvis_acq_cont_auto_exp_comp, double, double)
	ACQ_STUB_0b (operation_mode, cuvis_acq_cont_operation_mode, cuvis_operation_mode_t, operation_mode_t)
	ACQ_STUB_0b (average, cuvis_acq_cont_average, int_t, int)
	ACQ_STUB_0b (continuous, cuvis_acq_cont_continuous, int_t, int)
	ACQ_STUB_1a (component_online, cuvis_comp_online, int_t, int)
	ACQ_STUB_1a (component_gain, cuvis_comp_gain, double, double)
	ACQ_STUB_1a (component_integration_time_factor, cuvis_comp_integration_time_factor, double, double)
	ACQ_STUB_1a (bandwidth, cuvis_comp_bandwidth, int_t, int)
	ACQ_STUB_1a (driver_queue_size, cuvis_comp_driver_queue_size, int_t, size_t)
	ACQ_STUB_1a (driver_queue_used, cuvis_comp_driver_queue_used, int_t, size_t)
	ACQ_STUB_1a (hardware_queue_size, cuvis_comp_hardware_queue_size, int_t, size_t)
	ACQ_STUB_1a (hardware_queue_used, cuvis_comp_hardware_queue_used, int_t, size_t)
	ACQ_STUB_1a (temperature, cuvis_comp_temperature, double, double)
	ACQ_STUB_1b (component_gain, cuvis_comp_gain, double, double)
	ACQ_STUB_1b (component_integration_time_factor, cuvis_comp_integration_time_factor, double, double)
	AcquisitionContext (Calibration const & calib)
	AcquisitionContext (SessionFile const & sess, bool simulate=false)
	AcquisitionContext (CUVIS_ACQ_CONT handle) Expert: Create a wrapper class around a handle. This only allowed once per handle, otherwise the handle could be freed before all instances of the wrapper class are deleted. This can be useful if a previously a handle has been copied and now should be wrapped at another place in a program. Most of the time this is not necesarry and the wrapper class can be copied just as well.
AsyncMesu	capture ()
void	capture_queue ()
std::vector< std::string >	get_component_available_pixel_formats (int_t id) const
int_t	get_component_count () const
CUVIS_COMPONENT_INFO	get_component_info (int_t id) const
std::string	get_component_pixel_format (int id) const
bool	get_dead_pixel_correction_available () const
bool	get_dead_pixel_correction_enabled () const
CUVIS_ACQ_CONT	get_handle () const Expert: Return the current handle of the wrapper class.
CUVIS_ACQ_CONT	get_handle_copy () const Expert: Create a copy of the current handle of the wrapper class and return it. This handle needs to be also freed before the resource will be released by the sdk.
std::optional< Measurement >	get_next_measurement (std::chrono::milliseconds timeout_ms=std::chrono::milliseconds(0)) const
SessionInfo	get_session_info () const
hardware_state_t	get_state () const
bool	has_next_measurement () const
bool	is_ready () const
void	register_state_change_callback (state_callback_t callback, bool output_initial_state=true)
void	reset_state_change_callback ()
Async	set_component_pixel_format (int id, std::string format)
void	set_dead_pixel_correction_enabled (bool enable)
void	set_queue_size (int_t size)
void	set_session_info (SessionInfo session)
	~AcquisitionContext ()

Public Types Documentation

typedef component_state_t

using cuvis::AcquisitionContext::component_state_t =  std::pair<std::string, bool>;

---

typedef mesu_callback_t

using cuvis::AcquisitionContext::mesu_callback_t =  std::function<void(Measurement)>;

---

typedef state_callback_t

using cuvis::AcquisitionContext::state_callback_t =  std::function<void(hardware_state_t, std::map<int_t, component_state_info_t>)>;

---

Public Functions Documentation

function ACQ_STUB_0a [1/9]

cuvis::AcquisitionContext::ACQ_STUB_0a (
    fps,
    cuvis_acq_cont_fps,
    double,
    double
) 

---

function ACQ_STUB_0a [2/9]

cuvis::AcquisitionContext::ACQ_STUB_0a (
    integration_time,
    cuvis_acq_cont_integration_time,
    double,
    double
) 

---

function ACQ_STUB_0a [3/9]

cuvis::AcquisitionContext::ACQ_STUB_0a (
    auto_exp,
    cuvis_acq_cont_auto_exp,
    int_t,
    bool
) 

---

function ACQ_STUB_0a [4/9]

cuvis::AcquisitionContext::ACQ_STUB_0a (
    auto_exp_comp,
    cuvis_acq_cont_auto_exp_comp,
    double,
    double
) 

---

function ACQ_STUB_0a [5/9]

cuvis::AcquisitionContext::ACQ_STUB_0a (
    operation_mode,
    cuvis_acq_cont_operation_mode,
    cuvis_operation_mode_t,
    operation_mode_t
) 

---

function ACQ_STUB_0a [6/9]

cuvis::AcquisitionContext::ACQ_STUB_0a (
    average,
    cuvis_acq_cont_average,
    int_t,
    int
) 

---

function ACQ_STUB_0a [7/9]

cuvis::AcquisitionContext::ACQ_STUB_0a (
    bandwidth,
    cuvis_acq_cont_bandwidth,
    int_t,
    int
) 

---

function ACQ_STUB_0a [8/9]

cuvis::AcquisitionContext::ACQ_STUB_0a (
    queue_size,
    cuvis_acq_cont_queue_size,
    int_t,
    int
) 

---

function ACQ_STUB_0a [9/9]

cuvis::AcquisitionContext::ACQ_STUB_0a (
    queue_used,
    cuvis_acq_cont_queue_used,
    int_t,
    int
) 

---

function ACQ_STUB_0b [1/7]

cuvis::AcquisitionContext::ACQ_STUB_0b (
    fps,
    cuvis_acq_cont_fps,
    double,
    double
) 

---

function ACQ_STUB_0b [2/7]

cuvis::AcquisitionContext::ACQ_STUB_0b (
    integration_time,
    cuvis_acq_cont_integration_time,
    double,
    double
) 

---

function ACQ_STUB_0b [3/7]

cuvis::AcquisitionContext::ACQ_STUB_0b (
    auto_exp,
    cuvis_acq_cont_auto_exp,
    int_t,
    bool
) 

---

function ACQ_STUB_0b [4/7]

cuvis::AcquisitionContext::ACQ_STUB_0b (
    auto_exp_comp,
    cuvis_acq_cont_auto_exp_comp,
    double,
    double
) 

---

function ACQ_STUB_0b [5/7]

cuvis::AcquisitionContext::ACQ_STUB_0b (
    operation_mode,
    cuvis_acq_cont_operation_mode,
    cuvis_operation_mode_t,
    operation_mode_t
) 

---

function ACQ_STUB_0b [6/7]

cuvis::AcquisitionContext::ACQ_STUB_0b (
    average,
    cuvis_acq_cont_average,
    int_t,
    int
) 

---

function ACQ_STUB_0b [7/7]

cuvis::AcquisitionContext::ACQ_STUB_0b (
    continuous,
    cuvis_acq_cont_continuous,
    int_t,
    int
) 

---

function ACQ_STUB_1a [1/9]

cuvis::AcquisitionContext::ACQ_STUB_1a (
    component_online,
    cuvis_comp_online,
    int_t,
    int
) 

---

function ACQ_STUB_1a [2/9]

cuvis::AcquisitionContext::ACQ_STUB_1a (
    component_gain,
    cuvis_comp_gain,
    double,
    double
) 

---

function ACQ_STUB_1a [3/9]

cuvis::AcquisitionContext::ACQ_STUB_1a (
    component_integration_time_factor,
    cuvis_comp_integration_time_factor,
    double,
    double
) 

---

function ACQ_STUB_1a [4/9]

cuvis::AcquisitionContext::ACQ_STUB_1a (
    bandwidth,
    cuvis_comp_bandwidth,
    int_t,
    int
) 

---

function ACQ_STUB_1a [5/9]

cuvis::AcquisitionContext::ACQ_STUB_1a (
    driver_queue_size,
    cuvis_comp_driver_queue_size,
    int_t,
    size_t
) 

---

function ACQ_STUB_1a [6/9]

cuvis::AcquisitionContext::ACQ_STUB_1a (
    driver_queue_used,
    cuvis_comp_driver_queue_used,
    int_t,
    size_t
) 

---

function ACQ_STUB_1a [7/9]

cuvis::AcquisitionContext::ACQ_STUB_1a (
    hardware_queue_size,
    cuvis_comp_hardware_queue_size,
    int_t,
    size_t
) 

---

function ACQ_STUB_1a [8/9]

cuvis::AcquisitionContext::ACQ_STUB_1a (
    hardware_queue_used,
    cuvis_comp_hardware_queue_used,
    int_t,
    size_t
) 

---

function ACQ_STUB_1a [9/9]

cuvis::AcquisitionContext::ACQ_STUB_1a (
    temperature,
    cuvis_comp_temperature,
    double,
    double
) 

---

function ACQ_STUB_1b [1/2]

cuvis::AcquisitionContext::ACQ_STUB_1b (
    component_gain,
    cuvis_comp_gain,
    double,
    double
) 

---

function ACQ_STUB_1b [2/2]

cuvis::AcquisitionContext::ACQ_STUB_1b (
    component_integration_time_factor,
    cuvis_comp_integration_time_factor,
    double,
    double
) 

---

function AcquisitionContext [1/3]

cuvis::AcquisitionContext::AcquisitionContext (
    Calibration  const & calib
) 

---

function AcquisitionContext [2/3]

cuvis::AcquisitionContext::AcquisitionContext (
    SessionFile  const & sess,
    bool simulate=false
) 

---

function AcquisitionContext [3/3]

Expert: Create a wrapper class around a handle. This only allowed once per handle, otherwise the handle could be freed before all instances of the wrapper class are deleted. This can be useful if a previously a handle has been copied and now should be wrapped at another place in a program. Most of the time this is not necesarry and the wrapper class can be copied just as well.

cuvis::AcquisitionContext::AcquisitionContext (
    CUVIS_ACQ_CONT handle
) 

---

function capture

AsyncMesu cuvis::AcquisitionContext::capture () 

---

function capture_queue

void cuvis::AcquisitionContext::capture_queue () 

---

function get_component_available_pixel_formats

std::vector< std::string > cuvis::AcquisitionContext::get_component_available_pixel_formats (
    int_t id
) const

---

function get_component_count

int_t cuvis::AcquisitionContext::get_component_count () const

---

function get_component_info

CUVIS_COMPONENT_INFO cuvis::AcquisitionContext::get_component_info (
    int_t id
) const

---

function get_component_pixel_format

std::string cuvis::AcquisitionContext::get_component_pixel_format (
    int id
) const

---

function get_dead_pixel_correction_available

bool cuvis::AcquisitionContext::get_dead_pixel_correction_available () const

---

function get_dead_pixel_correction_enabled

bool cuvis::AcquisitionContext::get_dead_pixel_correction_enabled () const

---

function get_handle

Expert: Return the current handle of the wrapper class.

CUVIS_ACQ_CONT cuvis::AcquisitionContext::get_handle () const

---

function get_handle_copy

Expert: Create a copy of the current handle of the wrapper class and return it. This handle needs to be also freed before the resource will be released by the sdk.

CUVIS_ACQ_CONT cuvis::AcquisitionContext::get_handle_copy () const

---

function get_next_measurement

std::optional< Measurement > cuvis::AcquisitionContext::get_next_measurement (
    std::chrono::milliseconds timeout_ms=std::chrono::milliseconds(0)
) const

---

function get_session_info

SessionInfo cuvis::AcquisitionContext::get_session_info () const

---

function get_state

hardware_state_t cuvis::AcquisitionContext::get_state () const

---

function has_next_measurement

bool cuvis::AcquisitionContext::has_next_measurement () const

---

function is_ready

bool cuvis::AcquisitionContext::is_ready () const

---

function register_state_change_callback

void cuvis::AcquisitionContext::register_state_change_callback (
    state_callback_t callback,
    bool output_initial_state=true
) 

---

function reset_state_change_callback

void cuvis::AcquisitionContext::reset_state_change_callback () 

---

function set_component_pixel_format

Async cuvis::AcquisitionContext::set_component_pixel_format (
    int id,
    std::string format
) 

---

function set_dead_pixel_correction_enabled

void cuvis::AcquisitionContext::set_dead_pixel_correction_enabled (
    bool enable
) 

---

function set_queue_size

void cuvis::AcquisitionContext::set_queue_size (
    int_t size
) 

---

function set_session_info

void cuvis::AcquisitionContext::set_session_info (
    SessionInfo session
) 

---

function ~AcquisitionContext

cuvis::AcquisitionContext::~AcquisitionContext () 

---

---

The documentation for this class was generated from the following file cuvis.cpp/interface/cuvis.hpp