Detailed Description

Interface to the core capture metadata.

Definition at line 182 of file CaptureMetadata.h.

Inheritance diagram for Argus::ICaptureMetadata:

Collaboration diagram for Argus::ICaptureMetadata:

Public Member Functions
virtual uint32_t	getCaptureId () const =0
	Returns the capture id (the value returned from ICaptureSession::capture()) of the capture that generated this metadata. More...

virtual uint32_t	getClientData () const =0
	Returns the `clientData` value for the Request used in the capture that generated this metadata. More...

virtual InterfaceProvider *	getStreamMetadata (const OutputStream *stream) const =0
	Returns the per-stream metadata provider for `stream`. More...

virtual const InterfaceProvider *	getBayerHistogram () const =0
	Returns the Bayer histogram for this capture. More...

virtual const InterfaceProvider *	getRGBHistogram () const =0
	Returns the RGB histogram for this capture. More...

virtual bool	getAeLocked () const =0
	Returns true if and only if AE was locked for this capture. More...

virtual Status	getAeRegions (std::vector< AcRegion > *regions) const =0
	Gets the AE regions of interest used for this capture. More...

virtual Rectangle< uint32_t >	getBayerHistogramRegion () const =0
	Returns the rectangle of the bayer histogram region of interest. More...

virtual AeState	getAeState () const =0
	Returns the state of AE when it ran for this capture. More...

virtual AeFlickerState	getFlickerState () const =0
	Returns the flicker state of this capture. More...

virtual int32_t	getAperturePosition () const =0
	Returns the aperture position. More...

virtual int32_t	getFocuserPosition () const =0
	Returns the focuser position used for this capture (in focuser steps). More...

virtual uint32_t	getAwbCct () const =0
	Returns the CCT calculated by AWB for this capture. More...

virtual BayerTuple< float >	getAwbGains () const =0
	Returns the AWB gains used for this capture. More...

virtual AwbMode	getAwbMode () const =0
	Returns the AWB mode used for this capture. More...

virtual Status	getAwbRegions (std::vector< AcRegion > *regions) const =0
	Gets the AWB regions of interest used for this capture. More...

virtual AfMode	getAfMode () const =0
	Returns the AF mode used for this capture. More...

virtual Status	getAfRegions (std::vector< AcRegion > *regions) const =0
	Gets the AF regions of interest used for this capture. More...

virtual Status	getSharpnessScore (std::vector< float > *values) const =0
	Gets the sharpness score values calculated for corresponding AF regions. More...

virtual AwbState	getAwbState () const =0

virtual Status	getAwbWbEstimate (std::vector< float > *estimate) const =0
	Gets the current AWB WB estimate as a vector of NUM_AWB_WB_ESTIMATE_ELEMENTS values. More...

virtual bool	getColorCorrectionMatrixEnable () const =0
	Returns the enable state for the client-supplied Color Correction Matrix. More...

virtual Status	getColorCorrectionMatrix (std::vector< float > *ccMatrix) const =0
	Gets the 3x3 client-supplied Color Correction Matrix as a flattened (row-major) vector of 9 values. More...

virtual float	getColorSaturation () const =0
	Returns the color saturation value used for this capture (including biasing). More...

virtual uint64_t	getFrameDuration () const =0
	Returns the time it took to integrate this capture (in nanoseconds). More...

virtual float	getIspDigitalGain () const =0
	Returns the digital gain used for this capture. More...

virtual uint64_t	getFrameReadoutTime () const =0
	Returns the frame readout time for this capture (in nanoseconds) from the beginning of the first line to the beginning of the last line. More...

virtual float	getSceneLux () const =0
	Returns the estimated scene brightness for this capture (in lux). More...

virtual float	getSensorAnalogGain () const =0
	Returns the sensor analog gain used for this capture. More...

virtual uint64_t	getSensorExposureTime () const =0
	Returns the sensor exposure time for this capture (in nanoseconds). More...

virtual uint32_t	getSensorSensitivity () const =0
	Returns the ISO value used for this capture. More...

virtual uint64_t	getSensorTimestamp () const =0
	Returns the kernel (SOF) timestamp for the sensor (in nanoseconds). More...

virtual bool	getToneMapCurveEnabled () const =0
	Returns true if and only if a user-specified tone map curve was used for this capture. More...

virtual Status	getToneMapCurve (RGBChannel channel, std::vector< float > *curve) const =0
	Returns the specified color channel for the tone mapping table (as a vector of NUM_TONE_MAP_ELEMENTS values). More...

Static Public Member Functions
static const InterfaceID &	id ()

Static Public Attributes
static const uint32_t	NUM_COLOR_CORRECTION_ELEMENTS = 9

static const uint32_t	NUM_AWB_WB_ESTIMATE_ELEMENTS = 4

Protected Member Functions
	~ICaptureMetadata ()

Constructor & Destructor Documentation

◆ ~ICaptureMetadata()

Argus::ICaptureMetadata::~ICaptureMetadata ( )

inlineprotected

Definition at line 406 of file CaptureMetadata.h.

Member Function Documentation

◆ getAeLocked()

virtual bool Argus::ICaptureMetadata::getAeLocked ( ) const

pure virtual

Returns true if and only if AE was locked for this capture.

◆ getAeRegions()

virtual Status Argus::ICaptureMetadata::getAeRegions ( std::vector< AcRegion > * regions ) const

pure virtual

Gets the AE regions of interest used for this capture.

Parameters

[in] regions A vector that will be populated with the AE regions used in capture.

Returns: success/status of the call.

◆ getAeState()

virtual AeState Argus::ICaptureMetadata::getAeState ( ) const

pure virtual

Returns the state of AE when it ran for this capture.

◆ getAfMode()

virtual AfMode Argus::ICaptureMetadata::getAfMode ( ) const

pure virtual

Returns the AF mode used for this capture.

◆ getAfRegions()

virtual Status Argus::ICaptureMetadata::getAfRegions ( std::vector< AcRegion > * regions ) const

pure virtual

Gets the AF regions of interest used for this capture.

Parameters

[in] regions A vector that will be populated with the AF regions used in capture.

Returns: success/status of the call.

◆ getAperturePosition()

virtual int32_t Argus::ICaptureMetadata::getAperturePosition ( ) const

pure virtual

Returns the aperture position.

◆ getAwbCct()

virtual uint32_t Argus::ICaptureMetadata::getAwbCct ( ) const

pure virtual

Returns the CCT calculated by AWB for this capture.

◆ getAwbGains()

virtual BayerTuple<float> Argus::ICaptureMetadata::getAwbGains ( ) const

pure virtual

Returns the AWB gains used for this capture.

◆ getAwbMode()

virtual AwbMode Argus::ICaptureMetadata::getAwbMode ( ) const

pure virtual

Returns the AWB mode used for this capture.

◆ getAwbRegions()

virtual Status Argus::ICaptureMetadata::getAwbRegions ( std::vector< AcRegion > * regions ) const

pure virtual

Gets the AWB regions of interest used for this capture.

Parameters

[in] regions A vector that will be populated with the AWB regions used in capture.

Returns: success/status of the call.

◆ getAwbState()

virtual AwbState Argus::ICaptureMetadata::getAwbState ( ) const

pure virtual

Returns: the state of AWB when it ran for this capture.

◆ getAwbWbEstimate()

virtual Status Argus::ICaptureMetadata::getAwbWbEstimate ( std::vector< float > * estimate ) const

pure virtual

Gets the current AWB WB estimate as a vector of NUM_AWB_WB_ESTIMATE_ELEMENTS values.

Parameters

[in] estimate A vector that will be populated with the AWB WB estimates.

Returns: success/status of the call.

◆ getBayerHistogram()

virtual const InterfaceProvider* Argus::ICaptureMetadata::getBayerHistogram ( ) const

pure virtual

Returns the Bayer histogram for this capture.

This object will provide the IBayerHistogram interface.

◆ getBayerHistogramRegion()

virtual Rectangle<uint32_t> Argus::ICaptureMetadata::getBayerHistogramRegion ( ) const

pure virtual

Returns the rectangle of the bayer histogram region of interest.

◆ getCaptureId()

virtual uint32_t Argus::ICaptureMetadata::getCaptureId ( ) const

pure virtual

Returns the capture id (the value returned from ICaptureSession::capture()) of the capture that generated this metadata.

◆ getClientData()

virtual uint32_t Argus::ICaptureMetadata::getClientData ( ) const

pure virtual

Returns the clientData value for the Request used in the capture that generated this metadata.

See also: ICaptureSession::createRequest()

◆ getColorCorrectionMatrix()

virtual Status Argus::ICaptureMetadata::getColorCorrectionMatrix ( std::vector< float > * ccMatrix ) const

pure virtual

Gets the 3x3 client-supplied Color Correction Matrix as a flattened (row-major) vector of 9 values.

This matrix is irrelevant if getColorCorrectionMatrixEnable() == false.

Parameters

[in] ccMatrix A vector that will be populated with the color correction matrix.

Returns: success/status of the call.

◆ getColorCorrectionMatrixEnable()

virtual bool Argus::ICaptureMetadata::getColorCorrectionMatrixEnable ( ) const

pure virtual

Returns the enable state for the client-supplied Color Correction Matrix.

◆ getColorSaturation()

virtual float Argus::ICaptureMetadata::getColorSaturation ( ) const

pure virtual

Returns the color saturation value used for this capture (including biasing).

◆ getFlickerState()

virtual AeFlickerState Argus::ICaptureMetadata::getFlickerState ( ) const

pure virtual

Returns the flicker state of this capture.

◆ getFocuserPosition()

virtual int32_t Argus::ICaptureMetadata::getFocuserPosition ( ) const

pure virtual

Returns the focuser position used for this capture (in focuser steps).

◆ getFrameDuration()

virtual uint64_t Argus::ICaptureMetadata::getFrameDuration ( ) const

pure virtual

Returns the time it took to integrate this capture (in nanoseconds).

◆ getFrameReadoutTime()

virtual uint64_t Argus::ICaptureMetadata::getFrameReadoutTime ( ) const

pure virtual

Returns the frame readout time for this capture (in nanoseconds) from the beginning of the first line to the beginning of the last line.

◆ getIspDigitalGain()

virtual float Argus::ICaptureMetadata::getIspDigitalGain ( ) const

pure virtual

Returns the digital gain used for this capture.

◆ getRGBHistogram()

virtual const InterfaceProvider* Argus::ICaptureMetadata::getRGBHistogram ( ) const

pure virtual

Returns the RGB histogram for this capture.

This object will provide the IRGBHistogram interface.

◆ getSceneLux()

virtual float Argus::ICaptureMetadata::getSceneLux ( ) const

pure virtual

Returns the estimated scene brightness for this capture (in lux).

◆ getSensorAnalogGain()

virtual float Argus::ICaptureMetadata::getSensorAnalogGain ( ) const

pure virtual

Returns the sensor analog gain used for this capture.

◆ getSensorExposureTime()

virtual uint64_t Argus::ICaptureMetadata::getSensorExposureTime ( ) const

pure virtual

Returns the sensor exposure time for this capture (in nanoseconds).

◆ getSensorSensitivity()

virtual uint32_t Argus::ICaptureMetadata::getSensorSensitivity ( ) const

pure virtual

Returns the ISO value used for this capture.

◆ getSensorTimestamp()

virtual uint64_t Argus::ICaptureMetadata::getSensorTimestamp ( ) const

pure virtual

Returns the kernel (SOF) timestamp for the sensor (in nanoseconds).

This is the time that the first data from this capture arrives from the sensor.

◆ getSharpnessScore()

virtual Status Argus::ICaptureMetadata::getSharpnessScore ( std::vector< float > * values ) const

pure virtual

Gets the sharpness score values calculated for corresponding AF regions.

Parameters

[in] values A vector that will be populated with the sharpness scores used in capture.

Returns: success/status of the call.

◆ getStreamMetadata()

virtual InterfaceProvider* Argus::ICaptureMetadata::getStreamMetadata ( const OutputStream * stream ) const

pure virtual

Returns the per-stream metadata provider for stream.

This object will provide the IStreamCaptureMetadata interface.

◆ getToneMapCurve()

virtual Status Argus::ICaptureMetadata::getToneMapCurve	(	RGBChannel	channel,
		std::vector< float > *	curve
	)		const

pure virtual

Returns the specified color channel for the tone mapping table (as a vector of NUM_TONE_MAP_ELEMENTS values).

These values are irrelevant if getToneMapCurveEnabled() == false.

Parameters

[in]	channel	Specified the color channel for which the curve will be returned.
[in]	curve	A vector that will be populated with the color curve used in capture.

Returns: success/status of the call.

◆ getToneMapCurveEnabled()

virtual bool Argus::ICaptureMetadata::getToneMapCurveEnabled ( ) const

pure virtual

Returns true if and only if a user-specified tone map curve was used for this capture.

◆ id()

static const InterfaceID& Argus::ICaptureMetadata::id ( )

inlinestatic

Definition at line 186 of file CaptureMetadata.h.

Field Documentation

◆ NUM_AWB_WB_ESTIMATE_ELEMENTS

const uint32_t Argus::ICaptureMetadata::NUM_AWB_WB_ESTIMATE_ELEMENTS = 4

static

Definition at line 189 of file CaptureMetadata.h.

◆ NUM_COLOR_CORRECTION_ELEMENTS

const uint32_t Argus::ICaptureMetadata::NUM_COLOR_CORRECTION_ELEMENTS = 9

static

Definition at line 188 of file CaptureMetadata.h.

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

Argus/CaptureMetadata.h


Jetson Linux API Reference	32.7.5 Release

Jetson Linux API Reference

32.7.5 Release

Detailed Description

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Constructor & Destructor Documentation

◆ ~ICaptureMetadata()

Member Function Documentation

◆ getAeLocked()

◆ getAeRegions()

◆ getAeState()

◆ getAfMode()

◆ getAfRegions()

◆ getAperturePosition()

◆ getAwbCct()

◆ getAwbGains()

◆ getAwbMode()

◆ getAwbRegions()

◆ getAwbState()

◆ getAwbWbEstimate()

◆ getBayerHistogram()

◆ getBayerHistogramRegion()

◆ getCaptureId()

◆ getClientData()

◆ getColorCorrectionMatrix()

◆ getColorCorrectionMatrixEnable()

◆ getColorSaturation()

◆ getFlickerState()

◆ getFocuserPosition()

◆ getFrameDuration()

◆ getFrameReadoutTime()

◆ getIspDigitalGain()

◆ getRGBHistogram()

◆ getSceneLux()

◆ getSensorAnalogGain()

◆ getSensorExposureTime()

◆ getSensorSensitivity()

◆ getSensorTimestamp()

◆ getSharpnessScore()

◆ getStreamMetadata()

◆ getToneMapCurve()

◆ getToneMapCurveEnabled()

◆ id()

Field Documentation

◆ NUM_AWB_WB_ESTIMATE_ELEMENTS

◆ NUM_COLOR_CORRECTION_ELEMENTS