Browse Source

Update README

Frederik Filip Stæger 4 years ago
parent
commit
4d2ba25d6a
2 changed files with 9 additions and 8 deletions
  1. 9 8
      README.md
  2. 0 0
      preprocess.py

+ 9 - 8
README.md

@@ -1,7 +1,10 @@
+ # Description
+This repository contains the full data set for constructing the DAPI template, the full DAPI template creation pipeline and the automatic slice segmentation.
+ 
+# Automatic slice segmentation  
+
+Program for automatic segmentation to a DAPI-stained coronal mouse brain slices.
 
-#Automatic slice segmentation  
-  
-Program for automatically registering a segmentation to a DAPI-stained slice.  
   
 ## Dependencies  
 * Python 3.6  
@@ -33,8 +36,8 @@ python3 auto_seg.py sliceloc segloc templateloc --bregma [coord]
 
 **Optional arguments**
 
-|||
-|--------------------------------|-----------------------------|
+| | |
+|---|---|
 |`--approx [index]`            |Provide the location of the slice as a z-index of the template. Can be used instead of --bregma argument.|
 |`--out [directory]`            |Provide an alternative output directory (default directory is /output)            |
 |`--dapi [index]`   |Index of the DAPI channel in the slice, by default the DAPI channel is assumed to be the last channel|
@@ -42,7 +45,7 @@ python3 auto_seg.py sliceloc segloc templateloc --bregma [coord]
 ## preprocess.py  
 **Usage**
 ```sh  
-python3 preprocess.py file dir -s Series -b [True/False] --pdim [pixeldimension]  
+python3 preprocess.py file dir -s Series --pdim [pixeldimensions]  
 ```  
 **Positional/Required Arguments**
 
@@ -56,6 +59,4 @@ python3 preprocess.py file dir -s Series -b [True/False] --pdim [pixeldimension]
 
 |||
 |--------------------------------|-----------------------------|
-|`--b [True/False]`            |Bias field correction: Whether to use bias-field correction in preprocessing (default: True)|
 |`--pdim [pixeldimensions]`            |Dimensions of pixels, if not provided, these will be extracted from image metadata|
-

+ 0 - 0
preprocess.py