This class is the abstract base class for all stereo image providers. More...

Inheritance diagram for Ocean::Media::StereoImageProviderInterface:

Public Member Functions
virtual	~StereoImageProviderInterface ()
	Destructs this interface. More...

virtual bool	nextStereoImages (FisheyeCamera &fisheyeCameraA, FisheyeCamera &fisheyeCameraB, Frame &imageA, Frame &imageB, HomogenousMatrixD4 world_T_device=nullptr, HomogenousMatrixD4 device_T_cameraA=nullptr, HomogenousMatrixD4 device_T_cameraB=nullptr, HomogenousMatricesD4 world_T_leftHandJoints=nullptr, HomogenousMatricesD4 world_T_rightHandJoints=nullptr, bool abort=nullptr)=0
	Returns the next stereo images from the provider, further optional transformations between device and world, and between cameras and device will be provided. More...

virtual bool	restart ()=0
	Restarts with the first pair of stereo images. More...

virtual bool	hasDeviceTransformations () const =0
	Returns whether the provider has access to the transformations between device and world (world_T_device). More...

virtual bool	hasCameraTransformations () const =0
	Returns whether the provider has access to the transformations between camerans and device (device_T_cameraA and device_T_cameraB). More...

virtual bool	isValid () const =0
	Returns whether this provider can provide valid stereo images (e.g., whether the underlying resources are initialized and whether the source exists). More...

virtual void	release ()=0
	Releases all owned resources like e.g., the image sequence objects. More...

Protected Member Functions
	StereoImageProviderInterface ()
	Protected default constructor. More...

Detailed Description

This class is the abstract base class for all stereo image providers.

The provider allows access to stereo images, their corresponding camera calibration data, and optional device poses.

Constructor & Destructor Documentation

◆ ~StereoImageProviderInterface()

Ocean::Media::StereoImageProviderInterface::~StereoImageProviderInterface ( )

inlinevirtual

Destructs this interface.

◆ StereoImageProviderInterface()

Ocean::Media::StereoImageProviderInterface::StereoImageProviderInterface ( )

inlineprotected

Protected default constructor.

Member Function Documentation

◆ hasCameraTransformations()

virtual bool Ocean::Media::StereoImageProviderInterface::hasCameraTransformations ( ) const

pure virtual

Returns whether the provider has access to the transformations between camerans and device (device_T_cameraA and device_T_cameraB).

Returns: True, if so

Implemented in Ocean::Media::ImageSequenceStereoImageProvider.

◆ hasDeviceTransformations()

virtual bool Ocean::Media::StereoImageProviderInterface::hasDeviceTransformations ( ) const

pure virtual

Returns whether the provider has access to the transformations between device and world (world_T_device).

Returns: True, if so

Implemented in Ocean::Media::ImageSequenceStereoImageProvider.

◆ isValid()

virtual bool Ocean::Media::StereoImageProviderInterface::isValid ( ) const

pure virtual

Returns whether this provider can provide valid stereo images (e.g., whether the underlying resources are initialized and whether the source exists).

Returns: True, if so

Implemented in Ocean::Media::ImageSequenceStereoImageProvider.

◆ nextStereoImages()

virtual bool Ocean::Media::StereoImageProviderInterface::nextStereoImages	(	FisheyeCamera &	fisheyeCameraA,
		FisheyeCamera &	fisheyeCameraB,
		Frame &	imageA,
		Frame &	imageB,
		HomogenousMatrixD4 *	world_T_device = `nullptr`,
		HomogenousMatrixD4 *	device_T_cameraA = `nullptr`,
		HomogenousMatrixD4 *	device_T_cameraB = `nullptr`,
		HomogenousMatricesD4 *	world_T_leftHandJoints = `nullptr`,
		HomogenousMatricesD4 *	world_T_rightHandJoints = `nullptr`,
		bool *	abort = `nullptr`
	)

pure virtual

Returns the next stereo images from the provider, further optional transformations between device and world, and between cameras and device will be provided.

Parameters

fisheyeCameraA	The resulting camera profile of the first stereo image, will be valid
fisheyeCameraB	The resulting camera profile of the second stereo image, will be valid
imageA	The resulting first stereo image, will be valid
imageB	The resulting second stereo image, will be valid
world_T_device	Optional resulting transformation transforming device to world, if known, otherwise invalid
device_T_cameraA	Optional resulting transformation transforming the first camera to device, if known, otherwise invalid
device_T_cameraB	Optional resulting transformation transforming the second camera to device, if known, otherwise invalid
world_T_leftHandJoints	Optional resulting transformations to map from the left hand joints to world coordinates, if known, otherwise invalid
world_T_rightHandJoints	Optional resulting transformations to map from the right hand joints to world coordinates, if known, otherwise invalid
abort	Optional abort statement allowing to abort the pending request at any time; set the value True to abort the request