Utility functions for OpenCV samples

Detailed Description

Function Documentation

addSamplesDataSearchPath()

void cv::samples::addSamplesDataSearchPath(const cv::String & path)

#include <opencv2/core/utility.hpp>

Override search data path by adding new search location.

Use this only to override default behavior Passed paths are used in LIFO order.

Parameters

• path — Path to used samples data

addSamplesDataSearchSubDirectory()

void cv::samples::addSamplesDataSearchSubDirectory(const cv::String & subdir)

#include <opencv2/core/utility.hpp>

Append samples search data sub directory.

General usage is to add OpenCV modules name (<opencv_contrib>/modules/<name>/samples/data -> <name>/samples/data + modules/<name>/samples/data). Passed subdirectories are used in LIFO order.

Parameters

• subdir — samples data sub directory

findFile()

cv::String cv::samples::findFile(
const cv::String & relative_path,
bool required = true,
bool silentMode = false )

#include <opencv2/core/utility.hpp>

Try to find requested data file.

Search directories:

1. Directories passed via addSamplesDataSearchPath()

2. OPENCV_SAMPLES_DATA_PATH_HINT environment variable

3. OPENCV_SAMPLES_DATA_PATH environment variable If parameter value is not empty and nothing is found then stop searching.

4. Detects build/install path based on: a. current working directory (CWD) b. and/or binary module location (opencv_core/opencv_world, doesn’t work with static linkage)

5. Scan <source>/{,data,samples/data} directories if build directory is detected or the current directory is in source tree.

6. Scan <install>/share/OpenCV directory if install directory is detected.

See also

cv::utils::findDataFile

Parameters

• relative_path — Relative path to data file

• required — Specify “file not found” handling. If true, function prints information message and raises cv::Exception. If false, function returns empty result

• silentMode — Disables messages

Returns — Returns path (absolute or relative to the current directory) or empty string if file is not found

findFileOrKeep()

inline cv::String cv::samples::findFileOrKeep(
const cv::String & relative_path,
bool silentMode = false )

#include <opencv2/core/utility.hpp>

Here is the call graph for this function: