Skip to content

Commit

Permalink
Update overview section
Browse files Browse the repository at this point in the history
  • Loading branch information
tritemio committed Feb 26, 2015
1 parent 1d3cda5 commit 3312092
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 10 deletions.
6 changes: 3 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ Photon-HDF5 file format documentation

:Authors: Antonino Ingargiola, Xavier Michalet, Ted Laurence
:Contact: tritemio@gmail.com
:Version: 0.2
:Version: 0.3

.. note ::
This document describes the version "0.2-Draft" of the
This document describes the version "0.3" of the
**Photon-HDF5 file format**. The latest version of this document
can be found at
`http://photon-hdf5.readthedocs.org <http://photon-hdf5.readthedocs.org>`__.
`http://photon-hdf5.readthedocs.org <http://photon-hdf5.readthedocs.org/en/version0.3/>`__.
Photon-HDF5 is a file format for a class of single-molecule spectroscopy
experiments that requires storing photon stream data.
Expand Down
25 changes: 18 additions & 7 deletions docs/phdata.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,25 @@ An overview of the data format is shown in the following figure:

A Photon-HDF5 is a standard HDF5 file with a predefined structure.

Every Photon-HDF5 needs to have a ``photon_data`` group that
Every Photon-HDF5 file has a ``photon_data`` group that
contains the photon timestamps and other per-photon data.
In the most basic form ``photon_data`` contains only the per-photon data
(timestamps, detectors, nanotimes, etc...). However, in order to correctly
interpret the data, additional information is needed (for example
which detector is donor/acceptor in a 2-colors smFRET experiment, or the
alternation period in a us-ALEX experiment). These additional specifications,
if present, are contained inside **/photon_data** in the
**measuremet_specs** sub-group.

Other optional groups:
Other optional groups are:

- ``indentity``
- ``provenance``
- ``setup``
- ``sample``
- **/indentity**: information about the data file
- **/provenance**: information about the original data file
- **/setup**: fundamental parameters of the experimental setup
- **/sample**: sample information.

The following sections describe in details all the Photon-HDF5
groups and fields.

Root-level parameters
---------------------
Expand All @@ -44,7 +54,8 @@ Optional if there is only 1 detector:

- **detectors**

Optional:
In addition, when the dataset contain nanotime information, the following
fields must be present:

- **nanotimes**
- **nanotimes_specs/**
Expand Down

0 comments on commit 3312092

Please sign in to comment.