DriveWorks SDK Reference
5.20.37 Release
For Test and Development only

Image Extra Interface

Detailed Description

Defines extra methods for image interface.

Data Structures

struct  dwImageNvMediaLuminanceROIData
 SIPL meta information stored with each image. More...
 
struct  dwImageNvMediaLuminanceStatsData
 

Macros

#define DW_IMAGE_NUM_ISP_UNITS   2
 Number of available ISP Units. More...
 
#define DW_ISP_MAX_LAC_ROI   (NVSIPL_ISP_MAX_LAC_ROI)
 
#define DW_ISP_MAX_LAC_ROI_WINDOWS   (NVSIPL_ISP_MAX_LAC_ROI_WINDOWS)
 
#define DW_LUMINANCE_NUM_ISP_UNITS   1
 

Typedefs

typedef nvsipl::NvSiplISPBadPixelStats NvMediaISPBadPixelStats
 
typedef nvsipl::NvSiplISPBadPixelStatsData NvMediaISPBadPixelStatsData
 
typedef nvsipl::NvSiplISPHistogramStats NvMediaISPHistogramStats
 
typedef nvsipl::NvSiplISPHistogramStatsData NvMediaISPHistogramStatsData
 
typedef nvsipl::NvSiplISPLocalAvgClipStats NvMediaISPLocalAvgClipStats
 
typedef nvsipl::NvSiplISPLocalAvgClipStatsData NvMediaISPLocalAvgClipStatsData
 

Functions

DW_API_PUBLIC dwStatus dwImage_getNvSIPLMetadata (dwImageNvSIPLMetadata *metadata, dwConstImageHandle_t image)
 Retrieves the SIPL metadata of a dwImageHandle_t. More...
 
DW_API_PUBLIC dwStatus dwImage_setNvSIPLMetadata (dwImageNvSIPLMetadata const *const metadata, dwImageHandle_t const image)
 Sets the SIPL metadata of a dwImageHandle_t. More...
 

Data Structure Documentation

◆ dwImageNvMediaLuminanceROIData

struct dwImageNvMediaLuminanceROIData
Data Fields
float32_t average[DW_ISP_MAX_LAC_ROI_WINDOWS][DW_ISP_MAX_COLOR_COMPONENT] Holds average pixel value for each color component in each window in RGGB/RCCB/RCCC order.
uint32_t numWindowsH
uint32_t numWindowsV Holds number of windows vertically in one region of interest.

◆ dwImageNvMediaLuminanceStatsData

struct dwImageNvMediaLuminanceStatsData

◆ dwImageNvSIPLMetadata

struct dwImageNvSIPLMetadata
Data Fields
NvMediaISPBadPixelStats badPixelSettings Holds the ISP bad pixel settings for the previous ISP output frame.
NvMediaISPBadPixelStatsData badPixelStats Holds the ISP bad pixel statistics for the previous ISP output frame.
bool badPixelStatsValid Holds a flag indicating if the ISP bad pixel statistics are valid.
NvMediaISPHistogramStats histogramSettings[DW_IMAGE_NUM_ISP_UNITS] Holds the ISP histogram settings.
NvMediaISPHistogramStatsData histogramStats[DW_IMAGE_NUM_ISP_UNITS] Holds the ISP histogram statistics.
bool histValid[DW_IMAGE_NUM_ISP_UNITS] Holds a flag indicating if the ISP histogram statistics are valid.
DevBlkCDIIllumination illuminationInfo Holds the sensor illumination info.
NvMediaISPLocalAvgClipStats localAvgClipSettings[DW_IMAGE_NUM_ISP_UNITS] Holds the ISP Local Average and Clipped settings for the previous ISP output frame.
dwImageNvMediaLuminanceStatsData localAvgClipStats[DW_LUMINANCE_NUM_ISP_UNITS] Holds the ISP Local Average and Clipped statistics for the previous ISP output frame.
bool localAvgClipStatsValid[DW_LUMINANCE_NUM_ISP_UNITS] Holds a flag indicating if the ISP Local Average and Clipped statistics are valid.
uint32_t numExposures Holds the number of the exposures.
DevBlkCDIExposure sensorExpInfo Holds sensor exposure info including exposure times and gains.
DevBlkCDIWhiteBalance sensorWBInfo Holds the sensor white balance info.

Macro Definition Documentation

◆ DW_IMAGE_NUM_ISP_UNITS

#define DW_IMAGE_NUM_ISP_UNITS   2

Number of available ISP Units.

Definition at line 66 of file ImageSipl.h.

◆ DW_ISP_MAX_LAC_ROI

#define DW_ISP_MAX_LAC_ROI   (NVSIPL_ISP_MAX_LAC_ROI)

Definition at line 69 of file ImageSipl.h.

◆ DW_ISP_MAX_LAC_ROI_WINDOWS

#define DW_ISP_MAX_LAC_ROI_WINDOWS   (NVSIPL_ISP_MAX_LAC_ROI_WINDOWS)

Definition at line 68 of file ImageSipl.h.

◆ DW_LUMINANCE_NUM_ISP_UNITS

#define DW_LUMINANCE_NUM_ISP_UNITS   1

Definition at line 67 of file ImageSipl.h.

Typedef Documentation

◆ NvMediaISPBadPixelStats

typedef nvsipl::NvSiplISPBadPixelStats NvMediaISPBadPixelStats

Definition at line 54 of file ImageSipl.h.

◆ NvMediaISPBadPixelStatsData

typedef nvsipl::NvSiplISPBadPixelStatsData NvMediaISPBadPixelStatsData

Definition at line 55 of file ImageSipl.h.

◆ NvMediaISPHistogramStats

typedef nvsipl::NvSiplISPHistogramStats NvMediaISPHistogramStats

Definition at line 59 of file ImageSipl.h.

◆ NvMediaISPHistogramStatsData

typedef nvsipl::NvSiplISPHistogramStatsData NvMediaISPHistogramStatsData

Definition at line 58 of file ImageSipl.h.

◆ NvMediaISPLocalAvgClipStats

typedef nvsipl::NvSiplISPLocalAvgClipStats NvMediaISPLocalAvgClipStats

Definition at line 56 of file ImageSipl.h.

◆ NvMediaISPLocalAvgClipStatsData

typedef nvsipl::NvSiplISPLocalAvgClipStatsData NvMediaISPLocalAvgClipStatsData

Definition at line 57 of file ImageSipl.h.

Function Documentation

◆ dwImage_getNvSIPLMetadata()

DW_API_PUBLIC dwStatus dwImage_getNvSIPLMetadata ( dwImageNvSIPLMetadata metadata,
dwConstImageHandle_t  image 
)

Retrieves the SIPL metadata of a dwImageHandle_t.

Parameters
[out]metadataA pointer to the SIPL metadata
[in]imageA handle to the image
Returns
DW_SUCCESS,
DW_INVALID_ARGUMENT if the given metadata pointer is null,
DW_INVALID_HANDLE if the given image handle is invalid,i.e null or of wrong type
API Group
  • Init: Yes
  • Runtime: Yes
  • De-Init: Yes

◆ dwImage_setNvSIPLMetadata()

DW_API_PUBLIC dwStatus dwImage_setNvSIPLMetadata ( dwImageNvSIPLMetadata const *const  metadata,
dwImageHandle_t const  image 
)

Sets the SIPL metadata of a dwImageHandle_t.

Parameters
[out]metadataA pointer to the SIPL metadata
[in]imageA handle to the image
Returns
DW_SUCCESS,
DW_INVALID_ARGUMENT if the given metadata pointer is null,
DW_INVALID_HANDLE if the given image handle is invalid,i.e null or of wrong type