1
- # CZI Extractor ![ Build Status] ( https://travis-ci.com/magnostherobot/zeiss.svg?branch=master )
1
+ # CZI Extractor [ ![ Build Status] ( https://travis-ci.com/magnostherobot/zeiss.svg?token=w7ew2jpnKbReLg9cZxN1& branch=master )] ( https://travis-ci.com/magnostherobot/zeiss )
2
2
3
3
Software for extracting images and metadata from Carl Zeiss Images (` .czi `
4
4
files). This format is in use in microscopy.
@@ -8,10 +8,12 @@ data from already-existing `.czi`s.
8
8
9
9
## Requirements
10
10
11
+ ### ` vips `
12
+
11
13
These tools require [ vips] ( https://github.com/jcupitt/libvips ) version 8 or
12
- greater, and uuid development tools .
14
+ greater.
13
15
14
- ### Ubuntu
16
+ #### Ubuntu
15
17
16
18
Xenial Ubuntu and onward can install vips using ` apt-get ` :
17
19
``` bash
@@ -20,42 +22,54 @@ sudo apt-get install libvips-dev
20
22
Older versions may be able to
21
23
[ build from source] ( https://github.com/jcupitt/libvips/wiki/Build-for-Ubuntu#building-from-source ) .
22
24
23
- Either way, uuid development headers are also required:
24
- ``` bash
25
- sudo apt-get install uuid-dev
26
- ```
27
-
28
- ### OSX
25
+ #### MacOS
29
26
30
- Mac users can install dependencies via [ ` brew ` ] ( https://brew.sh/ ) :
27
+ Mac users can install ` vips ` via [ ` brew ` ] ( https://brew.sh/ ) :
31
28
``` bash
32
29
brew install vips --with-imagemagick --without-graphicsmagick --with-openexr --with-openslide
33
- brew install ossp-uuid
34
30
```
35
31
36
- ### Fedora
32
+ #### Fedora
37
33
``` bash
38
- sudo dnf install vips vips-devel uuid-devel
34
+ sudo dnf install vips vips-devel
39
35
```
40
36
41
- ### Debian
37
+ #### Debian
42
38
``` bash
43
- sudo apt-get install libvips-dev uuid-dev
39
+ sudo apt-get install libvips-dev
44
40
```
45
41
42
+ ### ` libuuid ` Development Headers
43
+
44
+ The ` libuuid ` development headers are also required for building.
45
+ These can usually be installed using your system package manager, or can be
46
+ [ built from source] ( https://github.com/karelzak/util-linux/tree/master/libuuid ) .
47
+
48
+ ### ` JxrDecApp `
49
+
50
+ Microsoft's JPEG-XR decoding tool ` JxrDecApp ` is required on the system's
51
+ ` PATH ` . Some operating systems may have a package for this, or it can be
52
+ [ built from source] ( https://github.com/curasystems/jxrlib/blob/master/Makefile )
53
+ (only ` JxrDecApp ` is required from this codebase, so all necessary building can
54
+ be done using ` make JxrDecApp ` ).
55
+
46
56
## Building
47
57
48
58
Building should be as simple as
49
59
``` bash
50
60
make
51
61
```
52
- ** Note** : due to a conflict in different ` ld ` implementations, OSX cannot build
53
- this project right now.
62
+ ** Note** : due to a conflict in different ` ld ` implementations, MacOS cannot
63
+ build this project right now.
54
64
55
65
Tests are also available:
56
66
``` bash
57
67
make test
58
68
```
69
+ To move all of the built binaries to the ` bin ` folder:
70
+ ``` bash
71
+ make bin
72
+ ```
59
73
60
74
## Running
61
75
@@ -66,20 +80,18 @@ Each of the utility programs can be found in the appropriate `src` subfolder.
66
80
Documentation for the use of these utilities is currently non-existant. All
67
81
utilities have help-text that should be kept up-to-date:
68
82
``` bash
69
- ./src/extractjxr/extractjxr --help
70
- ./src/regions/get_region --help
71
- ./src/czinspect/czinspect --help
83
+ get_region -h
84
+ czinspect -h
72
85
```
73
86
74
87
### Scripts
75
88
76
89
Some utility scripts have been supplied in the ` bin ` folder:
77
90
78
- - ` deczi.sh ` is the main script for handling the extraction and conversion of
79
- ` .czi ` files.
80
91
- ` batch.sh ` is a script designed to batch-process a bunch of ` .czi ` files at
81
92
once.
82
- - ` czi2png.sh ` and ` jxr2png.sh ` are old scripts no longer used.
93
+ - ` czi2png.sh ` , ` jxr2png.sh ` , and ` deczi-extracjxr.sh `
94
+ are old scripts no longer used.
83
95
84
96
### Example Use
85
97
@@ -90,7 +102,7 @@ and you want to extract every image tile (converted to `.png`s)
90
102
from each of these files into respective subdirectories under the directory
91
103
` extracted-tiles ` :
92
104
``` bash
93
- batch.sh -pd " extracted-tiles" " czi-folder"
105
+ batch.sh -Ed " extracted-tiles" " czi-folder"
94
106
```
95
107
Each set of ` .png ` s will turn up in a subdirectory of ` extracted-tiles ` named
96
108
after the ` .czi ` file they came from.
@@ -102,7 +114,7 @@ residing in the directory `all-extracted`, and now you want a `123x789`-sized
102
114
region with its top-left corner at x-y coordinate ` 3030,2929 ` of the whole
103
115
image. Additionally, you want the output to be a ` .png `
104
116
called ` my-region.png ` , and the output image
105
- to be a zoom level 8. The appropriate command would be:
117
+ to be at zoom level 8. The appropriate command would be:
106
118
``` bash
107
119
get_region -i " all-extracted" -l 3030 -u 2929 -r 3153 -d 3718 -o " my-region.png" -z 8
108
120
```
0 commit comments