NVIDIA DriveOS Linux NSR SDK API Reference

7.0.3.0 Release
PVA_ALGOS_Object_Detector

Detailed Description

Data Structures

struct  pvaAlgosObjectDetectorIOBuffer_t
 Structure that holds I/O Buffers that change based on the frame inputs. More...
 

Typedefs

typedef enum pvaAlgosObjectClass pvaAlgosObjectClass
 Structure that holds configuration parameters for a Object detector. More...
 
typedef struct ObjectDetectorContext * pvaAlgosObjectDetectorContext_t
 Structure that stores internal objects needed for Object Detector. More...
 

Enumerations

enum  pvaAlgosObjectClass {
  PERSON,
  OBJECT_CLASS_MAX
}
 Structure that holds configuration parameters for a Object detector. More...
 

Functions

pvaAlgosError_t pvaAlgosObjectDetectorGetContext (pvaAlgosObjectDetectorContext_t *ObjectDetectorContext)
 Initializes ObjectDetectorContext object and sends it back to the caller. More...
 
pvaAlgosError_t pvaAlgosObjectDetectorInit (pvaAlgosObjectDetectorContext_t *ObjectDetectorContext, pvaAlgosObjectDetectorConfig_t *ObjectDetectorParams)
 Initializes the necessary values for the internal objects in pvaAlgosObjectDetectorContext_t object. More...
 
pvaAlgosError_t pvaAlgosObjectDetectorProcess (pvaAlgosObjectDetectorContext_t *ObjectDetectorContext, pvaAlgosObjectDetectorIOBuffer_t *ObjectDetectorBuffers, cupvaStream_t *instanceStream, int execTimeout)
 Sets the I/O Buffers to the internal objects and runs the Object Detector Algorithm. More...
 
pvaAlgosError_t pvaAlgosObjectDetectorDeInit (pvaAlgosObjectDetectorContext_t *ObjectDetectorContext)
 Frees the internal objects and the ObjectDetectorContext object. More...
 

Typedef Documentation

◆ pvaAlgosObjectClass

Structure that holds configuration parameters for a Object detector.

◆ pvaAlgosObjectDetectorContext_t

typedef struct ObjectDetectorContext* pvaAlgosObjectDetectorContext_t

Structure that stores internal objects needed for Object Detector.

Definition at line 75 of file pva_algos_object_detector.h.

Enumeration Type Documentation

◆ pvaAlgosObjectClass

Structure that holds configuration parameters for a Object detector.

Enumerator
PERSON 
OBJECT_CLASS_MAX 

Definition at line 23 of file pva_algos_object_detector.h.

Function Documentation

◆ pvaAlgosObjectDetectorDeInit()

pvaAlgosError_t pvaAlgosObjectDetectorDeInit ( pvaAlgosObjectDetectorContext_t ObjectDetectorContext)

Frees the internal objects and the ObjectDetectorContext object.

Parameters
[in]ObjectDetectorContextThe pointer to a ObjectDetectorContext object that stores the internal parameters needed for Object Detector
Returns
pvaAlgosError_t The completion status of the operation. Its value is pvaAlgosStatusSuccess if the operation is successful

◆ pvaAlgosObjectDetectorGetContext()

pvaAlgosError_t pvaAlgosObjectDetectorGetContext ( pvaAlgosObjectDetectorContext_t ObjectDetectorContext)

Initializes ObjectDetectorContext object and sends it back to the caller.

Parameters
[in]detectorContextThe pointer to a pvaAlgosObjectDetectorContext_t object that stores the internal parameters needed for Object Detector
Returns
pvaAlgosError_t The completion status of the operation. Its value is pvaAlgosStatusSuccess if the operation is successful

◆ pvaAlgosObjectDetectorInit()

pvaAlgosError_t pvaAlgosObjectDetectorInit ( pvaAlgosObjectDetectorContext_t ObjectDetectorContext,
pvaAlgosObjectDetectorConfig_t ObjectDetectorParams 
)

Initializes the necessary values for the internal objects in pvaAlgosObjectDetectorContext_t object.

Parameters
[in]ObjectDetectorContextThe pointer to a pvaAlgosObjectDetectorContext_t object that stores the internal parameters needed for Object Detector
[in]ObjectDetectorParamsThe pointer to a pvaAlgosObjectDetectorConfig_t object
that stores the configuration parameters for Object Detector
Returns
pvaAlgosError_t The completion status of the operation. Possible values are:

◆ pvaAlgosObjectDetectorProcess()

pvaAlgosError_t pvaAlgosObjectDetectorProcess ( pvaAlgosObjectDetectorContext_t ObjectDetectorContext,
pvaAlgosObjectDetectorIOBuffer_t ObjectDetectorBuffers,
cupvaStream_t instanceStream,
int  execTimeout 
)

Sets the I/O Buffers to the internal objects and runs the Object Detector Algorithm.

Parameters
[in]ObjectDetectorContextThe pointer to a pvaAlgosObjectDetectorContext_t object that stores the internal parameters needed for Object Detector
[in]ObjectDetectorBuffersThe pointer to a pvaAlgosObjectDetectorIOBuffer_t object that stores the I/O Buffers that change each frame
[in]postFenceThe pointer to a cupvaFence_t object needed for the synchronization across instructions sent to the PVA Engine
[in]instanceStreamThe pointer to a cupvaStream_t object needed to submit instructions to the PVA Engine
Returns
pvaAlgosError_t The completion status of the operation. Its value is pvaAlgosStatusSuccess if the operation is successful