【opencv 450 core】 File Input and Output using XML and YAML files

OpenCV: File Input and Output using XML and YAML fileshttps://docs.opencv.org/4.5.5/dd/d74/tutorial_file_input_output_with_xml_yml.html

目标

您将找到以下问题的答案：

如何使用 YAML 或 XML 文件打印和读取文件和 OpenCV 的文本条目？

如何对 OpenCV 数据结构做同样的事情？

如何为您的数据结构执行此操作？

使用 OpenCV数据结构，例如 cv::FileStorage 、 cv::FileNode 或 cv::FileNodeIterator 。

#include <opencv2/core.hpp>
#include <iostream>
#include <string>

using namespace cv;
using namespace std;

static void help(char** av)
{
    cout << endl
        << av[0] << " 显示了 OpenCV 序列化功能的用法。shows the usage of the OpenCV serialization functionality."         << endl
        << "usage: "                                                                      << endl
        <<  av[0] << " outputfile.yml.gz"                                                 << endl
        << "The output file may be either XML (xml) or YAML (yml/yaml). You can even compress it by "
        << "specifying this in its extension like xml.gz yaml.gz etc... "                  << endl
		<<"输出文件可以是 XML (xml) 或 YAML (yml/yaml)。 您甚至可以通过在其扩展名中指定它来压缩它，例如 xml.gz yaml.gz 等..."<<endl
        << "使用 FileStorage，您可以使用 << 和 >> 运算符序列化 OpenCV 中的对象" << endl
        << "例如： - 创建一个类并对其进行序列化"                         << endl
        << "             - use it to read and write matrices.用它来读写矩阵。"                            << endl;
}

class MyData
{
public:
    MyData() : A(0), X(0), id()
    {}
    explicit MyData(int) : A(97), X(CV_PI), id("mydata1234") // 显式避免隐式转换 explicit to avoid implicit conversion
    {}
    //! [inside]
    void write(FileStorage& fs) const                        //为这个类写序列化Write serialization for this class
    {
        fs << "{" << "A" << A << "X" << X << "id" << id << "}";
    }
    void read(const FileNode& node)                          //读取此类的序列化Read serialization for this class
    {
        A = (int)node["A"];
        X = (double)node["X"];
        id = (string)node["id"];
    }
    //! [inside]
public:   // 数据成员
    int A;
    double X;
    string id;
};

//These write and read functions must be defined for the serialization in FileStorage to work
//必须定义这些写入和读取函数才能使 FileStorage 中的序列化工作
//! [outside]
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);
}
//! [outside]

// 这个函数会将我们的自定义类打印到控制台
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)
{
    if (ac != 2)
    {
        help(av);
        return 1;
    }

    string filename = av[1];
    { //write
        //! [iomati]
        Mat R = Mat_<uchar>::eye(3, 3),
            T = Mat_<double>::zeros(3, 1);
        //! [iomati]
        //! [customIOi]
        MyData m(1);
        //! [customIOi]

        //! [open]
        FileStorage fs(filename, FileStorage::WRITE);
        // or:
        // FileStorage fs;
        // fs.open(filename, FileStorage::WRITE);
        //! [open]

        //! [writeNum]
        fs << "iterationNr" << 100;
        //! [writeNum]
        //! [writeStr]
        fs << "strings" << "[";                              // 文本字符串序列（文本向量） text - string sequence
        fs << "image1.jpg" << "Awesomeness" << "../data/baboon.jpg";
        fs << "]";                                           // 关闭序列 close sequence
        //! [writeStr]

        //! [writeMap]
        fs << "Mapping";                              // 文本映射 （数据字典）text - mapping
        fs << "{" << "One" << 1;
        fs <<        "Two" << 2 << "}";
        //! [writeMap]

        //! [iomatw]
        fs << "R" << R;                                      // cv::Mat
        fs << "T" << T;
        //! [iomatw]

        //! [customIOw]
        fs << "MyData" << m;                                // your own data structures
        //! [customIOw]

        //! [close]
        fs.release();                                       // explicit close
        //! [close]
        cout << "Write Done." << endl;
    }

    {//read
        cout << endl << "Reading: " << endl;
        FileStorage fs;
        fs.open(filename, FileStorage::READ);

        //! [readNum]
        int itNr;
        //fs["iterationNr"] >> itNr;
        itNr = (int) fs["iterationNr"];
        //! [readNum]
        cout << itNr;
        if (!fs.isOpened())
        {
            cerr << "Failed to open " << filename << endl;
            help(av);
            return 1;
        }

        //! [readStr]
        FileNode n = fs["strings"];                         //读取字符串序列 Read string sequence - Get node
        if (n.type() != FileNode::SEQ)
        {
            cerr << "strings is not a sequence! FAIL" << endl;
            return 1;
        }

        FileNodeIterator it = n.begin(), it_end = n.end(); //遍历节点
        for (; it != it_end; ++it)
            cout << (string)*it << endl;//输出字符串序列
        //! [readStr]


        //! [readMap]
        n = fs["Mapping"];                                // 读取映射 Read mappings from a sequence
        cout << "Two  " << (int)(n["Two"]) << "; ";
        cout << "One  " << (int)(n["One"]) << endl << endl;
        //! [readMap]


        MyData m;
        Mat R, T;

        //! [iomat]
        fs["R"] >> R;                                      // Read cv::Mat
        fs["T"] >> T;
        //! [iomat]
        //! [customIO]
        fs["MyData"] >> m;                                 // Read your own structure_
        //! [customIO]

        cout << endl
            << "R = " << R << endl;
        cout << "T = " << T << endl << endl;
        cout << "MyData = " << endl << m << endl << endl;

        //显示非现有节点的默认行为Show default behavior for non existing nodes
        //! [nonexist]
        cout << "尝试读取 NonExisting（应使用默认值初始化数据结构）Attempt to read NonExisting (should initialize the data structure with its default).";
        fs["NonExisting"] >> m;
        cout << endl << "NonExisting = " << endl << m << endl;
        //! [nonexist]
    }

    cout << endl
        << "Tip: Open up " << filename << " with a text editor to see the serialized data." << endl;

    return 0;
}

Explanation

这里我们只讨论 XML 和 YAML 文件输入。 您的输出（及其各自的输入）文件可能只有其中一个扩展名和来自此的结构。 它们是您可以序列化的两种数据结构：mappings映射（如 STL 映射和 Python 字典）和element sequence元素序列（如 STL 向量）。 它们之间的区别在于，在map中，每个元素都有一个唯一的名称，您可以通过它访问它。 对于sequences序列，您需要通过它们来查询特定项目。

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

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

您使用的第二个参数中的任何一个都是一个常量，指定您可以对它们执行的操作类型：WRITE、READ 或 APPEND。 文件名中指定的扩展名也决定了将使用的输出格式。 如果您指定扩展名，例如 *.xml.gz*，甚至可以压缩输出。

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

fs.release(); // explicit close

2. 文本和数字的输入和输出。 在 C++ 中，数据结构使用 STL 库中的 << 输出运算符。 在 Python 中，使用 cv::FileStorage::write() 代替。 为了输出任何类型的数据结构，我们首先需要指定它的名称。 我们只需简单地将 this 的名称推送到 C++ 中的流中即可。 在 Python 中，write 函数的第一个参数是名称。 对于基本类型，您可以在后面打印 value ：

fs << "iterationNr" << 100;

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

int itNr;

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

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

3. OpenCV 数据结构的输入/输出。 好吧，它们的行为与基本的 C++ 和 Python 类型完全一样：

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

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

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

fs << "T" << T;

fs["R"] >> R; // Read cv::Mat

fs["T"] >> T;

4. 向量（数组）和associative maps关联映射的输入/输出。 正如我之前提到的，我们也可以输出映射和序列（数组、向量）。 同样，我们首先打印变量的名称，然后我们必须指定我们的输出是序列还是映射。

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

fs << "strings" << "["; // text - string sequence

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

fs << "]"; // close sequence

对于maps ，drill 是相同的，但是现在我们使用“{”和“}”分隔符：

fs << "Mapping"; // text - mapping

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

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

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

FileNode n = fs["strings"]; // Read string sequence - Get node

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

{

cerr << "strings is not a sequence! FAIL" << endl;

return 1;

}

FileNodeIterator it = n.begin(), it_end = n.end(); // Go through the node

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

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

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

n = fs["Mapping"]; // Read mappings from a sequence

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

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

5. 读写自定义的数据结构。 假设您有一个数据结构，例如：

class MyData

{

public:

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

public: // Data Members

int A;

double X;

string id;

};

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

void write(FileStorage& fs) const //Write serialization for this class

{

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

}

void read(const FileNode& node) //Read serialization for this class

{

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

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

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

}

在 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 定义的输入/输出函数）：

MyData m(1);

fs << "MyData" << m; // your own data structures

fs["MyData"] >> m; // Read your own structure_

或者尝试读取不存在的read：

cout << "Attempt to read NonExisting (should initialize the data structure with its default).";

fs["NonExisting"] >> m;

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

Result

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

Write Done.
Reading:
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}
Attempt to read NonExisting (should initialize the data structure with its default).
NonExisting =
{ id = , X = 0, A = 0}
Tip: Open up output.xml with a text editor to see the serialized data.

不过，您可能会在输出 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