OpenCV FileStorage类的数据读写操作

灰太狼 2022-06-03 01:36 228阅读 0赞

**OpenCV FileStorage类的数据读写操作**

OpenCV的许多应用都需要使用数据的存储于读取，例如经过3D校准后的相机，需要存储校准结果矩阵，以方便下次调用该数据；基于机器学习的应用，同样需要将学习得到的参数保存等。OpenCV通过XML/YAML格式实现数据持久化。本文简要梳理了使用FileStorage类进行基本数据持久化操作，给出了示例代码。

主要内容包括：

#### FileStorage类 ####

*  构造函数
 *  operator <<
 *  FileStorage::open
 *  FileStorage::isOpened
 *  FileStorage::release
 *  FileStorage::getFirstTopLevelNode
 *  FileStorage::root
 *  FileStorage::operator\[\]

#### 示例代码 ####

*  创建写入器、创建读取器
 *  写入数值、写入矩阵、写入自定义数据结构、写入当前时间
 *  读取数值、读取矩阵、读取自定义数据结构、读取当前时间
 *  关闭写入器、关闭读取器

## FileStorage类 ##

FileStorage类将各种OpenCV数据结构的数据存储为XML 或 YAML格式。同时，也可以将其他类型的数值数据存储为这两种格式。

### 构造函数 ###

FileStorage类的构造函数为：

\[cpp\]  [view plain][]  [copy][view plain]

1.  cv::FileStorage(const string& source, int flags， const string& encoding=string());

**参数：**

> source –存储或读取数据的文件名（字符串），其扩展名(.xml 或 .yml/.yaml)决定文件格式。
> 
> flags – 操作模式，包括：
> 
>  *  FileStorage::READ 打开文件进行读操作
>  *  FileStorage::WRITE 打开文件进行写操作
>  *  FileStorage::APPEND打开文件进行附加操作
>  *  FileStorage::MEMORY 从source读数据，或向内部缓存写入数据（由FileStorage::release返回）
> 
> encoding – 文件编码方式。目前不支持UTF-16 XML 编码，应使用 8-bit 编码。

### 写数据operator << ###

向filestorage中写入数据

\[cpp\]  [view plain][]  [copy][view plain]

1.  template<typename\_Tp> FileStorage& operator<<(FileStorage& fs, const \_Tp& value)  
2.  template<typename\_Tp> FileStorage& operator<<(FileStorage& fs, const vector<\_Tp>& vec)

**参数：**

> fs – 已经打开的用于写数据的file storage对象
> 
> value – 待写入fs 的数据.
> 
> vec – 待写入fs 的向量值

以下代码分别演示写入数值、矩阵、多个变量、当前时间和关闭文件：

\[cpp\]  [view plain][]  [copy][view plain]

1.  // 1.create our writter  
2.      cv::FileStorage fs("test.yml", FileStorage::WRITE);  
3.        
4.      // 2.Save an int  
5.      int imageWidth= 5;  
6.      int imageHeight= 10;  
7.      fs << "imageWidth" << imageWidth;  
8.      fs << "imageHeight" << imageHeight;  
9.    
10.     // 3.Write a Mat  
11.     cv::Mat m1= Mat::eye(3,3, CV\_8U);  
12.     cv::Mat m2= Mat::ones(3,3, CV\_8U);  
13.     cv::Mat resultMat= (m1+1).mul(m1+2);  
14.     fs << "resultMat" << resultMat;  
15.   
16.     // 4.Write multi-variables   
17.     cv::Mat cameraMatrix = (Mat\_<double>(3,3) << 1000, 0, 320, 0, 1000, 240, 0, 0, 1);  
18.     cv::Mat distCoeffs = (Mat\_<double>(5,1) << 0.1, 0.01, -0.001, 0, 0);  
19.     fs << "cameraMatrix" << cameraMatrix << "distCoeffs" << distCoeffs;  
20.   
21.     // 5.Save local time  
22.     time\_t rawtime; time(&rawtime); //\#include <time.h>  
23.     fs << "calibrationDate" << asctime(localtime(&rawtime));  
24.   
25.     // 6.close the file opened  
26.     fs.release();

生成的文件test.yml

![20160507194156530][]

###     ###

### FileStorage::open ###

打开一个文件

\[cpp\]  [view plain][]  [copy][view plain]

1.  boolFileStorage::open(const string& filename, int flags, const string&encoding=string())

参数：

> filename – 待打开的文件名，其扩展名(.xml 或 .yml/.yaml) 决定文件格式(XML 或 YAML)
> 
> flags – 操作模式。见构造函数
> 
> encoding – 文件编码方式。

\[cpp\]  [view plain][]  [copy][view plain]

1.  // open a file  
2.      cv::FileStorage fs;  
3.      fs.open("test.yml",FileStorage::WRITE);  
4.  // ... some process here  
5.      fs.release();

###     ###

### FileStorage::isOpened ###

检查文件是否已经打开，调用：

\[cpp\]  [view plain][]  [copy][view plain]

1.  boolFileStorage::isOpened()

**返回:**

> ture – 如果对象关联了当前文件；
> 
> false – 其他情况。

尝试打开文件后调用此方法是个比较好的做法。

\[cpp\]  [view plain][]  [copy][view plain]

1.  // Checks whether the file is opened  
2.      cv::FileStorage fs;  
3.      fs.open("test.yml",FileStorage::WRITE);  
4.    
5.      bool flag = fs.isOpened();  
6.      cout<<"flag = "<<flag<<endl<<endl;  
7.  // if failed to open a file  
8.      if(!fs.isOpened())\{  
9.          cout<<"failed to open file test.yml "<<endl<<endl;  
10.         return 1;  
11.     \}

运行结果：

![20160507194343593][]

### FileStorage::release ###

存储或读取操作完成后，需要关闭文件并释放缓存，调用

\[cpp\]  [view plain][]  [copy][view plain]

1.  void FileStorage::release()

\[cpp\]  [view plain][]  [copy][view plain]

1.  cv::FileStorage fs("test.yml", fs::WRITE);  
2.  //... some processing here  
3.  fs.release();

### FileStorage::getFirstTopLevelNode ###

返回映射(mapping)顶层的第一个元素：

\[cpp\]  [view plain][]  [copy][view plain]

1.  FileStorage::getFirstTopLevelNode()

\[cpp\]  [view plain][]  [copy][view plain]

1.  // open a file for reading  
2.      fs.open("test.yml", FileStorage::READ);  
3.  // get the first top level node  
4.      int firstNode = fs.getFirstTopLevelNode();  
5.      cout<<"the First Top Level Node = "<<firstNode<<endl<<endl;

运行结果

![20160507194518001][]

### FileStorage::root ###

返回顶层映射(mapping)

\[cpp\]  [view plain][]  [copy][view plain]

1.  FileNode FileStorage::root(int streamidx=0)

参数：

> streamidx – 从0开始的字符串索引。大部分情况文件中只有一个串，但YAML支持多个串，因此可以有多个。
> 
> Returns: 顶层映射

### 读数据：FileStorage::operator\[\] ###

返回指定的顶层映射元素

\[cpp\]  [view plain][]  [copy][view plain]

1.  FileNode FileStorage::operator\[\](const string& nodename) const  
2.  FileNode FileStorage::operator\[\](const char\* nodename) const

参数：

nodename – 文件节点名（见下文FileNode类）

返回：名称为nodename的节点数据

\[cpp\]  [view plain][]  [copy][view plain]

1.  // read data using operator \[\]  
2.      cv::FileStorage fs("test.yml", FileStorage::READ);  
3.      int width;  
4.      int height;  
5.      fs\["imageWidth"\]>>width;  
6.      fs\["imageHeight"\]>>height;  
7.      cout<<"width readed = "<<width<<endl;  
8.      cout<<"height readed = "<<height<<endl<<endl;  
9.    
10. // read Mat  
11.     cv::Mat resultMatRead;  
12.     fs\["resultMat"\]>>resultMatRead;  
13.     cout<<"resultMat readed = "<<resultMatRead<<endl<<endl;  
14.       
15.     cv::Mat cameraMatrixRead,distCoeffsRead;  
16.     fs\["cameraMatrix"\]>>cameraMatrixRead;  
17.     fs\["distCoeffs"\]>>distCoeffsRead;  
18.     cout<<"cameraMatrix readed = "<<cameraMatrixRead<<endl;  
19.     cout<<"distCoeffs readed = "<<distCoeffsRead<<endl<<endl;  
20.   
21. // read string  
22.     string timeRead;  
23.     fs\["calibrationDate"\]>>timeRead;  
24.     cout<<"calibrationDate readed = "<<timeRead<<endl<<endl;  
25.   
26.     fs.release();

运行结果

![20160607153626801][]

转载请注明出处（本文更新链接）：[http://blog.csdn.net/iracer/article/details/51339377][http_blog.csdn.net_iracer_article_details_51339377]

[view plain]: http://blog.csdn.net/iracer/article/details/51339377#
[20160507194156530]: /images/20220603/a72d848efa284d3c9e2dee5a98a52c41.png
[20160507194343593]: /images/20220603/9342863f992740b08f5ec4c0ced8e461.png
[20160507194518001]: /images/20220603/b0da2b79bbce4f5ab9a399bf94a002c5.png
[20160607153626801]: /images/20220603/221c66c7b058485d962124b2324953b5.png
[http_blog.csdn.net_iracer_article_details_51339377]: http://blog.csdn.net/iracer/article/details/51339377