NVIDIA DeepStream SDK API Reference

9.2 Release
sources/libs/nvmultiobjecttracker/include/modules/VisualTracker/VisualTracker_factory.hpp
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2021-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3  * SPDX-License-Identifier: Apache-2.0
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 #ifndef VISUALTRACKERLIB_VISUALTRACKER_FACTORY_HPP_
19 #define VISUALTRACKERLIB_VISUALTRACKER_FACTORY_HPP_
20 
21 #include <memory>
22 #include "modules/NvMultiObjectTracker/NvTrackerParams.hpp"
23 #include "modules/VisualTracker/IVisualTracker.hpp"
24 
25 // Visual trackers.
26 #include "modules/VisualTracker/DummyVisualTracker.hpp"
27 #ifndef _WIN32
28 #include "modules/VisualTracker/VisualTracker.hpp"
29 #include "modules/VisualTracker/DCFTracker.hpp"
30 #endif
31 
34 {
35 public:
38  {
40  }
41 
47  VisualTrackerFactoryParams(const std::string &configFilePath, const std::string moduleName)
48  {
49  YAML::Node configRoot = getConfigRoot(configFilePath);
50  this->read(configRoot[moduleName]);
51  }
52 
57  VisualTrackerFactoryParams(const YAML::Node &fn)
58  {
59  read(fn);
60  }
61 
66  void read(const YAML::Node &fn) override
67  {
70  if(!fn.size()) { return;}
71 
72  for (YAML::const_iterator fit = fn.begin(); fit != fn.end(); ++fit)
73  {
74  std::string paramKey = fit->first.as<std::string>();
75 
76  if (paramKey == "visualTrackerType")
77  {
78  int trackerTypeInt = (int)fit->second.as<float>();
80  if (trackerTypeInt < 0 || trackerTypeInt > 2)
81  {
82  throw std::runtime_error(
83  "Invalid visualTrackerType value: " + std::to_string(trackerTypeInt) + ". Valid range is 0-2 (0=DUMMY_VOT, 1=NvDCF_VOT, 2=NvDCF_VPI_VOT)."
84  );
85  }
86  m_visualTrackerType = (VISUAL_TRACKER_TYPES)trackerTypeInt;
87  }
88  }
89  }
90 
91  // [Configuration parameters for the factory]
93 };
94 
97 {
98 public:
101  {
102  static VisualTrackerFactory instance;
103  return instance;
104  }
105 
111  std::shared_ptr<IVisualTracker> makeVisualTracker(const std::string configFilePath)
112  {
113 #ifdef _WIN32
114  m_params = VisualTrackerFactoryParams(configFilePath, "VisualTracker");
116  throw std::runtime_error("Only IOU tracking is available in the Windows tracker build");
117  }
118  return std::make_shared<DummyVisualTracker>(configFilePath);
119 #else
120  m_params = VisualTrackerFactoryParams(configFilePath, "VisualTracker");
122 
124  {
126  {
127  return std::make_shared<VisualTracker>(configFilePath);
128  }
130  {
131  return std::make_shared<DCFTracker>(configFilePath);
132  }
134  default:
135  {
136  return std::make_shared<DummyVisualTracker>(configFilePath);
137  }
138  }
139  return nullptr;
140 #endif
141  }
142 
143 protected:
144 
146 };
147 
148 #endif // VISUALTRACKERLIB_VISUALTRACKER_FACTORY_HPP_
VisualTrackerFactoryParams::m_visualTrackerType
VISUAL_TRACKER_TYPES m_visualTrackerType
The type of visual tracker.
Definition: sources/libs/nvmultiobjecttracker/include/modules/VisualTracker/VisualTracker_factory.hpp:92
VisualTrackerFactoryParams::VisualTrackerFactoryParams
VisualTrackerFactoryParams(const YAML::Node &fn)
Construct factory parameters from a YAML node.
Definition: sources/libs/nvmultiobjecttracker/include/modules/VisualTracker/VisualTracker_factory.hpp:57
VisualTrackerFactory::m_params
VisualTrackerFactoryParams m_params
Config params for visual tracker module.
Definition: sources/libs/nvmultiobjecttracker/include/modules/VisualTracker/VisualTracker_factory.hpp:145
VisualTrackerFactoryParams
Configuration parameters for the visual tracker factory.
Definition: sources/libs/nvmultiobjecttracker/include/modules/VisualTracker/VisualTracker_factory.hpp:33
VisualTrackerFactoryParams::VisualTrackerFactoryParams
VisualTrackerFactoryParams(const std::string &configFilePath, const std::string moduleName)
Construct factory parameters from a named module in a file.
Definition: sources/libs/nvmultiobjecttracker/include/modules/VisualTracker/VisualTracker_factory.hpp:47
VisualTrackerFactory::makeVisualTracker
std::shared_ptr< IVisualTracker > makeVisualTracker(const std::string configFilePath)
Create the visual tracker selected by a configuration file.
Definition: sources/libs/nvmultiobjecttracker/include/modules/VisualTracker/VisualTracker_factory.hpp:111
NvTrackerParams::getConfigRoot
static const YAML::Node getConfigRoot(const std::string &configFilePath, const bool printMessage=false)
Load the root YAML node from a tracker configuration file.
Definition: sources/libs/nvmultiobjecttracker/include/modules/NvMultiObjectTracker/NvTrackerParams.hpp:121
VisualTrackerFactory
Create a concrete visual tracker from the configuration.
Definition: sources/libs/nvmultiobjecttracker/include/modules/VisualTracker/VisualTracker_factory.hpp:96
VisualTrackerFactoryParams::VisualTrackerFactoryParams
VisualTrackerFactoryParams()
Construct default factory parameters selecting the dummy tracker.
Definition: sources/libs/nvmultiobjecttracker/include/modules/VisualTracker/VisualTracker_factory.hpp:37
VisualTrackerFactoryParams::read
void read(const YAML::Node &fn) override
Read visual tracker factory parameters from a YAML node.
Definition: sources/libs/nvmultiobjecttracker/include/modules/VisualTracker/VisualTracker_factory.hpp:66
VISUAL_TRACKER_TYPES
VISUAL_TRACKER_TYPES
Visual tracker implementations that can be selected by configuration.
Definition: sources/libs/nvmultiobjecttracker/include/modules/VisualTracker/IVisualTracker.hpp:27
DUMMY_VOT
@ DUMMY_VOT
Selects the dummy visual tracker.
Definition: sources/libs/nvmultiobjecttracker/include/modules/VisualTracker/IVisualTracker.hpp:29
NvTrackerParams
Provides common loading helpers for tracker configuration parameters.
Definition: sources/libs/nvmultiobjecttracker/include/modules/NvMultiObjectTracker/NvTrackerParams.hpp:35
VisualTrackerFactory::getInstance
static VisualTrackerFactory & getInstance()
Return the process-wide visual tracker factory instance.
Definition: sources/libs/nvmultiobjecttracker/include/modules/VisualTracker/VisualTracker_factory.hpp:100
NvDCF_VOT
@ NvDCF_VOT
Selects the NvDCF visual tracker.
Definition: sources/libs/nvmultiobjecttracker/include/modules/VisualTracker/IVisualTracker.hpp:30
NvDCF_VPI_VOT
@ NvDCF_VPI_VOT
Selects the VPI-based NvDCF visual tracker.
Definition: sources/libs/nvmultiobjecttracker/include/modules/VisualTracker/IVisualTracker.hpp:31