VPI - Vision Programming Interface

3.1 Release

DCFTracker.h
Go to the documentation of this file.
1 /*
2  * Copyright 2023 NVIDIA Corporation. All rights reserved.
3  *
4  * NOTICE TO LICENSEE:
5  *
6  * This source code and/or documentation ("Licensed Deliverables") are
7  * subject to NVIDIA intellectual property rights under U.S. and
8  * international Copyright laws.
9  *
10  * These Licensed Deliverables contained herein is PROPRIETARY and
11  * CONFIDENTIAL to NVIDIA and is being provided under the terms and
12  * conditions of a form of NVIDIA software license agreement by and
13  * between NVIDIA and Licensee ("License Agreement") or electronically
14  * accepted by Licensee. Notwithstanding any terms or conditions to
15  * the contrary in the License Agreement, reproduction or disclosure
16  * of the Licensed Deliverables to any third party without the express
17  * written consent of NVIDIA is prohibited.
18  *
19  * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
20  * LICENSE AGREEMENT, NVIDIA MAKES NO REPRESENTATION ABOUT THE
21  * SUITABILITY OF THESE LICENSED DELIVERABLES FOR ANY PURPOSE. IT IS
22  * PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY OF ANY KIND.
23  * NVIDIA DISCLAIMS ALL WARRANTIES WITH REGARD TO THESE LICENSED
24  * DELIVERABLES, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY,
25  * NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.
26  * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
27  * LICENSE AGREEMENT, IN NO EVENT SHALL NVIDIA BE LIABLE FOR ANY
28  * SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, OR ANY
29  * DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
30  * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
31  * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
32  * OF THESE LICENSED DELIVERABLES.
33  *
34  * U.S. Government End Users. These Licensed Deliverables are a
35  * "commercial item" as that term is defined at 48 C.F.R. 2.101 (OCT
36  * 1995), consisting of "commercial computer software" and "commercial
37  * computer software documentation" as such terms are used in 48
38  * C.F.R. 12.212 (SEPT 1995) and is provided to the U.S. Government
39  * only as a commercial end item. Consistent with 48 C.F.R.12.212 and
40  * 48 C.F.R. 227.7202-1 through 227.7202-4 (JUNE 1995), all
41  * U.S. Government End Users acquire the Licensed Deliverables with
42  * only those rights set forth herein.
43  *
44  * Any use of the Licensed Deliverables in individual and commercial
45  * software must include, in the user documentation and internal
46  * comments to the code, the above Disclaimer and U.S. Government End
47  * Users Notice.
48  */
49 
56 #ifndef NV_VPI_ALGORITHMS_DCF_TRACKER_H
57 #define NV_VPI_ALGORITHMS_DCF_TRACKER_H
58 
166 #include "../Export.h"
167 #include "../ImageFormat.h"
168 #include "../Status.h"
169 #include "../Types.h"
170 
171 #include <stdint.h>
172 
173 #ifdef __cplusplus
174 extern "C" {
175 #endif
176 
178 typedef enum
179 {
189 
191 typedef struct
192 {
197  uint32_t flags;
198 
205 
209  int32_t hogCellSize;
210 
214 
219 
235 
271 VPI_PUBLIC VPIStatus vpiCreateDCFTracker(uint64_t backends, int32_t maxNumSequences, int32_t maxNumObjects,
272  const VPIDCFTrackerCreationParams *params, VPIPayload *payload);
273 
276 typedef struct
277 {
281 
292 
382  VPIStream stream, uint64_t backend, VPIPayload payload, const int32_t *enabledSequences, int32_t numSequences,
383  VPIImage featureMaskingWindow, VPIImage inPatches, VPIArray inObjects, VPIArray outObjects,
384  VPIImage outCorrelationResponses, VPIArray outMaxCorrelationResponses, const VPIDCFTrackerParams *params);
385 
463 VPI_PUBLIC VPIStatus vpiSubmitDCFTrackerUpdateBatch(VPIStream stream, uint64_t backend, VPIPayload payload,
464  const int32_t *enabledSequences, int32_t numSequences,
465  VPIImage featureMaskingWindow, VPIImage modelMaskingWindow,
466  VPIImage inPatches, VPIArray trackedObjects,
467  const VPIDCFTrackerParams *params);
468 
490 VPI_PUBLIC VPIStatus vpiDCFTrackerGetChannelWeights(VPIPayload payload, VPIArray *channelWeights,
491  int32_t *numFeatureChannels);
492 
495 #ifdef __cplusplus
496 }
497 #endif
498 
499 #endif /* NV_VPI_ALGORITHMS_DCF_TRACKER_H */
struct VPIArrayImpl * VPIArray
A handle to an array.
Definition: Types.h:232
float featureFocusVertOffsetFactor
Offset for the center of the Hanning window relative to the patch height.
Definition: DCFTracker.h:213
int32_t hogCellSize
Cell size for features from Histogram of Oriented Gradients.
Definition: DCFTracker.h:209
int32_t featurePatchSize
Size of an object feature patch.
Definition: DCFTracker.h:204
uint32_t flags
Flags to customize DCF Tracker algorithm.
Definition: DCFTracker.h:197
float gaussianSigma
Standard deviation for gaussian for desired response.
Definition: DCFTracker.h:217
float dcfRegFactor
Regularization factor used in DCF filter creation.
Definition: DCFTracker.h:279
VPIStatus vpiSubmitDCFTrackerLocalizeBatch(VPIStream stream, uint64_t backend, VPIPayload payload, const int32_t *enabledSequences, int32_t numSequences, VPIImage featureMaskingWindow, VPIImage inPatches, VPIArray inObjects, VPIArray outObjects, VPIImage outCorrelationResponses, VPIArray outMaxCorrelationResponses, const VPIDCFTrackerParams *params)
Localizes each tracked object in the input image patches using the Discriminative Correlation Filter ...
VPIStatus vpiSubmitDCFTrackerUpdateBatch(VPIStream stream, uint64_t backend, VPIPayload payload, const int32_t *enabledSequences, int32_t numSequences, VPIImage featureMaskingWindow, VPIImage modelMaskingWindow, VPIImage inPatches, VPIArray trackedObjects, const VPIDCFTrackerParams *params)
Update internal object tracking information based on its state and its corresponding input image patc...
VPIStatus vpiInitDCFTrackerParams(VPIDCFTrackerParams *params)
Initialize VPIDCFTrackerParams with default values.
VPIStatus vpiCreateDCFTracker(uint64_t backends, int32_t maxNumSequences, int32_t maxNumObjects, const VPIDCFTrackerCreationParams *params, VPIPayload *payload)
Creates payload for DCF Tracker.
VPIDCFTrackerCreationFlag
Flags to customize DCF Tracker algorithm.
Definition: DCFTracker.h:179
VPIStatus vpiInitDCFTrackerCreationParams(VPIDCFTrackerCreationParams *params)
Initialize VPIDCFTrackerCreationParams with default values.
VPIStatus vpiDCFTrackerGetChannelWeights(VPIPayload payload, VPIArray *channelWeights, int32_t *numFeatureChannels)
Returns the array with channel weight information for each tracked object.
@ VPI_DCFTRACKER_USE_COLORNAMES
Use ColorNames feature.
Definition: DCFTracker.h:181
@ VPI_DCFTRACKER_USE_HIGH_PRECISION_FEATURES
Use 16-bit high precision features.
Definition: DCFTracker.h:185
@ VPI_DCFTRACKER_USE_HOG
Use Histogram of Oriented Gradients feature.
Definition: DCFTracker.h:183
@ VPI_DCFTRACKER_DETERMINISTIC
Use deterministic mode.
Definition: DCFTracker.h:187
Creation parameters of DCF Tracker.
Definition: DCFTracker.h:192
Structure that defines the parameters for vpiCreateDCFTracker.
Definition: DCFTracker.h:277
struct VPIImageImpl * VPIImage
A handle to an image.
Definition: Types.h:256
struct VPIPayloadImpl * VPIPayload
A handle to an algorithm payload.
Definition: Types.h:268
VPIStatus
Status codes.
Definition: Status.h:81
struct VPIStreamImpl * VPIStream
A handle to a stream.
Definition: Types.h:250