目标

您将找到以下问题的答案

如何使用YAML、XML或JSON文件在OpenCV中打印和读取文件中的文本条目？
如何对OpenCV数据结构执行相同的操作？
如何对自定义数据结构执行此操作？
如何使用OpenCV数据结构，例如cv::FileStorage、cv::FileNode或cv::FileNodeIterator。

源代码

您可以从此处下载，或在OpenCV源代码库的samples/cpp/tutorial_code/core/file_input_output/file_input_output.cpp中找到它。

这是一个示例代码，演示如何实现目标列表中列出的所有内容。

#include <opencv2/core.hpp>
#include <iostream>
#include <string>
 
using namespace cv;
using namespace std;
 
static void help(char** av)
{
cout << endl
<< av[0] << "演示OpenCV序列化功能的用法。" << endl << endl
<< "用法：" << endl
<< av[0] << " [输出文件名] (默认 outputfile.yml.gz)" << endl << endl
<< "输出文件可以是XML (xml)、YAML (yml/yaml)或JSON (json)。" << endl
<< "您甚至可以通过在其扩展名中指定来压缩它，例如xml.gz yaml.gz等… " << endl
<< "使用FileStorage，您可以通过使用<<和>>运算符来序列化OpenCV中的对象" << endl
<< "例如：- 创建一个类并将其序列化" << endl
<< " - 使用它来读取和写入矩阵。" << endl << endl;
}
 
class MyData
{
public:
MyData() : A(0), X(0), id()
    {}
    explicit MyData(int) : A(97), X(CV_PI), id("mydata1234") // explicit 用于避免隐式转换
    {}
    void write(FileStorage& fs) const // 为此类编写序列化
    {
fs << "{" << "A" << A << "X" << X << "id" << id << "}";
    }
    void read(const FileNode& node) // 读取此类的序列化
    {
A = (int)node["A"];
X = (double)node["X"];
        id = (string)node["id"];
    }
public: // 数据成员
    int A;
    double X;
    string id;
};
 
// 必须定义这些写入和读取函数才能使FileStorage中的序列化工作
static void write(FileStorage& fs, const std::string&, const MyData& x)
{
x.write(fs);
}
static void read(const FileNode& node, MyData& x, const MyData& default_value = MyData()){
    if(node.empty())
x = default_value;
    else
x.read(node);
}
 
// 此函数将自定义类打印到控制台
static ostream& operator<<(ostream& out, const MyData& m)
{
out << "{ id = " << m.id << ", ";
out << "X = " << m.X << ", ";
out << "A = " << m.A << "}";
    return out;
}
 
int main(int ac, char** av)
{
    string filename;
 
    if (ac != 2)
    {
help(av);
filename = "outputfile.yml.gz";
    }
    else
filename = av[1];
 
{ // 写入
        Mat R = Mat_<uchar>::eye(3, 3),
T = Mat_<double>::zeros(3, 1);
MyData m(1);
 
        FileStorage fs(filename, FileStorage::WRITE);
        // 或
        // FileStorage fs;
        // fs.open(filename, FileStorage::WRITE);
 
fs << "iterationNr" << 100;
fs << "strings" << "["; // 文本 - 字符串序列
fs << "image1.jpg" << "Awesomeness" << "../data/baboon.jpg";
fs << "]"; // 关闭序列
 
fs << "Mapping"; // 文本 - 映射
fs << "{" << "One" << 1;
fs << "Two" << 2 << "}";
 
fs << "R" << R; // cv::Mat
fs << "T" << T;
 
fs << "MyData" << m; // 自定义数据结构
 
fs.release(); // 显式关闭
cout << "写入文件操作:" << filename << "完成成功。" << endl;
    }
 
{//读取
cout << endl << "读取: " << endl;
        FileStorage fs;
fs.open(filename, FileStorage::READ);
 
        int itNr;
        //fs["iterationNr"] >> itNr;
itNr = (int) fs["iterationNr"];
cout << itNr;
        if (!fs.isOpened())
        {
cerr << "打开失败 " << filename << endl;
help(av);
            return 1;
        }
 
        FileNode n = fs["strings"]; // 读取字符串序列 - 获取节点
        if (n.type() != FileNode::SEQ)
        {
cerr << "strings 不是序列！失败" << endl;
            return 1;
        }
 
        FileNodeIterator it = n.begin(), it_end = n.end(); // 遍历节点
        for (; it != it_end; ++it)
cout << (string)*it << endl;
 
 
n = fs["Mapping"]; // 从序列中读取映射
cout << "Two " << (int)(n["Two"]) << "; ";
cout << "One " << (int)(n["One"]) << endl << endl;
 
 
MyData m;
        Mat R, T;
 
fs["R"] >> R; // 读取 cv::Mat
fs["T"] >> T;
fs["MyData"] >> m; // 读取自定义结构
 
cout << endl
<< "R = " << R << endl;
cout << "T = " << T << endl << endl;
cout << "MyData = " << endl << m << endl << endl;
 
        //显示不存在节点的默认行为
cout << "尝试读取 NonExisting（应该使用其默认值初始化数据结构）。";
fs["NonExisting"] >> m;
cout << endl << "NonExisting = " << endl << m << endl;
    }
 
cout << endl
<< "提示：使用文本编辑器打开 " << filename << " 查看序列化数据。" << endl;
 
    return 0;
}

您可以从此处下载，或在 OpenCV 源代码库的samples/python/tutorial_code/core/file_input_output/file_input_output.py中找到它。

这是一个示例代码，演示如何实现目标列表中列出的所有内容。

from __future__ import print_function
 
import numpy as np
import cv2 as cv
import sys
 
def help(filename)
    print (
        '''
{0} 演示了 OpenCV 序列化功能的用法。\n\n
用法：\n
python3 {0} [输出文件名] (默认 outputfile.yml.gz)\n\n
输出文件可以是 XML (xml)、YAML (yml/yaml) 或 JSON (json)。\n
您甚至可以通过在其扩展名中指定来压缩它，例如 xml.gz yaml.gz 等…\n
使用 FileStorage，您可以序列化 OpenCV 中的对象。\n\n
例如：- 创建一个类并将其序列化\n
- 使用它来读取和写入矩阵。\n
 '''.format(filename)
    )
 
class MyData
A = 97
X = np.pi
name = 'mydata1234'
 
    def __repr__(self)
s = '{ name = ' + self.name + ', X = ' + str(self.X)
s = s + ', A = ' + str(self.A) + '}'
        return s
 
    
    def write(self, fs, name)
fs.startWriteStruct(name, cv.FileNode_MAP|cv.FileNode_FLOW)
fs.write('A', self.A)
fs.write('X', self.X)
fs.write('name', self.name)
fs.endWriteStruct()
 
    def read(self, node)
        if (not node.empty())
self.A = int(node.getNode('A').real())
self.X = node.getNode('X').real()
self.name = node.getNode('name').string()
        else:
self.A = self.X = 0
self.name = ''
    
 
def main(argv)
    if len(argv) != 2
help(argv[0])
filename = 'outputfile.yml.gz'
    else :
filename = argv[1]
 
    # 写入
    
R = np.eye(3,3)
T = np.zeros((3,1))
    
m = MyData()
    
 
    
s = cv.FileStorage(filename, cv.FileStorage_WRITE)
    # 或者
    # s = cv.FileStorage()
    # s.open(filename, cv.FileStorage_WRITE)
    
 
    
s.write('iterationNr', 100)
    
 
    
s.startWriteStruct('strings', cv.FileNode_SEQ)
    for elem in ['image1.jpg', 'Awesomeness', '../data/baboon.jpg']
s.write('', elem)
s.endWriteStruct()
    
 
    
s.startWriteStruct('Mapping', cv.FileNode_MAP)
s.write('One', 1)
s.write('Two', 2)
s.endWriteStruct()
    
 
    
s.write('R_MAT', R)
s.write('T_MAT', T)
    
 
    
m.write(s, 'MyData')
    
s.release()
    
    print ('写入文件操作:', filename, '完成成功。')
 
    # 读取
    print ('\n读取: ')
s = cv.FileStorage()
s.open(filename, cv.FileStorage_READ)
 
    
n = s.getNode('iterationNr')
itNr = int(n.real())
    
    print (itNr)
 
    if (not s.isOpened())
        print ('打开失败 ', filename, file=sys.stderr)
help(argv[0])
exit(1)
 
    
n = s.getNode('strings')
    if (not n.isSeq())
        print ('strings 不是序列！失败', file=sys.stderr)
exit(1)
 
    for i in range(n.size())
        print (n.at(i).string())
    
 
    
n = s.getNode('Mapping')
    print ('Two',int(n.getNode('Two').real()),'; ')
    print ('One',int(n.getNode('One').real()),'\n')
    
 
    
R = s.getNode('R_MAT').mat()
T = s.getNode('T_MAT').mat()
    
m.read(s.getNode('MyData'))
    
 
    print ('\nR =',R)
    print ('T =',T,'\n')
    print ('MyData =','\n',m,'\n')
 
    
    print ('尝试读取NonExisting（应该用默认值初始化数据结构）',
            '。'))
m.read(s.getNode('NonExisting'))
    print ('\nNonExisting =','\n',m)
    
 
    print ('\n提示：用文本编辑器打开',filename,'查看序列化数据。')
 
if __name__ == '__main__'
    main(sys.argv)

解释

这里我们只讨论XML、YAML和JSON文件输入。你的输出文件（及其对应的输入文件）可能只有一个这些扩展名，结构也由此而来。你可以序列化两种数据结构：映射（例如STL map和Python字典）和元素序列（例如STL vector）。它们的区别在于，在映射中，每个元素都有一个唯一的名称，你可以通过该名称访问它。对于序列，你需要遍历它们来查询特定项目。

XML/YAML/JSON 文件打开和关闭。在向此类文件写入任何内容之前，你需要打开它，并在最后关闭它。OpenCV 中的 XML/YAML/JSON 数据结构是 cv::FileStorage 。要指定此结构绑定到硬盘上的哪个文件，可以使用它的构造函数或此结构的 open() 函数。

C++

FileStorage fs(filename, FileStorage::WRITE);

// 或

// FileStorage fs;

// fs.open(filename, FileStorage::WRITE);

Python

s = cv.FileStorage(filename, cv.FileStorage_WRITE)

# 或者

# s = cv.FileStorage()

# s.open(filename, cv.FileStorage_WRITE)

无论你使用哪一个，第二个参数都是一个常量，指定你能够对其执行的操作类型：WRITE、READ 或 APPEND。文件名中指定的扩展名也决定了将使用的输出格式。如果指定了诸如 .xml.gz 之类的扩展名，则输出甚至可以被压缩。

当 cv::FileStorage 对象被销毁时，文件会自动关闭。但是，你可以使用 release 函数显式调用此函数。

C++

fs.release(); // 显式关闭

Python

s.release()
文本和数字的输入和输出。在 C++ 中，数据结构使用 STL 库中的 << 输出运算符。在 Python 中，使用 cv::FileStorage::write() 。为了输出任何类型的数据结构，我们首先需要指定它的名称。在 C++ 中，我们只需将它的名称推送到流中即可。在 Python 中，write 函数的第一个参数是名称。对于基本类型，你可以跟上值的打印。
C++

fs << "iterationNr" << 100;

Python

s.write('iterationNr', 100)

读取是一个简单的寻址（通过 [] 运算符）和强制转换操作，或者通过 >> 运算符读取。在 Python 中，我们使用 getNode() 寻址并使用 real()。
C++

int itNr;

//fs["iterationNr"] >> itNr;

itNr = (int) fs["iterationNr"];

Python

int itNr;

//fs["iterationNr"] >> itNr;

itNr = (int) fs["iterationNr"];
OpenCV 数据结构的输入/输出。它们的行为与基本的 C++ 和 Python 类型完全相同。
C++

Mat R = Mat_<uchar>::eye(3, 3),

T = Mat_<double>::zeros(3, 1);

fs << "R" << R; // cv::Mat

fs << "T" << T;

fs["R"] >> R; // 读取 cv::Mat

fs["T"] >> T;

Python

R = np.eye(3,3)

T = np.zeros((3,1))

s.write('R_MAT', R)

s.write('T_MAT', T)

R = s.getNode('R_MAT').mat()

T = s.getNode('T_MAT').mat()
向量（数组）和关联映射的输入/输出。如前所述，我们也可以输出映射和序列（数组、向量）。同样，我们首先打印变量的名称，然后必须指定我们的输出是序列还是映射。

对于序列，在第一个元素之前打印 "[" 字符，在最后一个元素之后打印 "]" 字符。在 Python 中，调用 FileStorage.startWriteStruct(structure_name, struct_type)，其中 struct_type 是 cv2.FileNode_MAP 或 cv2.FileNode_SEQ 以开始写入结构。调用 FileStorage.endWriteStruct() 来完成结构。

C++

fs << "strings" << "["; // 文本 - 字符串序列

fs << "image1.jpg" << "Awesomeness" << "../data/baboon.jpg";

fs << "]"; // 关闭序列

Python

s.startWriteStruct('strings', cv.FileNode_SEQ)

for elem in ['image1.jpg', 'Awesomeness', '../data/baboon.jpg']

s.write('', elem)

s.endWriteStruct()

对于映射，操作相同，但是现在我们使用 "{" 和 "}" 分隔符字符。

C++

fs << "Mapping"; // 文本 - 映射

fs << "{" << "One" << 1;

fs << "Two" << 2 << "}";

Python

s.startWriteStruct('Mapping', cv.FileNode_MAP)

s.write('One', 1)

s.write('Two', 2)

s.endWriteStruct()

要从中读取，我们使用 cv::FileNode 和 cv::FileNodeIterator 数据结构。cv::FileStorage 类的 [] 运算符（或 Python 中的 getNode() 函数）返回 cv::FileNode 数据类型。如果节点是连续的，我们可以使用 cv::FileNodeIterator 来迭代项目。在 Python 中，at() 函数可用于寻址序列的元素，size() 函数返回序列的长度。

C++

FileNode n = fs["strings"]; // 读取字符串序列 - 获取节点

if (n.type() != FileNode::SEQ)

{

cerr << "strings 不是序列！失败" << endl;

return 1;

}

FileNodeIterator it = n.begin(), it_end = n.end(); // 遍历节点

for (; it != it_end; ++it)

cout << (string)*it << endl;

Python

n = s.getNode('strings')

if (not n.isSeq())

print ('strings 不是序列！失败', file=sys.stderr)

exit(1)

for i in range(n.size())

print (n.at(i).string())

对于映射，你可以再次使用 [] 运算符（Python 中的 at() 函数）来访问给定项目（或者 >> 运算符）。

C++

n = fs["Mapping"]; // 从序列中读取映射

cout << "Two " << (int)(n["Two"]) << "; ";

cout << "One " << (int)(n["One"]) << endl << endl;

Python

n = s.getNode('Mapping')

print ('Two',int(n.getNode('Two').real()),'; ')

print ('One',int(n.getNode('One').real()),'\n')
读取和写入你自己的数据结构。假设你有一个这样的数据结构：

C++

class MyData

{

public:

MyData() : A(0), X(0), id() {}

public: // 数据成员

int A;

double X;

string id;

};

Python

class MyData

def __init__(self)

self.A = self.X = 0

self.name = ''

在 C++ 中，可以通过在类内和类外添加读取和写入函数，通过 OpenCV I/O XML/YAML 接口来序列化它（就像 OpenCV 数据结构的情况一样）。在 Python 中，你可以通过在类中实现读取和写入函数来实现这一点。对于内部部分

C++

void write(FileStorage& fs) const //为此类编写序列化

{

fs << "{" << "A" << A << "X" << X << "id" << id << "}";

}

void read(const FileNode& node) // 读取此类的序列化

{

A = (int)node["A"];

X = (double)node["X"];

id = (string)node["id"];

}

Python

def write(self, fs, name)

fs.startWriteStruct(name, cv.FileNode_MAP|cv.FileNode_FLOW)

fs.write('A', self.A)

fs.write('X', self.X)

fs.write('name', self.name)

fs.endWriteStruct()

def read(self, node)

if (not node.empty())

self.A = int(node.getNode('A').real())

self.X = node.getNode('X').real()

self.name = node.getNode('name').string()

else:

self.A = self.X = 0

self.name = ''

C++
在 C++ 中，你需要在类外部添加以下函数定义。
static void write(FileStorage& fs, const std::string&, const MyData& x)

{

x.write(fs);

}

static void read(const FileNode& node, MyData& x, const MyData& default_value = MyData()){

if(node.empty())

x = default_value;

else

x.read(node);

}

在这里你可以看到，在读取部分，我们定义了如果用户尝试读取不存在的节点会发生什么。在这种情况下，我们只返回默认初始化值，但是更详细的解决方案是例如返回对象的 ID 的负一值。

添加这四个函数后，使用 >> 运算符进行写入，使用 << 运算符进行读取（或者使用 Python 中定义的输入/输出函数）。

C++

MyData m(1);

fs << "MyData" << m; // 自定义数据结构

fs["MyData"] >> m; // 读取自定义结构

Python

m = MyData()

m.write(s, 'MyData')

m.read(s.getNode('MyData'))

或者尝试读取一个不存在的文件：

C++

cout << "尝试读取 NonExisting（应该使用其默认值初始化数据结构）。";

fs["NonExisting"] >> m;

cout << endl << "NonExisting = " << endl << m << endl;

Python

print ('尝试读取NonExisting（应该用默认值初始化数据结构）',

'。'))

m.read(s.getNode('NonExisting'))

print ('\nNonExisting =','\n',m)

结果

大部分情况下，我们只是打印出定义的数字。在您的控制台屏幕上，您将看到：

写入完成。
 
读取
100image1.jpg
Awesomeness
baboon.jpg
Two 2; One 1
 
 
R = [1, 0, 0;
  0, 1, 0;
  0, 0, 1]
T = [0; 0; 0]
 
MyData =
{ id = mydata1234, X = 3.14159, A = 97}
 
尝试读取 NonExisting（应该使用其默认值初始化数据结构）。
NonExisting =
{ id = , X = 0, A = 0}
 
提示：使用文本编辑器打开 output.xml 文件以查看序列化数据。

然而，output.xml 文件中的内容更有趣：

<?xml version="1.0"?>
<opencv_storage>
<iterationNr>100</iterationNr>
<strings>
  image1.jpg Awesomeness baboon.jpg</strings>
<Mapping>
<One>1</One>
<Two>2</Two></Mapping>
<R type_id="opencv-matrix">
<rows>3</rows>
<cols>3</cols>
<dt>u</dt>
<data>
1 0 0 0 1 0 0 0 1</data></R>
<T type_id="opencv-matrix">
<rows>3</rows>
<cols>1</cols>
<dt>d</dt>
<data>
0. 0. 0.</data></T>
<MyData>
<A>97</A>
<X>3.1415926535897931e+000</X>
<id>mydata1234</id></MyData>
</opencv_storage>

或者 YAML 文件：

%YAML:1.0
iterationNr: 100
strings
- "image1.jpg"
- Awesomeness
- "baboon.jpg"
Mapping
One: 1
Two: 2
R: !!opencv-matrix
rows: 3
cols: 3
dt: u
data: [ 1, 0, 0, 0, 1, 0, 0, 0, 1 ]
T: !!opencv-matrix
rows: 3
cols: 1
dt: d
data: [ 0., 0., 0. ]
MyData
A: 97
X: 3.1415926535897931e+000
id: mydata1234

您可以在这里观看 YouTube 视频，了解其运行时实例。


原作者	Bernát Gábor
兼容性	OpenCV >= 3.0

目录

目标

源代码

解释

结果