L4T Multimedia API Reference

28.1 Release

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Argus::ICaptureMetadata Class Referenceabstract

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 InterfaceProvidergetStreamMetadata (const OutputStream *stream) const =0
 Returns the per-stream metadata provider for stream. More...
 
virtual const InterfaceProvidergetBayerHistogram () const =0
 Returns the Bayer histogram for this capture. More...
 
virtual const InterfaceProvidergetRGBHistogram () 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 AeState getAeState () const =0
 Returns the state of AE when it ran for this capture. 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 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 start 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 InterfaceIDid ()
 

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

Argus::ICaptureMetadata::~ICaptureMetadata ( )
inlineprotected

Definition at line 368 of file CaptureMetadata.h.

Member Function Documentation

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

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

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

Gets the AE regions of interest used for this capture.

Parameters
[in]regionsA vector that will be populated with the AE regions used in capture.
Returns
success/status of the call.
virtual AeState Argus::ICaptureMetadata::getAeState ( ) const
pure virtual

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

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

Returns the CCT calculated by AWB for this capture.

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

Returns the AWB gains used for this capture.

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

Returns the AWB mode used for this capture.

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

Gets the AWB regions of interest used for this capture.

Parameters
[in]regionsA vector that will be populated with the AWB regions used in capture.
Returns
success/status of the call.
virtual AwbState Argus::ICaptureMetadata::getAwbState ( ) const
pure virtual
Returns
the state of AWB when it ran for this capture.
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]estimateA vector that will be populated with the AWB WB estimates.
Returns
success/status of the call.
virtual const InterfaceProvider* Argus::ICaptureMetadata::getBayerHistogram ( ) const
pure virtual

Returns the Bayer histogram for this capture.

This object will provide the IBayerHistogram interface.

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.

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()
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]ccMatrixA vector that will be populated with the color correction matrix.
Returns
success/status of the call.
virtual bool Argus::ICaptureMetadata::getColorCorrectionMatrixEnable ( ) const
pure virtual

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

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

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

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

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

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

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

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.

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

Returns the digital gain used for this capture.

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

Returns the RGB histogram for this capture.

This object will provide the IRGBHistogram interface.

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

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

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

Returns the sensor analog gain used for this capture.

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

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

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

Returns the ISO value used for this capture.

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

Returns the start timestamp for the sensor (in nanoseconds).

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

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.

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]channelSpecified the color channel for which the curve will be returned.
[in]curveA vector that will be populated with the color curve used in capture.
Returns
success/status of the call.
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.

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

Definition at line 186 of file CaptureMetadata.h.

Field Documentation

const uint32_t Argus::ICaptureMetadata::NUM_AWB_WB_ESTIMATE_ELEMENTS = 4
static

Definition at line 189 of file CaptureMetadata.h.

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: