# 数据格式规范

**Repository Path**: ShanghaiTech-GuanLab/Data-format-specification

## Basic Information

- **Project Name**: 数据格式规范
- **Description**: 行为和钙数据的格式规范，供查阅
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-09-14
- **Last Updated**: 2022-02-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

本项目是供多个其它项目引用的数据格式规范，供人类查阅，主要为参考功能，不做实际计算。目前已归档的规范包括：
- BehF1.0：程序生成的单次会话实验记录表文件
- BehM1.0：用于记录行为实验的时序化事件
- BlinkM1.0：记录从视频中摄得的小鼠闭眼行为，拍摄后的ROI测量值
- CaDF2.0：该类型文件存储一只鼠的钙信号测量数据
- CaDM2.0：该格式在内存中存储多只鼠的钙信号数据
- Rdc2：本格式存储了一天内一只鼠一个细胞群体多个不同刺激Block的钙和标数据，包含处理前全长连续数据和经过ΔF/F₀处理、分Trial的数据
- Rdc3：本格式存储了一天内一只鼠一个细胞群体多个不同刺激Block的钙和标数据，包含处理前全长连续数据和经过ΔF/F₀处理、分Trial的数据
# GetSpecification
取得指定规范的结构化说明
输入参数：FormatName(1,1)string，规范名称
返回值：Specification(1,1)struct，规范明细结构体
# RegisterSpecification
注册新的规范
## 输入参数
Specification，新规范。可以是规范描述JSON文件路径，也可以是规范结构体。

Name，规范名称，必须是合法的文件名（不带扩展名）。如果Specification是文件路径，可以不指定本参数，以那个文件名作为规范名。
# ValidateObject
验证对象是否符合规范
## 输入参数
Object，要验证的对象

Specification，要验证的规范。可以是GetSpecification得到的规范结构体，也可以是已注册的规范名称。

ErrorWhenFail，验证失败是否直接抛出异常，而不再继续验证（也不会返回Report）
## 返回值
Report，验证报告。如果验证成功则为逻辑值true，如果失败则返回一个详细的结构体，描述验证错误发生在对象的位置。