-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
aeacc27
commit 76b3230
Showing
4 changed files
with
51 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
This section contains documentation about the individual modules of depiction. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
The persistence module contains functionality to read and write mass spectrometry imaging (MSI) data from and to the file system. | ||
To keep the rest of depiction as agnostic of the representation as possible, an abstraction is introduced that allows changing the underlying storage without affecting the rest of the code. | ||
In particular, we can parallelize code with the `parallelization` module and use RAM based storage when needed. | ||
|
||
## General abstraction | ||
|
||
### Reading data | ||
|
||
We have a `GenericReadFile` protocol, which encodes a container file handle, from which we can obtain `GenericReader` instances, | ||
which perform the actual reading of the data. | ||
|
||
In general the idea is that creating the file should be quick, whereas additional parsing might be necessary to create the reader instance. | ||
|
||
::: depiction.persistence.types.GenericReadFile | ||
options: | ||
annotations_path: source | ||
show_category_heading: yes | ||
show_root_heading: yes | ||
show_symbol_type_heading: yes | ||
show_source: no | ||
members_order: alphabetical | ||
heading_level: 4 | ||
|
||
::: depiction.persistence.types.GenericReader | ||
|
||
## ImzML | ||
|
||
Our ImzML functionality, essentially wraps pyImzML. | ||
|
||
## Ram |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,4 @@ | ||
site_name: depiction docs | ||
nav: | ||
- index.md | ||
theme: | ||
name: material | ||
features: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters