File: initalization_and_information.rst

package info (click to toggle)
opencv 2.4.9.1%2Bdfsg-1%2Bdeb8u1
  • links: PTS, VCS
  • area: main
  • in suites: jessie
  • size: 126,800 kB
  • ctags: 62,729
  • sloc: xml: 509,055; cpp: 490,794; lisp: 23,208; python: 21,174; java: 19,317; ansic: 1,038; sh: 128; makefile: 72
file content (219 lines) | stat: -rw-r--r-- 5,870 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
Initalization and Information
=============================

.. highlight:: cpp



gpu::getCudaEnabledDeviceCount
------------------------------
Returns the number of installed CUDA-enabled devices.

.. ocv:function:: int gpu::getCudaEnabledDeviceCount()

Use this function before any other GPU functions calls. If OpenCV is compiled without GPU support, this function returns 0.



gpu::setDevice
--------------
Sets a device and initializes it for the current thread.

.. ocv:function:: void gpu::setDevice(int device)

    :param device: System index of a GPU device starting with 0.

If the call of this function is omitted, a default device is initialized at the fist GPU usage.



gpu::getDevice
--------------
Returns the current device index set by :ocv:func:`gpu::setDevice` or initialized by default.

.. ocv:function:: int gpu::getDevice()



gpu::resetDevice
----------------
Explicitly destroys and cleans up all resources associated with the current device in the current process.

.. ocv:function:: void gpu::resetDevice()

Any subsequent API call to this device will reinitialize the device.



gpu::FeatureSet
---------------
Enumeration providing GPU computing features.

.. ocv:enum:: gpu::FeatureSet

  .. ocv:emember:: FEATURE_SET_COMPUTE_10
  .. ocv:emember:: FEATURE_SET_COMPUTE_11
  .. ocv:emember:: FEATURE_SET_COMPUTE_12
  .. ocv:emember:: FEATURE_SET_COMPUTE_13
  .. ocv:emember:: FEATURE_SET_COMPUTE_20
  .. ocv:emember:: FEATURE_SET_COMPUTE_21
  .. ocv:emember:: GLOBAL_ATOMICS
  .. ocv:emember:: SHARED_ATOMICS
  .. ocv:emember:: NATIVE_DOUBLE


gpu::TargetArchs
----------------
.. ocv:class:: gpu::TargetArchs

Class providing a set of static methods to check what NVIDIA* card architecture the GPU module was built for.

The following method checks whether the module was built with the support of the given feature:

    .. ocv:function:: static bool gpu::TargetArchs::builtWith( FeatureSet feature_set )

        :param feature_set: Features to be checked. See :ocv:enum:`gpu::FeatureSet`.

There is a set of methods to check whether the module contains intermediate (PTX) or binary GPU code for the given architecture(s):

    .. ocv:function:: static bool gpu::TargetArchs::has(int major, int minor)

    .. ocv:function:: static bool gpu::TargetArchs::hasPtx(int major, int minor)

    .. ocv:function:: static bool gpu::TargetArchs::hasBin(int major, int minor)

    .. ocv:function:: static bool gpu::TargetArchs::hasEqualOrLessPtx(int major, int minor)

    .. ocv:function:: static bool gpu::TargetArchs::hasEqualOrGreater(int major, int minor)

    .. ocv:function:: static bool gpu::TargetArchs::hasEqualOrGreaterPtx(int major, int minor)

    .. ocv:function:: static bool gpu::TargetArchs::hasEqualOrGreaterBin(int major, int minor)

        :param major: Major compute capability version.

        :param minor: Minor compute capability version.

According to the CUDA C Programming Guide Version 3.2: "PTX code produced for some specific compute capability can always be compiled to binary code of greater or equal compute capability".



gpu::DeviceInfo
---------------
.. ocv:class:: gpu::DeviceInfo

Class providing functionality for querying the specified GPU properties. ::

    class CV_EXPORTS DeviceInfo
    {
    public:
        DeviceInfo();
        DeviceInfo(int device_id);

        string name() const;

        int majorVersion() const;
        int minorVersion() const;

        int multiProcessorCount() const;

        size_t freeMemory() const;
        size_t totalMemory() const;

        bool supports(FeatureSet feature) const;
        bool isCompatible() const;

        int deviceID() const;
    };



gpu::DeviceInfo::DeviceInfo
---------------------------
The constructors.

.. ocv:function:: gpu::DeviceInfo::DeviceInfo()

.. ocv:function:: gpu::DeviceInfo::DeviceInfo(int device_id)

    :param device_id: System index of the GPU device starting with 0.

Constructs the ``DeviceInfo`` object for the specified device. If ``device_id`` parameter is missed, it constructs an object for the current device.



gpu::DeviceInfo::name
---------------------
Returns the device name.

.. ocv:function:: string gpu::DeviceInfo::name() const



gpu::DeviceInfo::majorVersion
-----------------------------
Returns the major compute capability version.

.. ocv:function:: int gpu::DeviceInfo::majorVersion()



gpu::DeviceInfo::minorVersion
-----------------------------
Returns the minor compute capability version.

.. ocv:function:: int gpu::DeviceInfo::minorVersion()



gpu::DeviceInfo::multiProcessorCount
------------------------------------
Returns the number of streaming multiprocessors.

.. ocv:function:: int gpu::DeviceInfo::multiProcessorCount()



gpu::DeviceInfo::freeMemory
---------------------------
Returns the amount of free memory in bytes.

.. ocv:function:: size_t gpu::DeviceInfo::freeMemory()



gpu::DeviceInfo::totalMemory
----------------------------
Returns the amount of total memory in bytes.

.. ocv:function:: size_t gpu::DeviceInfo::totalMemory()



gpu::DeviceInfo::supports
-------------------------
Provides information on GPU feature support.

.. ocv:function:: bool gpu::DeviceInfo::supports( FeatureSet feature_set ) const

    :param feature_set: Features to be checked. See :ocv:enum:`gpu::FeatureSet`.

This function returns ``true`` if the device has the specified GPU feature. Otherwise, it returns ``false`` .



gpu::DeviceInfo::isCompatible
-----------------------------
Checks the GPU module and device compatibility.

.. ocv:function:: bool gpu::DeviceInfo::isCompatible()

This function returns ``true`` if the GPU module can be run on the specified device. Otherwise, it returns ``false`` .



gpu::DeviceInfo::deviceID
-------------------------
Returns system index of the GPU device starting with 0.

.. ocv:function:: int gpu::DeviceInfo::deviceID()