Solar
Public Member Functions | List of all members
SolAR::MODULES::OPENCV::SolARCameraOpencv Class Reference

Grabs current image captured by a RGB camera. UUID: 5b7396f4-a804-4f3c-a0eb-fb1d56042bb4 More...

#include <SolARCameraOpencv.h>

Inheritance diagram for SolAR::MODULES::OPENCV::SolARCameraOpencv:
Inheritance graph
[legend]
Collaboration diagram for SolAR::MODULES::OPENCV::SolARCameraOpencv:
Collaboration graph
[legend]

Public Member Functions

FrameworkReturnCode start () override
 Start the acquisition device referenced by its device_id. More...
 
FrameworkReturnCode getNextImage (SRef< datastructure::Image > &img) override
 Fill the SRef img buffer with a last image captured by the camera device. More...
 
void unloadComponent () override final
 
- Public Member Functions inherited from SolAR::MODULES::OPENCV::SolARBaseCameraOpencv
 SolARBaseCameraOpencv (const org::bcom::xpcf::uuids::uuid &uuid)
 
org::bcom::xpcf::XPCFErrorCode onConfigured () override final
 
FrameworkReturnCode stop () override
 Stop the acquisition device. More...
 
void setResolution (const datastructure::Sizei &resolution) override
 Set the size of the grabbed image from the camera. [in] resolution: the width and height of the output grabbed image.
 
void setIntrinsicParameters (const datastructure::CamCalibration &intrinsic_parameters) override
 Set the camera intrinsic parameters from a calibration matrix. [in] intrinsic_parameters: Calibration matrix containing the nine camera calibration parameters.
 
void setDistortionParameters (const datastructure::CamDistortion &distortion_parameters) override
 Set the camera distortion parameters from a distortion matrix. [in] distortion_parameters: distortion matrix containing the five camera distortion parameters.
 
void setParameters (const datastructure::CameraParameters &parameters) override
 Set the camera parameters.
 
const datastructure::CameraParameters & getParameters () const override
 
datastructure::Sizei getResolution () const override
 Get the current resolutio nof the camera. [out] width and height of the images grabbed from the camera.
 
const datastructure::CamCalibration & getIntrinsicsParameters () const override
 Get the current camera calibration parameters. [out] Calibration matrix containing the nine camera calibration parameters.
 
const datastructure::CamDistortion & getDistortionParameters () const override
 Get the current camera distortion parameters. [out] distortion matrix containing the five camera distortion parameters.
 
void unloadComponent () override
 

Additional Inherited Members

- Protected Attributes inherited from SolAR::MODULES::OPENCV::SolARBaseCameraOpencv
std::string m_calibrationFile = ""
 Path to the calibration file of the camera.
 
cv::VideoCapture m_capture
 
bool m_is_resolution_set
 
datastructure::CameraParameters m_parameters
 

Detailed Description

Grabs current image captured by a RGB camera. UUID: 5b7396f4-a804-4f3c-a0eb-fb1d56042bb4

Properties
deviceID the ID of the camera to capture with
type: uint; range : [0..MAX INT]; default: 0

Member Function Documentation

◆ getNextImage()

FrameworkReturnCode SolAR::MODULES::OPENCV::SolARCameraOpencv::getNextImage ( SRef< datastructure::Image > &  img)
override

Fill the SRef img buffer with a last image captured by the camera device.

Returns
FrameworkReturnCode to track sucessful or failing event.

◆ start()

FrameworkReturnCode SolAR::MODULES::OPENCV::SolARCameraOpencv::start ( )
override

Start the acquisition device referenced by its device_id.

Returns
FrameworkReturnCode::SUCCESS if sucessful, eiher FrameworkRetunrnCode::_ERROR.

The documentation for this class was generated from the following file: