Polyman Report Generator
Polyman Report Generator allows creation of sleep reports using standard EDF+ annotation files. The tool was originally created by Marco Roessen and Bob Kemp, and since 2014 the program is further developed by Diego Alvarez-Estevez.
Polyman's sleep report generating capabilities are made available as a separate software piece within this project. This allows the possibility of interacting with the report generator from any programming language, script, or even a system console. Added possibilities include the batch processing of EDF+ files and the possibility to export to several formats including XML, PDF or PNG.
EDF and EDF+ files are commonly used in EEG and Sleep investigations, but can be used for almost any (also non-medical) sequential time series and event lists. The specifications of the EDF/EDF+ file formats are on www.edfplus.info and also in the following articles:
- Kemp B, Värri A, Rosa AC, Nielsen KD, Gade J. A simple format for exchange of digitized polygraphic recordings. Electroenceph. Clin. Neurophysiol. 82, 1992:391-393.
- Kemp B, Olivan J. European data format 'plus' (EDF+), an EDF alike standard format for the exchange of physiological data. Clinical Neurophysiology 114, 2003: 1755-1761.
We are relatively good at EDF/EDF+ and Sleep scoring, but we make mistakes. Polyman and Polyman Report are complicated software that inevitably contain mis-interpretations, mistakes, and bugs. We cannot and do not accept any liability for damages related to the use of Polyman Report. We sincerely urge you to regularly check all results obtained with Polyman Report. We can not guarantee the safety and integrity of your data. It is not our intention that you use Polyman Report for medical diagnosis or therapy and it has no CE certification. That said, we are using Polyman Report for thousands of sleep recordings each year in our own Sleep Centre, so we think that Polyman Report is safe and efficient.
Polyman Report was tested on Win98/2000/XP/NT/Vista/7-10.
This information addresses the situation as of February 2017.
Polyman Report is freely distributed, however it is not open source.
A major reason to develop and freely distribute Polyman Report, is that we want to promote the use of EDF+. Because EDF+ exists, Sleep and EEG labs can contribute to multi-center research projects, archive and retrieve their recordings and scorings indefinitely, and be free from vendor-lock.
EDF+ is the only data format for Sleep and EEG investigations that is accepted by most companies and researchers. But because of commercial reasons some companies prefer their own, proprietary, format. And for scientific or personal reasons, some researchers want to promote their own personal data format. Those companies and researchers would modify Polyman Report in such a way that it also reads their data format. In this way, Polyman Report would no longer promote the use of EDF+ and the Sleep and EEG community would risk a standards war.
Therefore, Polyman Report is not yet open-source. We try to keep it so attractive (and affordable) that more researchers and labs will want to use it and thus strive for EDF+ compatibility. Polyman Report then helps them to check EDF+ compatiblity of their recordings and scorings.
Last version of Polyman Report Generator can be downloaded here (last update 28-07-2017)
HOW-TO use Polyman Report Generator
After download and uncompressing the file, Polyman Report Generator is made available through an .exe application which can be interacted (on Windows' compatible systems) from any programming or scriping language, or directly by using a system console.
For a quick start, you can just execute the demo files included within the package. Try to open and/or execute the two demo scripts included ("ExecuteDemo_Batch.bat" and "ExecuteDemo_Interactive.bat") from a command shell, or just by double clicking them using a windows explorer.
The full usage syntax is described next (note parameters between brackets are optional):
- PolymanReport.exe "EDFplusAnnotationsFile.edf" "ReportTemplateFile.fr3" [/xml[:"xml_output_file.xml"]] [/png[:"png_output_file"]] [/pdf[:"pdf_output_file]] [/interactive] [/compact]
- EDFplusAnnotationsFile.edf is the path to the location of the source EDF+ annotations file containing the results scorings
- ReportTemplateFile.fr3 is the path to a report template definning the layout and the contents of the resulting sleep report (Fast Report format)
- The /xml /png and /pdf flags are optional and, if present, can be followed by the path to an output file that will be created in the corresponding chosen format. If the name of the output file is omitted then the output file will be named equal as to the input source file, just setting the extension as it corresponds. The /xml option is overall interesting to allow parsing of the different report indices, for example, for scientific purposes
- The /interactive flag is optional (default is missing to allow batch processing) and if active, it activates user interaction through a dedicated GUI allowing configuration of extra options or editing the contents of the report
- The /compact is optional (default is missing) which will force the resulting report to try to compact the contained information to reduce the overall length
Configuration of the report templates
Within the packaged version of the tool a pre-built report template is included which implements the last guidelines of the World Association of Sleep Medicine (WASM) for the scoring of Periodic Leg Movements (PLM).
In addition, however, one can just create its own report template, or editing one of the pre-loaded defaults, by using the GUI provided with the tool, or any other Fast Report compatible editing tool.
Creating or editing a report with Polyman Report Generator can be done using the /interactive initialization flag, and clicking respectively on the 'New...' or 'Edit' buttons:
An user manual to create and edit Fast Report templates is included within the contents of the download.