readme

c++编写的用于生物信号处理的软件库

Introduction:
---------------

The aim of this repository is providing a C/C++ software library for biomedical signal processing. 
This library is called "BioSig for C/C++" and is complementary to "BioSig for Octave and Matlab". 

BioSig4C++ provides several tools:  
(1) "libbiosig.a" provides a library for accessing different dataformats. 
Recommended: zlib http://zlib.net/
The supported data formats are listed here: 
http://hci.tugraz.at/schloegl/biosig/TESTED
(2) "save2gdf" is a converter between different file formats, 
including but not limited to SCP-ECG(EN1064), HL7aECG (FDA-XML), GDF, EDF, BDF, CWFB.
(3) "mexSLOAD.mex" is a MEX-interface for Octave and Matlab
Requirement: Matlab OR octave2.9, octave2.9-headers
Currently, it is tested with Octave only.  
(4) "_biosig.so" is an interface to python. 
Requirement: python2.4-dev, swig (http://www.swig.org/)
This part is also still experimental.  
(5) SigViewer 
Requirement: Qt4

The internal data structure resemble the header structure similar 
http://cvs.sourceforge.net/viewcvs.py/*checkout*/biosig/biosig/doc/header.txt
and is defined in
http://cvs.sourceforge.net/viewcvs.py/*checkout*/biosig/biosig4c%2B%2B/biosig.h
(see HDRTYPE and CHANNEL_TYPE)

Encoding of Event/Markers/Annotations is available here: 
http://hci.tugraz.at/schloegl/matlab/eeg/EventCodes.html

The latest list of supported data formats is available here: 
http://hci.tugraz.at/schloegl/biosig/TESTED


File(s): 
-------------
    README 	this file
    biosig.h	definition of external biosig interface	
    biosig-dev.h definition of internal functions	
    biosig.c	SOPEN, SREAD, SWRITE, SEOF, SCLOSE functions 
    save2gdf.c	converter between various file formats.
    mexSLOAD.cpp is a MEX-File for loading data in Octave and Matab. 
    t210/*	reading SCP file format 
    t220/*      writing SCP file format 
    t230/*      support of HL7aECG file format 
    test0/*	scripts and functions for testing
    Makefile	script for compiling and testing 
    

Compilation: 
-------------
# Linux 
you need g++, make and zlib. (If you do not have zlib, uncomment in biosig.h line 40 #include <zlib.h>).
Running make compiles the converter.
  make 		 	# makes the converter
  make save2gdf 	# makes the converter
  make libbiosig.a  	# makes a static library 
  make mex4o 		# makes mexSLOAD for Octave (requires Octave-headers2.9 or higher)
  make sigviewer 	# recompiles SigViewer	(requires Qt)
  make biosig4python 	# compiles the BioSig interface for Python (requires SWIG and Python 2.4)
  make all  		# all of the above
  make mex4m 		# makes mexSLOAD for Matlab (not supported yet)
  make testscp 
  make testhl7	
  make test		# tests HL7<->SCP, SCP<->GDF, GDF<->HL7 converters
  make test6		# tests bidirectional conversion between 6 differerent data formats	

# Cygwin
install g++, zlib, and make and compile it. 

# The mex interface has not been tested with Matlab, yet. 

# Other platforms (Windows, MGwin, MacOSX, Solaris, etc. )
Not tested (yet). Let me know about successful compilations, 
or tell me what changes are needed.   


Execution:
----------
# if test.gdf exists, some header information is displayed
./savegdf test.gdf     		

# help and usage information 
./save2gdf -h

# converts a data file into a GDF format (destination
./save2gdf PFE103.scp t5.gdf     		

# converts a data file into a SCP format (destination
./save2scp t5.gdf t5.scp      		
./save2gdf -f=SCP t5.gdf t5.scp      		

# converts a data file into a HL7aECG format (destination
./save2aecg t5.gdf t5.hl7      		
./save2gdf -f=HL7aECG t5.gdf t5.hl7


Open Issue(s) of the SCP-ECG <-> HL7aECG converter:
---------------------------------------------------
The following fields of SCP-ECG are not converted to HL7. 
= Mandatory fields (prEN1064:2007 p.18, chp 5.4.3.1) not propagated to HL7:  
- time zone information, (tag34, section 1)
- "ID of acquiring device" (tag14, section 1)
= "Highly recommended" fields (prEN1064:2007 p.18, chp 5.4.3.1) not propagated to HL7:  
- "ID of analysing device", Patient first name, 
= Other fields of the SCP-ECG standard, 
- section 1: blood pressure, medication, etc
- section 4 (QRS location), 7 (global measurements), 8-11 (interpretative statements)
The following fields of HL7aECG are not converted to SCP-ECG.
- study, treatment group, clinical trial, clinical trial protocol, trial sponsor, investigator etc. 


Development & Testing:
----------------------
There are several testing functions included. 
The following commands test the converter and should finish without errors.  
	make test 
	make testhl7
	make testscp
	make test6

The Octave/Matlab script 
	test0/test01.m 
tests whether the various data formats give the same results 
or whether some conversion error has been included.  




More information is available at http://biosig.sf.net/

If you have any questions you can also contact the newsgroup 
news://tu-graz.biosig on the server news.tu-graz.ac.at. 
The archive is available at 
http://newsarchiv.tugraz.at/browse/tu-graz.biosig/ 


    $Id: README,v 1.14 2008/03/17 10:03:25 schloegl Exp $
    Copyright (C) 2005,2006,2007,2008 Alois Schloegl <[e-mail]>
    This function is part of the "BioSig for C/C++" repository 
    (BioSig4C++) at http://biosig.sf.net/