chronoptics::tof::TuiCamera Class Reference
The main interface to the tui camera. More...
#include <tui_camera.hpp>
Inheritance diagram for chronoptics::tof::TuiCamera:
Public Member Functions | |
| TuiCamera (tof_tui_camera_t ptr=nullptr) | |
| Construct from pointer. | |
| TuiCamera (StringView serial) | |
| Construct the tui camera. | |
| void | set_gpio_mode (size_t pin, GpioMode gpio_mode) |
| Set GPIO mode for a certain pin. | |
| void | set_trigger_mode (TriggerMode trigger_mode) |
| Set trigger mode. | |
| Public Member Functions inherited from chronoptics::tof::LiveCamera | |
| LiveCamera (tof_live_camera_t ptr=nullptr) | |
| Construct from pointer. | |
| const char * | version () |
| Get the tof library version running on the camera. | |
| bool | remote_update_capable () |
| Check whether the camera is capable of updating remotely. | |
| void | remote_update (StringView file_location) |
| Update the camera remotely. | |
| bool | persistent_ip_capable () const |
| Whether the camera is capable of setting persistent ip. | |
| PersistentIp | get_persistent_ip () |
| Get the current persistent ip settings. | |
| void | set_persistent_ip (const PersistentIp &persistent_ip) |
| Set the persistent ip settings. | |
| bool | apply_persistent_ip_capable () const |
| Whether the camera is capable of applying the persistent ip. | |
| void | apply_persistent_ip () |
| Apply persistent ip by rebooting the camera, power cycling the camera is discouraged because the applied ip settings might not stick. | |
| bool | software_trigger_capable () |
| Check whether the camera is capable of software trigger. | |
| void | software_trigger () |
| Software trigger the camera. | |
| uint32_t | get_delay () const |
| Get delay between network packets. | |
| void | set_delay (uint32_t delay) |
| Set delay between network packets. | |
| uint16_t | get_packet_size () const |
| Get maximum size of each network packet transmitted. | |
| void | set_packet_size (uint16_t size) |
| Set maximum size of each network packet transmitted. | |
| bool | get_temperatures_capable () |
| Whether the camera is capable of returning temperatures. | |
| std::vector< float > | get_temperatures () |
| Get the current on camera temperatures. | |
| bool | get_gpio (size_t pin) |
| Get voltage level on given pin. | |
| void | set_gpio (size_t pin, bool level) |
| Set voltage level on given pin. | |
| Public Member Functions inherited from chronoptics::tof::Camera | |
| Camera (tof_camera_t ptr=nullptr) | |
| Construct from pointer. | |
| void | start () |
| Start streaming of the camera. | |
| void | stop () |
| Stop streaming of the camera. | |
| bool | is_streaming () const |
| Check whether the camera is streaming. | |
| bool | is_connected () const |
| Check whether the camera is still connected. | |
| std::vector< Stream > | get_stream_list () const |
| Get the different output streams the camera can provide. | |
| ProcessingConfig | get_process_config () const |
| the processing config of the camera | |
| bool | has_frames () const |
| Check if the camera has frames available. | |
| std::vector< Data > | get_frames () |
| Get data frames from camera. | |
| void | clear_buffer () |
| Clear the circular buffer used to store frames. | |
| size_t | get_buffer_size () const |
| Get the circular buffer size. | |
| void | set_buffer_size (size_t size) |
| Set the circular buffer size. | |
| CameraConfig | get_camera_config () const |
| Get the currently active camera config. | |
| const char * | get_serial () const |
| Get the serial number of the current camera. | |
| Calibration | get_calibration () const |
| Get calibration from the camera. | |
| size_t | get_user_pointer_capacity () const |
| Get the amount of user pointers that can be stored. | |
| void | set_user_pointer_capacity (size_t capacity) |
| Set the amount of user pointers that can be stored. | |
| void | add_user_pointer (uint8_t *pointer, size_t capacity, user_pointer_destructed_fn &callback, FrameType frame_type) |
| Add a pointer that will be filled with the specified data type. | |
| void | add_user_pointer (uint8_t *pointer, size_t capacity, tof_user_pointer_destructed_t callback, void *callback_user_data, FrameType frame_type) |
| Add a pointer that will be filled with the specified data type. | |
| void | clear_user_pointers () |
| Clear all user pointers in memory. | |
| uint32_t | config_index () const |
| Get the currently set configuration index. | |
| void | switch_config (uint32_t config_index) |
| Switch to a different config in real time, depending on configuration and camera, this can take 100-300ms. | |
| std::vector< FrameType > | possible_frame_types () const |
| Get the frame types that this camera can output. | |
| bool | output_frame_types_set () |
| Whether output frame types have been set. | |
| std::vector< FrameType > | get_output_frame_types () const |
| Get the frame types the camera should output. | |
| void | set_output_frame_types (const std::vector< FrameType > &output_frame_types) |
| Set the frame types the camera should output. | |
| bool | has_multiple_configurations () const |
| Check if multiple configurations are set. | |
| std::vector< CameraConfig > | get_multiple_camera_configurations () const |
| Get all the set camera configurations. | |
| std::vector< ProcessingConfig > | get_multiple_processing_configurations () const |
| Get all the set processing configurations. | |
| std::vector< const char * > | get_multiple_names () const |
| Get the name for each configuration. | |
| std::vector< const char * > | get_multiple_descriptions () const |
| Get the description for each configuration. | |
Detailed Description
The main interface to the tui camera.
Definition at line 14 of file tui_camera.hpp.
Constructor & Destructor Documentation
◆ TuiCamera() [1/2]
|
inline |
Construct from pointer.
Definition at line 17 of file tui_camera.hpp.
◆ TuiCamera() [2/2]
|
inline |
Construct the tui camera.
- Parameters
-
serial The serial number of the camera to connect to, if the camera is available over both usb and gige it will be connected over usb. If an empty string is supplied the camera will connect to the first usb camera, if no usb camera is connected it will connect to the first gige camera that replies (this reply time is random, so you might connect to a different camera each time if you've got multiple cameras connected to your network).
Definition at line 27 of file tui_camera.hpp.
Member Function Documentation
◆ set_gpio_mode()
|
inline |
Set GPIO mode for a certain pin.
- Parameters
-
pin Pin gpio_mode GPIO Mode
Definition at line 33 of file tui_camera.hpp.
◆ set_trigger_mode()
|
inline |
