Skip to content

Commit 13c811a

Browse files
Refresh README
The README now mentions `JxrDecApp`, and has more thorough installation instructions. Additionally, it uses the new `batch.sh` option syntax (following `batch.sh`'s switch to using `czinspect`).
1 parent f7c5a5b commit 13c811a

File tree

1 file changed

+37
-25
lines changed

1 file changed

+37
-25
lines changed

README.md

Lines changed: 37 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
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)
22

33
Software for extracting images and metadata from Carl Zeiss Images (`.czi`
44
files). This format is in use in microscopy.
@@ -8,10 +8,12 @@ data from already-existing `.czi`s.
88

99
## Requirements
1010

11+
### `vips`
12+
1113
These tools require [vips](https://github.com/jcupitt/libvips) version 8 or
12-
greater, and uuid development tools.
14+
greater.
1315

14-
### Ubuntu
16+
#### Ubuntu
1517

1618
Xenial Ubuntu and onward can install vips using `apt-get`:
1719
```bash
@@ -20,42 +22,54 @@ sudo apt-get install libvips-dev
2022
Older versions may be able to
2123
[build from source](https://github.com/jcupitt/libvips/wiki/Build-for-Ubuntu#building-from-source).
2224

23-
Either way, uuid development headers are also required:
24-
```bash
25-
sudo apt-get install uuid-dev
26-
```
27-
28-
### OSX
25+
#### MacOS
2926

30-
Mac users can install dependencies via [`brew`](https://brew.sh/):
27+
Mac users can install `vips` via [`brew`](https://brew.sh/):
3128
```bash
3229
brew install vips --with-imagemagick --without-graphicsmagick --with-openexr --with-openslide
33-
brew install ossp-uuid
3430
```
3531

36-
### Fedora
32+
#### Fedora
3733
```bash
38-
sudo dnf install vips vips-devel uuid-devel
34+
sudo dnf install vips vips-devel
3935
```
4036

41-
### Debian
37+
#### Debian
4238
```bash
43-
sudo apt-get install libvips-dev uuid-dev
39+
sudo apt-get install libvips-dev
4440
```
4541

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+
4656
## Building
4757

4858
Building should be as simple as
4959
```bash
5060
make
5161
```
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.
5464

5565
Tests are also available:
5666
```bash
5767
make test
5868
```
69+
To move all of the built binaries to the `bin` folder:
70+
```bash
71+
make bin
72+
```
5973

6074
## Running
6175

@@ -66,20 +80,18 @@ Each of the utility programs can be found in the appropriate `src` subfolder.
6680
Documentation for the use of these utilities is currently non-existant. All
6781
utilities have help-text that should be kept up-to-date:
6882
```bash
69-
./src/extractjxr/extractjxr --help
70-
./src/regions/get_region --help
71-
./src/czinspect/czinspect --help
83+
get_region -h
84+
czinspect -h
7285
```
7386

7487
### Scripts
7588

7689
Some utility scripts have been supplied in the `bin` folder:
7790

78-
- `deczi.sh` is the main script for handling the extraction and conversion of
79-
`.czi` files.
8091
- `batch.sh` is a script designed to batch-process a bunch of `.czi` files at
8192
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.
8395

8496
### Example Use
8597

@@ -90,7 +102,7 @@ and you want to extract every image tile (converted to `.png`s)
90102
from each of these files into respective subdirectories under the directory
91103
`extracted-tiles`:
92104
```bash
93-
batch.sh -pd "extracted-tiles" "czi-folder"
105+
batch.sh -Ed "extracted-tiles" "czi-folder"
94106
```
95107
Each set of `.png`s will turn up in a subdirectory of `extracted-tiles` named
96108
after the `.czi` file they came from.
@@ -102,7 +114,7 @@ residing in the directory `all-extracted`, and now you want a `123x789`-sized
102114
region with its top-left corner at x-y coordinate `3030,2929` of the whole
103115
image. Additionally, you want the output to be a `.png`
104116
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:
106118
```bash
107119
get_region -i "all-extracted" -l 3030 -u 2929 -r 3153 -d 3718 -o "my-region.png" -z 8
108120
```

0 commit comments

Comments
 (0)