目標

你將找到以下問題的答案

如何使用 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] << " shows the usage of the OpenCV serialization functionality." << endl << endl
<< "usage: " << endl
<< av[0] << " [output file name] (default outputfile.yml.gz)" << endl << endl
<< "The output file may be XML (xml), YAML (yml/yaml), or JSON (json)." << endl
<< "You can even compress it by specifying this in its extension like xml.gz yaml.gz etc... " << endl
<< "With FileStorage you can serialize objects in OpenCV by using the << and >> operators" << endl
<< "For example: - create a class and have it serialized" << endl
<< " - use it to read and write matrices." << endl << 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
    {}
    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"];
    }
public: // Data Members
    int A;
    double X;
    string id;
};
 
//These write and read functions must be defined for the serialization in FileStorage to work
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" << "["; // text - string sequence
fs << "image1.jpg" << "Awesomeness" << "../data/baboon.jpg";
fs << "]"; // close sequence
 
fs << "Mapping"; // text - mapping
fs << "{" << "One" << 1;
fs << "Two" << 2 << "}";
 
fs << "R" << R; // cv::Mat
fs << "T" << T;
 
fs << "MyData" << m; // your own data structures
 
fs.release(); // explicit close
cout << "Write operation to file:" << filename << " completed successfully." << endl;
    }
 
{//讀
cout << endl << "Reading: " << endl;
        FileStorage fs;
fs.open(filename, FileStorage::READ);
 
        int itNr;
        //fs["iterationNr"] >> itNr;
itNr = (int) fs["iterationNr"];
cout << itNr;
        if (!fs.isOpened())
        {
cerr << "Failed to open " << filename << endl;
help(av);
            return 1;
        }
 
        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;
 
 
n = fs["Mapping"]; // Read mappings from a sequence
cout << "Two " << (int)(n["Two"]) << "; ";
cout << "One " << (int)(n["One"]) << endl << endl;
 
 
MyData m;
        Mat R, T;
 
fs["R"] >> R; // Read cv::Mat
fs["T"] >> T;
fs["MyData"] >> m; // Read your own structure_
 
cout << endl
<< "R = " << R << endl;
cout << "T = " << T << endl << endl;
cout << "MyData = " << endl << m << endl << endl;
 
        //顯示不存在節點的預設行為
cout << "Attempt to read NonExisting (should initialize the data structure with its default).";
fs["NonExisting"] >> m;
cout << endl << "NonExisting = " << endl << m << endl;
    }
 
cout << endl
<< "Tip: Open up " << filename << " with a text editor to see the serialized data." << 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} shows the usage of the OpenCV serialization functionality. \n\n
usage:\n
python3 {0} [output file name] (default outputfile.yml.gz)\n\n
The output file may be XML (xml), YAML (yml/yaml), or JSON (json).\n
You can even compress it by specifying this in its extension like xml.gz yaml.gz etc...\n
With FileStorage you can serialize objects in OpenCV.\n\n
For example: - create a class and have it serialized\n
- use it to read and write matrices.\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]
 
    # write
    
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 ('Write operation to file:', filename, 'completed successfully.')
 
    # read
    print ('\nReading: ')
s = cv.FileStorage()
s.open(filename, cv.FileStorage_READ)
 
    
n = s.getNode('iterationNr')
itNr = int(n.real())
    
    print (itNr)
 
    if (not s.isOpened())
        print ('Failed to open ', filename, file=sys.stderr)
help(argv[0])
exit(1)
 
    
n = s.getNode('strings')
    if (not n.isSeq())
        print ('strings is not a sequence! FAIL', 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 ('Attempt to read NonExisting (should initialize the data structure',
            'with its default).')
m.read(s.getNode('NonExisting'))
    print ('\nNonExisting =','\n',m)
    
 
    print ('\nTip: Open up',filename,'with a text editor to see the serialized data.')
 
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(); // explicit close

Python

s.release()
文字和數字的輸入和輸出。 在 C++ 中，資料結構使用 STL 庫中的 << 輸出運算子。在 Python 中，則使用 cv::FileStorage::write()。要輸出任何型別的資料結構，我們首先需要指定其名稱。在 C++ 中，我們只需簡單地將名稱推送到流中即可。在 Python 中，寫入函式的第一個引數是名稱。對於基本型別，你可以接著列印值。
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; // Read 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" << "["; // text - string sequence

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

fs << "]"; // close sequence

Python

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

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

s.write('', elem)

s.endWriteStruct()

對於對映，操作相同，但現在我們使用“{”和“}”分隔符。

C++

fs << "Mapping"; // text - 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"]; // 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;

Python

n = s.getNode('strings')

if (not n.isSeq())

print ('strings is not a sequence! FAIL', file=sys.stderr)

exit(1)

for i in range(n.size())

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

對於對映，你可以再次使用 [] 運算子（Python 中的 at() 函式）來訪問給定項（或 >> 運算子）。

C++

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

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: // Data Members

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 //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"];

}

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; // your own data structures

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

Python

m = MyData()

m.write(s, 'MyData')

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

或者嘗試讀取一個不存在的資料。

C++

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

fs["NonExisting"] >> m;

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

Python

print ('Attempt to read NonExisting (should initialize the data structure',

'with its default).')

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

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

結果

我們主要只是打印出定義的數字。在你的控制檯螢幕上你可以看到：

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

你可以在此處在 YouTube 上觀看此內容的執行時例項。


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

目錄

目標

原始碼

解釋

結果