|
a |
|
b/docs/Input files.rst |
|
|
1 |
.. _Input_page: |
|
|
2 |
|
|
|
3 |
*********** |
|
|
4 |
Input files |
|
|
5 |
*********** |
|
|
6 |
|
|
|
7 |
Whole Slide Image files |
|
|
8 |
======================= |
|
|
9 |
|
|
|
10 |
.. note:: |
|
|
11 |
An example Tissue Array is hosted |
|
|
12 |
`here <https://emckclac-my.sharepoint.com/:f:/g/personal/k1472221_kcl_ac_uk/EutLIT4yc3BIlmNdUnDzLNAB0AcR1qc99Pvf8w-yCcmj_A?e=LXunb4>`_. |
|
|
13 |
The file contains a previously analyzed cancer tissue array (Arthurs et al, Sci Rep 2020) and mock data file. |
|
|
14 |
|
|
|
15 |
Supported Formats |
|
|
16 |
----------------- |
|
|
17 |
|
|
|
18 |
The program now supports whole slide images in the following vendors: |
|
|
19 |
|
|
|
20 |
* Hamamatsu (.ndpi, .vms, .vmu) |
|
|
21 |
* Aperio (.svs, .tif) |
|
|
22 |
* Leica (.scn) |
|
|
23 |
* Philips (.tiff) |
|
|
24 |
* Sakura (.svslide) |
|
|
25 |
* Generic tiled TIFF (.tif) |
|
|
26 |
* MIRAX (.mrxs) |
|
|
27 |
* Trestle (.tif) |
|
|
28 |
* Ventana (.bif, .bif) |
|
|
29 |
|
|
|
30 |
An example image of a WSI .ndpi file with tissue cores stained with DAB is given below: |
|
|
31 |
|
|
|
32 |
.. image:: images/example_ndpi.png |
|
|
33 |
|
|
|
34 |
Each core in this example is 1mm in diameter (the core diameter or number of cores is not a limitation for QuArray application). Scale bar is 1mm. |
|
|
35 |
|
|
|
36 |
Tissue array map file |
|
|
37 |
===================== |
|
|
38 |
|
|
|
39 |
A spreadsheet (Excel *.xlsx) file acts as a map of the array. |
|
|
40 |
|
|
|
41 |
The spreadsheet can also contain indexed information that is used for downstream analysis such as sample ID, |
|
|
42 |
sample details (e.g. date of sample collection, type) and categories (e.g. normal or diseased). |
|
|
43 |
|
|
|
44 |
File locations |
|
|
45 |
============== |
|
|
46 |
|
|
|
47 |
If the WSI file and the tissue array map file are saved in the same directory with the same name |
|
|
48 |
then the array map will be loaded automatically when the WSI file is loaded. Otherwise, the user load the map file |
|
|
49 |
separately. |
|
|
50 |
|
|
|
51 |
Here is an example of a normal tree file structure containing the WSI file and the index file. |
|
|
52 |
|
|
|
53 |
.. code-block:: bash |
|
|
54 |
|
|
|
55 |
. |
|
|
56 |
├── WSI.ndpi |
|
|
57 |
└── WSI.xlsx |
|
|
58 |
|
|
|
59 |
When the images are exported a new directory will be created inside the root to host output files. |
|
|
60 |
|
|
|
61 |
User interface |
|
|
62 |
============== |
|
|
63 |
|
|
|
64 |
.. image:: images/Pathology_maps.png |
|
|
65 |
|
|
|
66 |
Left - Image of the first tab. |
|
|
67 |
|
|
|
68 |
Right - Image of the second tab. |
|
|
69 |
|
|
|
70 |
The first tab contains 1 where a core is present and 0 where there is no core. There should be nothing in the rest |
|
|
71 |
of the document. |
|
|
72 |
|
|
|
73 |
The second tab contains pathology info and is used to make a figure if needed. This is not necessary to run the |
|
|
74 |
program. The tab does not have to be named *Pathology* but should be in the second tab location. T and N stand for Tumour |
|
|
75 |
and Normal respectively. |