Jetson Linux API Reference
32.7.5 Release
Public Member Functions | Static Public Member Functions | Protected Member Functions
Argus::ICameraProperties Class Referenceabstract
Libargus Camera API » Objects and Interfaces » CameraDevice

Detailed Description

Interface to the core CameraDevice properties.

Definition at line 68 of file CameraDevice.h.

Inheritance diagram for Argus::ICameraProperties:
Inheritance graph
[legend]
Collaboration diagram for Argus::ICameraProperties:
Collaboration graph
[legend]

Public Member Functions

virtual UUID getUUID () const =0
 Returns the camera UUID. More...
 
virtual SensorPlacement getSensorPlacement () const =0
 Returns the camera sensor placement position on the module. More...
 
virtual uint32_t getMaxAeRegions () const =0
 Returns the maximum number of regions of interest supported by AE. More...
 
virtual Size2D< uint32_t > getMinAeRegionSize () const =0
 Returns the minimum size of resultant region required by AE. More...
 
virtual uint32_t getMaxAwbRegions () const =0
 Returns the maximum number of regions of interest supported by AWB. More...
 
virtual uint32_t getMaxAfRegions () const =0
 Returns the maximum number of regions of interest supported by AF. More...
 
virtual Status getBasicSensorModes (std::vector< SensorMode * > *modes) const =0
 Returns only the basic available sensor modes that do not have an associated extension. More...
 
virtual Status getAllSensorModes (std::vector< SensorMode * > *modes) const =0
 Returns all the available sensor modes including the ones that have extensions. More...
 
virtual Status getAperturePositions (std::vector< int32_t > *positions) const =0
 Returns all the recommended aperture positions. More...
 
virtual Status getAvailableApertureFNumbers (std::vector< float > *fnumbers) const =0
 Returns all the available aperture f-numbers. More...
 
virtual Range< int32_t > getFocusPositionRange () const =0
 Returns the valid range of focuser positions. More...
 
virtual Range< int32_t > getAperturePositionRange () const =0
 Returns the valid range of aperture positions. More...
 
virtual Range< float > getApertureMotorSpeedRange () const =0
 Returns the valid range of aperture step positions per second. More...
 
virtual Range< float > getIspDigitalGainRange () const =0
 Returns the supported range of ISP digital gain. More...
 
virtual Range< float > getExposureCompensationRange () const =0
 Returns the supported range of Exposure Compensation. More...
 
virtual const std::string & getModelName () const =0
 Returns the model name of the device. More...
 
virtual const std::string & getModuleString () const =0
 Returns the module string for the device. More...
 

Static Public Member Functions

static const InterfaceID & id ()
 

Protected Member Functions

 ~ICameraProperties ()
 

Constructor & Destructor Documentation

◆ ~ICameraProperties()

Argus::ICameraProperties::~ICameraProperties ( )
inlineprotected

Definition at line 199 of file CameraDevice.h.

Member Function Documentation

◆ getAllSensorModes()

virtual Status Argus::ICameraProperties::getAllSensorModes ( std::vector< SensorMode * > *  modes) const
pure virtual

Returns all the available sensor modes including the ones that have extensions.

The extended modes support some form of Wide Dynamic Range (WDR) technology.

All the returned modes will support the basic sensor mode interface.

See also
ISensorMode
Parameters
[out]modesA vector that will be populated with the sensor modes.
Returns
success/status of the call.

◆ getApertureMotorSpeedRange()

virtual Range<float> Argus::ICameraProperties::getApertureMotorSpeedRange ( ) const
pure virtual

Returns the valid range of aperture step positions per second.

The units are aperture motor steps/second.

◆ getAperturePositionRange()

virtual Range<int32_t> Argus::ICameraProperties::getAperturePositionRange ( ) const
pure virtual

Returns the valid range of aperture positions.

The units are aperture positions.

◆ getAperturePositions()

virtual Status Argus::ICameraProperties::getAperturePositions ( std::vector< int32_t > *  positions) const
pure virtual

Returns all the recommended aperture positions.

Parameters
[out]positionsa vector that will be populated with the aperture positions.
Returns
success/status of the call.

◆ getAvailableApertureFNumbers()

virtual Status Argus::ICameraProperties::getAvailableApertureFNumbers ( std::vector< float > *  fnumbers) const
pure virtual

Returns all the available aperture f-numbers.

Parameters
[out]fnumbersA pointer to a vector to be populated with the aperture f-numbers.
Returns
success/status of the call.

◆ getBasicSensorModes()

virtual Status Argus::ICameraProperties::getBasicSensorModes ( std::vector< SensorMode * > *  modes) const
pure virtual

Returns only the basic available sensor modes that do not have an associated extension.

Basic mode types include Depth, RGB, YUV and Bayer types.

Parameters
[out]modesA vector that will be populated with the sensor modes.
Returns
success/status of the call.

◆ getExposureCompensationRange()

virtual Range<float> Argus::ICameraProperties::getExposureCompensationRange ( ) const
pure virtual

Returns the supported range of Exposure Compensation.

◆ getFocusPositionRange()

virtual Range<int32_t> Argus::ICameraProperties::getFocusPositionRange ( ) const
pure virtual

Returns the valid range of focuser positions.

The units are focuser steps.

◆ getIspDigitalGainRange()

virtual Range<float> Argus::ICameraProperties::getIspDigitalGainRange ( ) const
pure virtual

Returns the supported range of ISP digital gain.

◆ getMaxAeRegions()

virtual uint32_t Argus::ICameraProperties::getMaxAeRegions ( ) const
pure virtual

Returns the maximum number of regions of interest supported by AE.

A value of 0 means that the entire image is the only supported region of interest.

See also
IAutoControlSettings::setAeRegions()

◆ getMaxAfRegions()

virtual uint32_t Argus::ICameraProperties::getMaxAfRegions ( ) const
pure virtual

Returns the maximum number of regions of interest supported by AF.

A value of 0 means that the entire image is the only supported region of interest.

See also
IAutoControlSettings::setAfRegions()

◆ getMaxAwbRegions()

virtual uint32_t Argus::ICameraProperties::getMaxAwbRegions ( ) const
pure virtual

Returns the maximum number of regions of interest supported by AWB.

A value of 0 means that the entire image is the only supported region of interest.

See also
IAutoControlSettings::setAwbRegions()

◆ getMinAeRegionSize()

virtual Size2D<uint32_t> Argus::ICameraProperties::getMinAeRegionSize ( ) const
pure virtual

Returns the minimum size of resultant region required by AE.

See also
IAutoControlSettings::setAeRegions()

◆ getModelName()

virtual const std::string& Argus::ICameraProperties::getModelName ( ) const
pure virtual

Returns the model name of the device.

◆ getModuleString()

virtual const std::string& Argus::ICameraProperties::getModuleString ( ) const
pure virtual

Returns the module string for the device.

Contains the device's name, position, and partial model number. This string is unique for each device on the system.

◆ getSensorPlacement()

virtual SensorPlacement Argus::ICameraProperties::getSensorPlacement ( ) const
pure virtual

Returns the camera sensor placement position on the module.

◆ getUUID()

virtual UUID Argus::ICameraProperties::getUUID ( ) const
pure virtual

Returns the camera UUID.

In UUID, clock_seq contains low 16 bits of GUID, node[6] contains high 48 bits of GUID.

◆ id()

static const InterfaceID& Argus::ICameraProperties::id ( )
inlinestatic

Definition at line 71 of file CameraDevice.h.

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