Skip to content
This repository has been archived by the owner on Feb 9, 2024. It is now read-only.

Commit

Permalink
Merge pull request #15 from tinalasisi/updates
Browse files Browse the repository at this point in the history
Updates to section function
  • Loading branch information
tinalasisi authored Nov 4, 2020
2 parents 0587ce1 + 961e2c7 commit edb1181
Show file tree
Hide file tree
Showing 4 changed files with 244 additions and 146 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,19 +80,24 @@ To run the demo, you will input something like:
### Curvature
To calculate curvature from grayscale TIFF images of hair fibers, the flag `--curvature` is used with the following flags in addition to input and output directories:
```
--resolution_mm Integer. Number of pixels per mm for curvature analysis.
--resolution_mm Integer. Number of pixels per mm for
curvature analysis.
Default is 132.
--window_size [ ...] Float or integer or None. Desired size for window of measurement
--window_size [ ...] Float or integer or None. Desired size for
window of measurement
for curvature analysis in pixels or mm (given
the flag --window_unit). If nothing is entered, the default
is None and the entire hair will be used to for the curve fitting."
--window_unit {px,mm} String. Unit of measurement for window of measurement for curvature
--window_unit {px,mm} String. Unit of measurement for window of
measurement for curvature
analysis. Can be 'px' (pixels) or 'mm'. Default is 'px'.
-s, --save_image Default is False. Will save intermediate curvature processing images if
--save_image flag is included.
-W, --within_element Boolean. Default is False. Will create an additional directory with
-W, --within_element Boolean. Default is False. Will create
an additional directory with
spreadsheets of raw curvature measurements for each hair if the
--within_element flag is included.
-s, --save_image Default is False. Will save intermediate
curvature/section processing images if
--save_image flag is included.
```

Expand All @@ -112,7 +117,7 @@ To calculate cross-sectional properties from grayscale TIFF images of hair fiber

An example command would be:
```
fibermorph --section --input_directory /Users/<UserName>/<ImageFolderPath> --output_directory /Users/<UserName>/<ExistingPath>/ --minsize 30 --maxsize 180 --resolution_mu 4.25 --jobs 2
fibermorph --section --input_directory /Users/<UserName>/<ImageFolderPath> --output_directory /Users/<UserName>/<ExistingPath>/ --minsize 20 --maxsize 150 --resolution_mu 4.25 --jobs 2
```


Expand Down
2 changes: 1 addition & 1 deletion fibermorph/_version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.2.2"
__version__ = "0.2.3"
Loading

0 comments on commit edb1181

Please sign in to comment.