Manipulates the underlying camera system. More...

#include <camera.h>

Public Member Functions
virtual	~Camera ()=default
	Destructor.

virtual Status	initialize (const std::string &configFilepath={})=0
	Initialize the camera. This is required before performing any operation on the camera. More...

virtual Status	start ()=0
	Start the camera. This starts the streaming of data from the camera. More...

virtual Status	stop ()=0
	Stop the camera. This makes the camera to stop streaming. More...

virtual Status	setMode (const std::string &mode, const std::string &modeFilename={})=0
	Puts the camera into the given mode. DEPRECATED! NOTE: This method is deprecated. Use 'setFrameType' instead. More...

virtual Status	getAvailableModes (std::vector< std::string > &availableModes) const =0
	Returns all the modes that are supported by the camera. DEPRECATED! NOTE: This method is deprecated. Use 'getAvailableFrameTypes' instead. More...

virtual Status	setFrameType (const std::string &frameType)=0
	Set the camera frame type to the given type. More...

virtual Status	getIniParams (std::map< std::string, float > &params)=0
	Get the Depth Compute Library ini parameters. More...

virtual Status	setIniParams (std::map< std::string, float > &params)=0
	Set the Depth Compute Library ini parameters. More...

virtual Status	adsd3500SetIniParams (const std::map< std::string, float > &iniKeyValPairs)=0
	Set the adsd3500 ini parameters. More...

virtual Status	getAvailableFrameTypes (std::vector< std::string > &availableFrameTypes) const =0
	Returns all the frame types that are supported by the camera. More...

virtual Status	getFrameTypeNameFromId (int id, std::string &name) const =0
	Returns the name of the frame type for the given ID. More...

virtual Status	requestFrame (Frame *frame)=0
	Captures data from the camera and assigns it to the given frame. More...

virtual Status	getDetails (CameraDetails &details) const =0
	Gets the current details of the camera. More...

virtual Status	getAvailableControls (std::vector< std::string > &controls) const =0
	Gets the camera's list of controls. More...

virtual Status	setControl (const std::string &control, const std::string &value)=0
	Sets a specific camera control. More...

virtual Status	getControl (const std::string &control, std::string &value) const =0
	Gets the value of a specific camera control. More...

virtual std::shared_ptr< DepthSensorInterface >	getSensor ()=0
	Gets the sensor of the camera. This gives direct access to low level configuration of the camera sensor. More...

virtual Status	enableXYZframe (bool enable)=0
	Enable the generation of a XYZ frame. The XYZ frame can be enabled or disabled through .ini configuration file but if this method is explicitly called then it will override the option in the .ini file. By default XYZ frame is disabled. More...

virtual Status	saveModuleCFG (const std::string &filepath) const =0
	Save the CFG content which is obtained from module memory to a given file path. More...

virtual Status	saveModuleCCB (const std::string &filepath)=0
	Save the CCB content which is obtained from module memory to a given file path. More...

virtual Status	enableDepthCompute (bool enable)=0
	Enable or disable the depth processing on the frames received from the sensor Must be called after getFrame() where the depth processing happens. More...

virtual Status	adsd3500UpdateFirmware (const std::string &fwFilePath)=0
	Update the firmware of ADSD3500 with the content found in the specified file. More...

virtual Status	adsd3500SetToggleMode (int mode)=0
	Enables or disables FSYNC toggle for ADSD3500. More...

virtual Status	adsd3500ToggleFsync ()=0
	Toggles ADSD3500 FSYNC once if automated FSYNC is disabled. More...

virtual Status	adsd3500SetABinvalidationThreshold (int threshold)=0
	Set the AB invalidation threshold. More...

virtual Status	adsd3500GetABinvalidationThreshold (int &threshold)=0
	Get the AB invalidation threshold. More...

virtual Status	adsd3500SetConfidenceThreshold (int threshold)=0
	Set the confidence threshold. More...

virtual Status	adsd3500GetConfidenceThreshold (int &threshold)=0
	Get the confidence threshold. More...

virtual Status	adsd3500SetJBLFfilterEnableState (bool enable)=0
	Enable/disable the JBLF filter. More...

virtual Status	adsd3500GetJBLFfilterEnableState (bool &enabled)=0
	Get the JBLF enabled state. More...

virtual Status	adsd3500SetJBLFfilterSize (int size)=0
	Set the JBLF filter size. More...

virtual Status	adsd3500GetJBLFfilterSize (int &size)=0
	Get the JBLF filter size. More...

virtual Status	adsd3500SetRadialThresholdMin (int threshold)=0
	Set the radial threshold min. More...

virtual Status	adsd3500GetRadialThresholdMin (int &threshold)=0
	Get the radial threshold min. More...

virtual Status	adsd3500SetRadialThresholdMax (int threshold)=0
	Set the radial threshold max. More...

virtual Status	adsd3500GetRadialThresholdMax (int &threshold)=0
	Get the radial threshold max. More...

virtual Status	adsd3500GetSensorTemperature (uint16_t &tmpValue)=0
	Get the sensor temperature. More...

virtual Status	adsd3500GetLaserTemperature (uint16_t &tmpValue)=0
	Get the laser temperature. More...

virtual Status	adsd3500GetFirmwareVersion (std::string &fwVersion, std::string &fwHash)=0

virtual Status	adsd3500SetMIPIOutputSpeed (uint16_t speed)=0
	Set ADSD3500 MIPI output speed. More...

virtual Status	adsd3500GetMIPIOutputSpeed (uint16_t &speed)=0
	Get ADSD3500 MIPI output speed. More...

virtual Status	adsd3500GetImagerErrorCode (uint16_t &errcode)=0
	Get error code from the imager. More...

virtual Status	adsd3500SetVCSELDelay (uint16_t delay)=0
	Set the delay for VCSEL - ADSD3100 imager only. More...

virtual Status	adsd3500GetVCSELDelay (uint16_t &delay)=0
	Get the delay for VCSEL - ADSD3100 imager only. More...

virtual Status	adsd3500SetJBLFMaxEdgeThreshold (uint16_t threshold)=0
	Set JBLF Max Edge Threshold. More...

virtual Status	adsd3500SetJBLFABThreshold (uint16_t threshold)=0
	Get JBLF Max Edge Threshold. More...

virtual Status	adsd3500SetJBLFGaussianSigma (uint16_t value)=0
	Set JBLF Gaussian Sigma. More...

virtual Status	adsd3500GetJBLFGaussianSigma (uint16_t &value)=0
	Get JBLF Gaussian Sigma. More...

virtual Status	adsd3500SetJBLFExponentialTerm (uint16_t value)=0
	Set JBLF Exponential Term. More...

virtual Status	adsd3500GetJBLFExponentialTerm (uint16_t &value)=0
	Get JBLF Exponential Term. More...

virtual Status	adsd3500GetFrameRate (uint16_t &fps)=0
	Get Frame Rate. More...

virtual Status	adsd3500SetFrameRate (uint16_t fps)=0
	Set Frame Rate. More...

virtual Status	adsd3500SetEnableEdgeConfidence (uint16_t value)=0
	Set Enable Edge Confidence. More...

virtual Status	adsd3500GetTemperatureCompensationStatus (uint16_t &value)=0
	Get Temperature Compensation Status. More...

virtual Status	adsd3500SetEnablePhaseInvalidation (uint16_t value)=0
	Set Enable Phase Invalidation. More...

virtual Status	adsd3500SetEnableTemperatureCompensation (uint16_t value)=0
	Set Enable Temperature Compensation. More...

virtual aditof::Status	adsd3500SetEnableMetadatainAB (uint16_t value)=0
	Set Enable Metadata in the AB frame. More...

virtual aditof::Status	adsd3500GetEnableMetadatainAB (uint16_t &value)=0
	Get state of Enable Metadata in the AB frame. More...

virtual Status	adsd3500SetGenericTemplate (uint16_t reg, uint16_t value)=0
	Generic ADSD3500 function for commands not defined in the SDK (yet) More...

virtual Status	adsd3500GetGenericTemplate (uint16_t reg, uint16_t &value)=0
	Generic ADSD3500 function for commands not defined in the SDK (yet) More...

virtual Status	adsd3500GetStatus (int &chipStatus, int &imagerStatus)=0
	Returns the chip status. More...

virtual Status	readSerialNumber (std::string &serialNumber, bool useCacheValue=false)=0
	Read serial number from camera and update cache. More...

virtual Status	getImagerType (ImagerType &imagerType) const =0
	Provides the type of the imager. More...

Detailed Description

Manipulates the underlying camera system.

Definition at line 54 of file camera.h.

Member Function Documentation

◆ adsd3500GetABinvalidationThreshold()

virtual Status aditof::Camera::adsd3500GetABinvalidationThreshold ( int & threshold )

pure virtual

Get the AB invalidation threshold.

Parameters

[out] threshold

Returns: Status

◆ adsd3500GetConfidenceThreshold()

virtual Status aditof::Camera::adsd3500GetConfidenceThreshold ( int & threshold )

pure virtual

Get the confidence threshold.

Parameters

[out] threshold

Returns: Status

◆ adsd3500GetEnableMetadatainAB()

virtual aditof::Status aditof::Camera::adsd3500GetEnableMetadatainAB ( uint16_t & value )

pure virtual

Get state of Enable Metadata in the AB frame.

Parameters

[out] value - See "Get Output Metadata in AB Frame status" at https://wiki.analog.com/resources/eval/user-guides/eval-adtf3175x-adsd3500

Returns: Status

◆ adsd3500GetFirmwareVersion()

virtual Status aditof::Camera::adsd3500GetFirmwareVersion	(	std::string &	fwVersion,
		std::string &	fwHash
	)

pure virtual

Get the ASDSD3500 firmware version from the ADSD3500

Parameters

[out]	fwVersion	- the ADSD3500 firmware version
[out]	fwHash	- the ADSD3500 firmware git commit hash

◆ adsd3500GetFrameRate()

virtual Status aditof::Camera::adsd3500GetFrameRate ( uint16_t & fps )

pure virtual

Get Frame Rate.

Parameters

[out] fps - See "Get Frame Rate" at https://wiki.analog.com/resources/eval/user-guides/eval-adtf3175x-adsd3500

Returns: Status

◆ adsd3500GetGenericTemplate()

virtual Status aditof::Camera::adsd3500GetGenericTemplate	(	uint16_t	reg,
		uint16_t &	value
	)

pure virtual

Generic ADSD3500 function for commands not defined in the SDK (yet)

Parameters

[in]	reg	- 16-bit ADSD3500 register
[out]	value	- 16-bit value read from the register

Returns: Status

◆ adsd3500GetImagerErrorCode()

virtual Status aditof::Camera::adsd3500GetImagerErrorCode ( uint16_t & errcode )

pure virtual

Get error code from the imager.

Parameters

[out] errcode - See "Get Imager Error Code" at https://wiki.analog.com/resources/eval/user-guides/eval-adtf3175x-adsd3500

Returns: Status

◆ adsd3500GetJBLFExponentialTerm()

virtual Status aditof::Camera::adsd3500GetJBLFExponentialTerm ( uint16_t & value )

pure virtual

Get JBLF Exponential Term.

Parameters

[out] value - See "Get JBLF Exponential Term" at https://wiki.analog.com/resources/eval/user-guides/eval-adtf3175x-adsd3500

Returns: Status

◆ adsd3500GetJBLFfilterEnableState()

virtual Status aditof::Camera::adsd3500GetJBLFfilterEnableState ( bool & enabled )

pure virtual

Get the JBLF enabled state.

Parameters

[out] enabled

Returns: Status

◆ adsd3500GetJBLFfilterSize()

virtual Status aditof::Camera::adsd3500GetJBLFfilterSize ( int & size )

pure virtual

Get the JBLF filter size.

Parameters

[out] size

Returns: Status

◆ adsd3500GetJBLFGaussianSigma()

virtual Status aditof::Camera::adsd3500GetJBLFGaussianSigma ( uint16_t & value )

pure virtual

Get JBLF Gaussian Sigma.

Parameters

[out] value - See "Get JBLF Gaussian Sigma" at https://wiki.analog.com/resources/eval/user-guides/eval-adtf3175x-adsd3500

Returns: Status

◆ adsd3500GetLaserTemperature()

virtual Status aditof::Camera::adsd3500GetLaserTemperature ( uint16_t & tmpValue )

pure virtual

Get the laser temperature.

Parameters

[out] tmpValue - Values in Celsius degree

Returns: Status

◆ adsd3500GetMIPIOutputSpeed()

virtual Status aditof::Camera::adsd3500GetMIPIOutputSpeed ( uint16_t & speed )

pure virtual

Get ADSD3500 MIPI output speed.

Parameters

[out] speed - See "Get MIPI Output Speed" at https://wiki.analog.com/resources/eval/user-guides/eval-adtf3175x-adsd3500

Returns: Status

◆ adsd3500GetRadialThresholdMax()

virtual Status aditof::Camera::adsd3500GetRadialThresholdMax ( int & threshold )

pure virtual

Get the radial threshold max.

Parameters

[out] threshold

Returns: Status

◆ adsd3500GetRadialThresholdMin()

virtual Status aditof::Camera::adsd3500GetRadialThresholdMin ( int & threshold )

pure virtual

Get the radial threshold min.

Parameters

[out] threshold

Returns: Status

◆ adsd3500GetSensorTemperature()

virtual Status aditof::Camera::adsd3500GetSensorTemperature ( uint16_t & tmpValue )

pure virtual

Get the sensor temperature.

Parameters

[out] tmpValue - Values in Celsius degree

Returns: Status

◆ adsd3500GetStatus()

virtual Status aditof::Camera::adsd3500GetStatus	(	int &	chipStatus,
		int &	imagerStatus
	)

pure virtual

Returns the chip status.

Parameters

[out]	chipStatus	- chip status (error) value
[out]	imagerStatus	- imager status (error) value

Returns: Status

◆ adsd3500GetTemperatureCompensationStatus()

virtual Status aditof::Camera::adsd3500GetTemperatureCompensationStatus ( uint16_t & value )

pure virtual

Get Temperature Compensation Status.

Parameters

[out] value - See "Get Temperature Compensation Status" at https://wiki.analog.com/resources/eval/user-guides/eval-adtf3175x-adsd3500

Returns: Status

◆ adsd3500GetVCSELDelay()

virtual Status aditof::Camera::adsd3500GetVCSELDelay ( uint16_t & delay )

pure virtual

Get the delay for VCSEL - ADSD3100 imager only.

Parameters

[out] delay - See "Get VCSEL Delay" at https://wiki.analog.com/resources/eval/user-guides/eval-adtf3175x-adsd3500

Returns: Status

◆ adsd3500SetABinvalidationThreshold()

virtual Status aditof::Camera::adsd3500SetABinvalidationThreshold ( int threshold )

pure virtual

Set the AB invalidation threshold.

Parameters

[in] threshold

Returns: Status

◆ adsd3500SetConfidenceThreshold()

virtual Status aditof::Camera::adsd3500SetConfidenceThreshold ( int threshold )

pure virtual

Set the confidence threshold.

Parameters

[in] threshold

Returns: Status

◆ adsd3500SetEnableEdgeConfidence()

virtual Status aditof::Camera::adsd3500SetEnableEdgeConfidence ( uint16_t value )

pure virtual

Set Enable Edge Confidence.

Parameters

[in] value - See "Set Enable Edge Confidence" at https://wiki.analog.com/resources/eval/user-guides/eval-adtf3175x-adsd3500

Returns: Status

◆ adsd3500SetEnableMetadatainAB()

virtual aditof::Status aditof::Camera::adsd3500SetEnableMetadatainAB ( uint16_t value )

pure virtual

Set Enable Metadata in the AB frame.

Parameters

[in] value - See "Enable/Disable Output Metadata in AB Frame" at https://wiki.analog.com/resources/eval/user-guides/eval-adtf3175x-adsd3500

Returns: Status

◆ adsd3500SetEnablePhaseInvalidation()

virtual Status aditof::Camera::adsd3500SetEnablePhaseInvalidation ( uint16_t value )

pure virtual

Set Enable Phase Invalidation.

Parameters

[out] value - See "Set Enable Phase Invalidation" at https://wiki.analog.com/resources/eval/user-guides/eval-adtf3175x-adsd3500

Returns: Status

◆ adsd3500SetEnableTemperatureCompensation()

virtual Status aditof::Camera::adsd3500SetEnableTemperatureCompensation ( uint16_t value )

pure virtual

Set Enable Temperature Compensation.

Parameters

[out] value - See "Set Enable Temperature Compensation" at https://wiki.analog.com/resources/eval/user-guides/eval-adtf3175x-adsd3500

Returns: Status

◆ adsd3500SetFrameRate()

virtual Status aditof::Camera::adsd3500SetFrameRate ( uint16_t fps )

pure virtual

Set Frame Rate.

Parameters

[out] fps - See "Set Frame Rate" at https://wiki.analog.com/resources/eval/user-guides/eval-adtf3175x-adsd3500

Returns: Status

◆ adsd3500SetGenericTemplate()

virtual Status aditof::Camera::adsd3500SetGenericTemplate	(	uint16_t	reg,
		uint16_t	value
	)

pure virtual

Generic ADSD3500 function for commands not defined in the SDK (yet)

Parameters

[in]	reg	- 16-bit ADSD3500 register
[in]	value	- 16-bit value to write to the register

Returns: Status

◆ adsd3500SetIniParams()

virtual Status aditof::Camera::adsd3500SetIniParams ( const std::map< std::string, float > & iniKeyValPairs )

pure virtual

Set the adsd3500 ini parameters.

Parameters

iniKeyValPairs - a dictionary of parameters

Returns: Status

◆ adsd3500SetJBLFABThreshold()

virtual Status aditof::Camera::adsd3500SetJBLFABThreshold ( uint16_t threshold )

pure virtual

Get JBLF Max Edge Threshold.

Parameters

[out] threshold - See "Get JBLF Max Edge Threshold" at https://wiki.analog.com/resources/eval/user-guides/eval-adtf3175x-adsd3500

Returns: Status

◆ adsd3500SetJBLFExponentialTerm()

virtual Status aditof::Camera::adsd3500SetJBLFExponentialTerm ( uint16_t value )

pure virtual

Set JBLF Exponential Term.

Parameters

[in] value - See "Set JBLF Exponential Term" at https://wiki.analog.com/resources/eval/user-guides/eval-adtf3175x-adsd3500

Returns: Status

◆ adsd3500SetJBLFfilterEnableState()

virtual Status aditof::Camera::adsd3500SetJBLFfilterEnableState ( bool enable )

pure virtual

Enable/disable the JBLF filter.

Parameters

[in] enable

Returns: Status

◆ adsd3500SetJBLFfilterSize()

virtual Status aditof::Camera::adsd3500SetJBLFfilterSize ( int size )

pure virtual

Set the JBLF filter size.

Parameters

[in] size - Supported sizes are: 3, 5, 7

Returns: Status

◆ adsd3500SetJBLFGaussianSigma()

virtual Status aditof::Camera::adsd3500SetJBLFGaussianSigma ( uint16_t value )

pure virtual

Set JBLF Gaussian Sigma.

Parameters

[in] value - See "Set JBLF Gaussian Sigma" at https://wiki.analog.com/resources/eval/user-guides/eval-adtf3175x-adsd3500

Returns: Status

◆ adsd3500SetJBLFMaxEdgeThreshold()

virtual Status aditof::Camera::adsd3500SetJBLFMaxEdgeThreshold ( uint16_t threshold )

pure virtual

Set JBLF Max Edge Threshold.

Parameters

[in] threshold - See "Set JBLF Max Edge Threshold" at https://wiki.analog.com/resources/eval/user-guides/eval-adtf3175x-adsd3500

Returns: Status

◆ adsd3500SetMIPIOutputSpeed()

virtual Status aditof::Camera::adsd3500SetMIPIOutputSpeed ( uint16_t speed )

pure virtual

Set ADSD3500 MIPI output speed.

Parameters

[in] speed - See "Set MIPI Output Speed" at https://wiki.analog.com/resources/eval/user-guides/eval-adtf3175x-adsd3500

Returns: Status

◆ adsd3500SetRadialThresholdMax()

virtual Status aditof::Camera::adsd3500SetRadialThresholdMax ( int threshold )

pure virtual

Set the radial threshold max.

Parameters

[in] threshold

Returns: Status

◆ adsd3500SetRadialThresholdMin()

virtual Status aditof::Camera::adsd3500SetRadialThresholdMin ( int threshold )

pure virtual

Set the radial threshold min.

Parameters

[in] threshold

Returns: Status

◆ adsd3500SetToggleMode()

virtual Status aditof::Camera::adsd3500SetToggleMode ( int mode )

pure virtual

Enables or disables FSYNC toggle for ADSD3500.

Parameters

[in] mode - 2 = Fsync pin set as HiZ ; 1 = Toggle at user specified framerate ; 0 = Toggle controlled via adsd3500ToggleFsync ;

Returns: Status

◆ adsd3500SetVCSELDelay()

virtual Status aditof::Camera::adsd3500SetVCSELDelay ( uint16_t delay )

pure virtual

Set the delay for VCSEL - ADSD3100 imager only.

Parameters

[in] delay - See "Set VCSEL Delay" at https://wiki.analog.com/resources/eval/user-guides/eval-adtf3175x-adsd3500

Returns: Status

◆ adsd3500ToggleFsync()

virtual Status aditof::Camera::adsd3500ToggleFsync ( )

pure virtual

Toggles ADSD3500 FSYNC once if automated FSYNC is disabled.

Returns: Status

◆ adsd3500UpdateFirmware()

virtual Status aditof::Camera::adsd3500UpdateFirmware ( const std::string & fwFilePath )

pure virtual

Update the firmware of ADSD3500 with the content found in the specified file.

Parameters

[in] fwFilePath - A path to a file (including file name and extension) where the firmware for adsd3500 is stored.

Returns: Status

◆ enableDepthCompute()

virtual Status aditof::Camera::enableDepthCompute ( bool enable )

pure virtual

Enable or disable the depth processing on the frames received from the sensor Must be called after getFrame() where the depth processing happens.

Parameters

[in] enable - set to true to enable depth processing. Set to false otherwise.

Returns: Status

◆ enableXYZframe()

virtual Status aditof::Camera::enableXYZframe ( bool enable )

pure virtual

Enable the generation of a XYZ frame. The XYZ frame can be enabled or disabled through .ini configuration file but if this method is explicitly called then it will override the option in the .ini file. By default XYZ frame is disabled.

Parameters

[in] enable - set to true to enable the generation of XYZ, set to false otherwise.

Returns: Status

◆ getAvailableControls()

virtual Status aditof::Camera::getAvailableControls ( std::vector< std::string > & controls ) const

pure virtual

Gets the camera's list of controls.

Parameters

[out] controls

Returns: Status

◆ getAvailableFrameTypes()

virtual Status aditof::Camera::getAvailableFrameTypes ( std::vector< std::string > & availableFrameTypes ) const

pure virtual

Returns all the frame types that are supported by the camera.

Parameters

[out] availableFrameTypes

Returns: Status

◆ getAvailableModes()

virtual Status aditof::Camera::getAvailableModes ( std::vector< std::string > & availableModes ) const

pure virtual

Returns all the modes that are supported by the camera. DEPRECATED! NOTE: This method is deprecated. Use 'getAvailableFrameTypes' instead.

Deprecated:

Parameters

[out] availableModes

Returns: Status

◆ getControl()

virtual Status aditof::Camera::getControl	(	const std::string &	control,
		std::string &	value
	)		const

pure virtual

Gets the value of a specific camera control.

Parameters

[in]	control	- Control name
[out]	value	- Control value

Returns: Status

◆ getDetails()

virtual Status aditof::Camera::getDetails ( CameraDetails & details ) const

pure virtual

Gets the current details of the camera.

Parameters

[out] details

Returns: Status

◆ getFrameTypeNameFromId()

virtual Status aditof::Camera::getFrameTypeNameFromId	(	int	id,
		std::string &	name
	)		const

pure virtual

Returns the name of the frame type for the given ID.

Parameters

	id	- the ID of the frame type
[out]	name	- will be set with the name of the frame type in case of success

Returns: Status

◆ getImagerType()

virtual Status aditof::Camera::getImagerType ( ImagerType & imagerType ) const

pure virtual

Provides the type of the imager.

Parameters

[out] imagerType - Will be set with the imager type

Returns: Status

◆ getIniParams()

virtual Status aditof::Camera::getIniParams ( std::map< std::string, float > & params )

pure virtual

Get the Depth Compute Library ini parameters.

Parameters

params - a dictionary of parameters

Returns: Status

◆ getSensor()

virtual std::shared_ptr<DepthSensorInterface> aditof::Camera::getSensor ( )

pure virtual

Gets the sensor of the camera. This gives direct access to low level configuration of the camera sensor.

Returns: std::shared_ptr<DepthSensorInterface>

◆ initialize()

virtual Status aditof::Camera::initialize ( const std::string & configFilepath = {} )

pure virtual

Initialize the camera. This is required before performing any operation on the camera.

Parameters

configFilepath - The JSON configuration files which should be specific to the given module. The expected value is a file name (including extension) or left empty.

Returns: Status

◆ readSerialNumber()

virtual Status aditof::Camera::readSerialNumber	(	std::string &	serialNumber,
		bool	useCacheValue = `false`
	)

pure virtual

Read serial number from camera and update cache.

Parameters

[out]	serialNumber	- Will contain serial number
[in]	useCacheValue	- If it is false it will read from camera and if it is true it will return serialNumber from cache

Returns: Status

◆ requestFrame()

virtual Status aditof::Camera::requestFrame ( Frame * frame )

pure virtual

Captures data from the camera and assigns it to the given frame.

Parameters

frame - The frame to which the camera data should be assign

Returns: Status

◆ saveModuleCCB()

virtual Status aditof::Camera::saveModuleCCB ( const std::string & filepath )

pure virtual

Save the CCB content which is obtained from module memory to a given file path.

Parameters

[in] filepath - A path to a file (including file name and extension) where the CCB should be stored.

Returns: Status

◆ saveModuleCFG()

virtual Status aditof::Camera::saveModuleCFG ( const std::string & filepath ) const

pure virtual

Save the CFG content which is obtained from module memory to a given file path.

Parameters

[in] filepath - A path to a file (including file name and extension) where the CFG should be stored.

Returns: Status

◆ setControl()

virtual Status aditof::Camera::setControl	(	const std::string &	control,
		const std::string &	value
	)

pure virtual

Sets a specific camera control.

Parameters

[in]	control	- Control name
[in]	value	- Control value

Returns: Status

◆ setFrameType()

virtual Status aditof::Camera::setFrameType ( const std::string & frameType )

pure virtual

Set the camera frame type to the given type.

Parameters

frameType - The frame type of the camera

Returns: Status

◆ setIniParams()

virtual Status aditof::Camera::setIniParams ( std::map< std::string, float > & params )

pure virtual

Set the Depth Compute Library ini parameters.

Parameters

params - a dictionary of parameters

Returns: Status

◆ setMode()

virtual Status aditof::Camera::setMode	(	const std::string &	mode,
		const std::string &	modeFilename = `{}`
	)

pure virtual

Puts the camera into the given mode. DEPRECATED! NOTE: This method is deprecated. Use 'setFrameType' instead.

Deprecated:

Parameters

mode - The mode of the camera

modeFilename - When there is a need to use a custom mode then mode parameter needs to be set to 'custom' and a firmware file needs to be provided.

Returns
Status

◆ start()

virtual Status aditof::Camera::start ( )

pure virtual

Start the camera. This starts the streaming of data from the camera.

Returns: Status

◆ stop()

virtual Status aditof::Camera::stop ( )

pure virtual

Stop the camera. This makes the camera to stop streaming.

Returns: Status

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

/home/vsts/work/1/s/sdk/include/aditof/camera.h

mode	- The mode of the camera
modeFilename	- When there is a need to use a custom mode then mode parameter needs to be set to 'custom' and a firmware file needs to be provided.

Public Member Functions

Detailed Description

Member Function Documentation

◆ adsd3500GetABinvalidationThreshold()

◆ adsd3500GetConfidenceThreshold()

◆ adsd3500GetEnableMetadatainAB()

◆ adsd3500GetFirmwareVersion()

◆ adsd3500GetFrameRate()

◆ adsd3500GetGenericTemplate()

◆ adsd3500GetImagerErrorCode()

◆ adsd3500GetJBLFExponentialTerm()

◆ adsd3500GetJBLFfilterEnableState()

◆ adsd3500GetJBLFfilterSize()

◆ adsd3500GetJBLFGaussianSigma()

◆ adsd3500GetLaserTemperature()

◆ adsd3500GetMIPIOutputSpeed()

◆ adsd3500GetRadialThresholdMax()

◆ adsd3500GetRadialThresholdMin()

◆ adsd3500GetSensorTemperature()

◆ adsd3500GetStatus()

◆ adsd3500GetTemperatureCompensationStatus()

◆ adsd3500GetVCSELDelay()

◆ adsd3500SetABinvalidationThreshold()

◆ adsd3500SetConfidenceThreshold()

◆ adsd3500SetEnableEdgeConfidence()

◆ adsd3500SetEnableMetadatainAB()

◆ adsd3500SetEnablePhaseInvalidation()

◆ adsd3500SetEnableTemperatureCompensation()

◆ adsd3500SetFrameRate()

◆ adsd3500SetGenericTemplate()

◆ adsd3500SetIniParams()

◆ adsd3500SetJBLFABThreshold()

◆ adsd3500SetJBLFExponentialTerm()

◆ adsd3500SetJBLFfilterEnableState()

◆ adsd3500SetJBLFfilterSize()

◆ adsd3500SetJBLFGaussianSigma()

◆ adsd3500SetJBLFMaxEdgeThreshold()

◆ adsd3500SetMIPIOutputSpeed()

◆ adsd3500SetRadialThresholdMax()

◆ adsd3500SetRadialThresholdMin()

◆ adsd3500SetToggleMode()

◆ adsd3500SetVCSELDelay()

◆ adsd3500ToggleFsync()

◆ adsd3500UpdateFirmware()

◆ enableDepthCompute()

◆ enableXYZframe()

◆ getAvailableControls()

◆ getAvailableFrameTypes()

◆ getAvailableModes()

◆ getControl()

◆ getDetails()

◆ getFrameTypeNameFromId()

◆ getImagerType()

◆ getIniParams()

◆ getSensor()

◆ initialize()

◆ readSerialNumber()

◆ requestFrame()

◆ saveModuleCCB()

◆ saveModuleCFG()

◆ setControl()

◆ setFrameType()

◆ setIniParams()

◆ setMode()

◆ start()

◆ stop()