cv::CommandLineParser 类参考

设计用于命令行解析。 更多...

#include <opencv2/core/utility.hpp>

cv::CommandLineParser 的协作图

公开成员函数
	CommandLineParser (const CommandLineParser &parser)
	复制构造函数。
	CommandLineParser (int argc, const char *const argv[], const String &keys)
	构造函数。
	~CommandLineParser ()
	析构函数。
void	about (const String &message)
	设置关于信息。
bool	check () const
	检查解析错误。
template<typename T >
T	get (const String &name, bool space_delete=true) const
	按名称访问参数。
template<typename T >
T	get (int index, bool space_delete=true) const
	按索引访问位置参数。
String	getPathToApplication () const
	返回应用程序路径。
bool	has (const String &name) const
	检查字段是否在命令行中提供。
CommandLineParser &	operator= (const CommandLineParser &parser)
	赋值运算符。
void	printErrors () const
	打印发生的错误列表。
void	printMessage () const
	打印帮助信息。

保护成员函数
void	getByIndex (int index, bool space_delete, Param type, void *dst) const
void	getByName (const String &name, bool space_delete, Param type, void *dst) const

保护属性
Impl *	impl

详细说明

专为命令行解析设计。

下面的示例演示了如何使用 CommandLineParser

CommandLineParser parser(argc, argv, keys);
parser.about("应用程序名称 v1.0.0");
 
if (parser.has("help"))
{
parser.printMessage();
    return 0;
}
 
int N = parser.get<int>("N");
double fps = parser.get<double>("fps");
String path = parser.get<String>("path");
 
use_time_stamp = parser.has("timestamp");
 
String img1 = parser.get<String>(0);
String img2 = parser.get<String>(1);
 
int repeat = parser.get<int>(2);
 
if (!parser.check())
{
parser.printErrors();
    return 0;
}

键语法

keys 参数是一个包含多个块的字符串，每个块都用花括号括起来，描述一个参数。每个参数包含三个部分，由 | 符号分隔

1. 参数名称是选项的同义词列表，用标准的空格字符 ' ' 分隔（要在参数前加上 @ 符号，将其标记为位置参数）
2. 如果未提供参数，则使用默认值（可以为空）
3. 帮助信息（可以为空）

例如

    const String keys =
        "{help h usage ? | | print this message }"
        "{@image1 | | image1 for compare }"
        "{@image2 |<none>| image2 for compare }"
        "{@repeat |1 | number }"
        "{path |. | path to file }"
        "{fps | -1.0 | fps for output video }"
        "{N count |100 | count of objects }"
        "{ts timestamp | | use time stamp }"
        ;
}

请注意，help 和 timestamp 没有默认值，因此我们可以使用 has() 方法检查它们是否存在。具有默认值的参数被视为始终存在。在这种情况下，请使用 get() 方法来检查它们的实际值。请注意，除了标准空格之外的其他空白字符被视为字符串的一部分。此外，帮助消息周围的前导和尾随标准空格将被忽略。

像 get<String>("@image1") 这样的字符串键默认返回空字符串 "" - 即使有空默认值。使用特殊的 <none> 默认值来强制返回的字符串不能为空。（如 get<String>("@image2")）

用法

对于上面描述的键

# 好的调用（3个位置参数：image1、image2 和 repeat；N 为 200，ts 为 true）
$ ./app -N=200 1.png 2.jpg 19 -ts
 
# 坏的调用
$ ./app -fps=aaa
错误
参数 'fps'：无法转换：[aaa] 为 [double]

示例

fld_lines.cpp, modules/shape/samples/shape_example.cpp, samples/cpp/camshiftdemo.cpp, samples/cpp/connected_components.cpp, samples/cpp/contours2.cpp, samples/cpp/convexhull.cpp, samples/cpp/cout_mat.cpp, samples/cpp/create_mask.cpp, samples/cpp/demhist.cpp, samples/cpp/distrans.cpp, samples/cpp/edge.cpp, samples/cpp/facedetect.cpp, samples/cpp/ffilldemo.cpp, samples/cpp/fitellipse.cpp, samples/cpp/grabcut.cpp, samples/cpp/image_alignment.cpp, samples/cpp/laplace.cpp, samples/cpp/lkdemo.cpp, samples/cpp/lsd_lines.cpp, samples/cpp/pca.cpp, samples/cpp/peopledetect.cpp, samples/cpp/polar_transforms.cpp, samples/cpp/segment_objects.cpp, samples/cpp/train_HOG.cpp, samples/cpp/tutorial_code/Histograms_Matching/MatchTemplate_Demo.cpp, samples/cpp/tutorial_code/ImgProc/Morphology_1.cpp, samples/cpp/tutorial_code/ImgProc/Morphology_2.cpp, samples/cpp/tutorial_code/ImgTrans/Sobel_Demo.cpp, samples/cpp/tutorial_code/features2D/Homography/decompose_homography.cpp, samples/cpp/tutorial_code/features2D/Homography/homography_from_camera_displacement.cpp, samples/cpp/tutorial_code/features2D/Homography/pose_from_homography.cpp, samples/cpp/tutorial_code/ml/introduction_to_pca/introduction_to_pca.cpp, samples/cpp/tutorial_code/photo/non_photorealistic_rendering/npr_demo.cpp, samples/cpp/warpPerspective_demo.cpp, samples/cpp/watershed.cpp, samples/dnn/classification.cpp, samples/dnn/colorization.cpp, samples/dnn/object_detection.cpp, samples/dnn/openpose.cpp, samples/dnn/segmentation.cpp, samples/dnn/text_detection.cpp, and samples/tapi/hog.cpp.

构造函数与析构函数说明

CommandLineParser() [1/2]

cv::CommandLineParser::CommandLineParser	(	int	argc,
		const char *const	argv[],
		const String &	keys )

构造函数。

初始化命令行解析器对象

参数

argc	命令行参数的数量（来自 main()）
argv	命令行参数数组（来自 main()）
keys	描述可接受命令行参数的字符串（有关语法，请参阅类描述）

CommandLineParser() [2/2]

cv::CommandLineParser::CommandLineParser

(

const CommandLineParser &

parser

)

复制构造函数。

~CommandLineParser()

cv::CommandLineParser::~CommandLineParser

(

)

析构函数。

成员函数说明

about()

void cv::CommandLineParser::about

(

const String &

message

)

设置关于信息。

当调用 printMessage 时，关于信息将在参数表之前显示。

示例

samples/cpp/polar_transforms.cpp, and samples/dnn/classification.cpp.

check()

bool cv::CommandLineParser::check

(

)

const

检查解析错误。

如果在访问参数时发生错误（例如，类型转换错误、缺少参数等），则返回 false。调用 printErrors 来打印错误消息列表。

示例

samples/dnn/classification.cpp.

get() [1/2]

template<typename T >

T cv::CommandLineParser::get ( const String & name, bool space_delete = true ) const

内联

按名称访问参数。

将参数转换为所选类型。如果参数未知或无法转换为所选类型，则会设置错误标志（可通过 check 进行检查）。

例如，定义

String keys = "{N count||}";

调用

$ ./my-app -N=20
# 或
$ ./my-app --count=20

Access

int N = parser.get<int>("N");

参数

name	参数的名称
space_delete	从字符串的左侧和右侧删除空格

模板参数

T	如果可能，参数将被转换为此类型

注意

您可以通过其 @ 前缀名称访问位置参数

parser.get<String>("@image");

示例

fld_lines.cpp, samples/cpp/lsd_lines.cpp, samples/cpp/polar_transforms.cpp, samples/cpp/tutorial_code/ImgTrans/Sobel_Demo.cpp, samples/cpp/tutorial_code/photo/non_photorealistic_rendering/npr_demo.cpp, samples/dnn/classification.cpp, and samples/tapi/hog.cpp.

get() [2/2]

template<typename T >

T cv::CommandLineParser::get ( int index, bool space_delete = true ) const

内联

按索引访问位置参数。

将参数转换为所选类型。索引从零开始计数。

例如，定义

String keys = "{@arg1||}{@arg2||}"

调用

./my-app abc qwe

访问参数

String val_1 = parser.get<String>(0); // 返回 "abc", arg1
String val_2 = parser.get<String>(1); // 返回 "qwe", arg2

参数

index	参数的索引
space_delete	从字符串的左侧和右侧删除空格

模板参数

T	如果可能，参数将被转换为此类型

getByIndex()

void cv::CommandLineParser::getByIndex ( int index, bool space_delete, Param type, void * dst ) const

保护

getByName()

void cv::CommandLineParser::getByName ( const String & name, bool space_delete, Param type, void * dst ) const

保护

getPathToApplication()

String cv::CommandLineParser::getPathToApplication

(

)

const

返回应用程序路径。

此方法返回可执行文件的路径（argv[0]）。

例如，如果应用程序是通过以下命令启动的

$ ./bin/my-executable

此方法将返回 ./bin。

has()

bool cv::CommandLineParser::has

(

const String &

name

)

const

检查字段是否在命令行中提供。

参数

name

要检查的参数名称

示例

fld_lines.cpp, samples/dnn/classification.cpp, and samples/tapi/hog.cpp.

operator=()

CommandLineParser & cv::CommandLineParser::operator=

(

const CommandLineParser &

parser

)

赋值运算符。

printErrors()

void cv::CommandLineParser::printErrors

(

)

const

打印发生的错误列表。

另请参阅

check

示例

samples/dnn/classification.cpp.

printMessage()

void cv::CommandLineParser::printMessage

(

)

const

打印帮助信息。

此方法将打印标准的帮助消息，包括关于消息和参数描述。

另请参阅

about

示例

fld_lines.cpp, samples/cpp/lsd_lines.cpp, samples/cpp/polar_transforms.cpp, samples/cpp/tutorial_code/ImgTrans/Sobel_Demo.cpp, and samples/dnn/classification.cpp.

成员数据文档

impl

Impl* cv::CommandLineParser::impl

保护

---

该类的文档由以下文件生成：

• opencv2/core/utility.hpp