Skip to content

Commit

Permalink
bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
Hanjin Liu committed Apr 9, 2024
1 parent c82c2b1 commit 90efea3
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 8 deletions.
Binary file removed Figs/bind.gif
Binary file not shown.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@

# A numpy extension for efficient and powerful image analysis workflow

`impy` is an all-in-one image analysis library, equipped with parallel processing, GPU support, GUI based tools and so on.
`impy` is an all-in-one image analysis library, equipped with parallel processing, GPU
support, GUI-based tools and so on.

The core array, `ImgArray`, is a subclass of `numpy.ndarray`, tagged with information such as
The core array, `ImgArray`, is a subclass of `numpy.ndarray`, tagged with information
such as:

- image axes
- scale of each axis
Expand Down Expand Up @@ -37,7 +39,10 @@ git clone https://github.com/hanjinliu/impy

### Code as fast as you speak

Almost all the functions, such as filtering, deconvolution, labeling, single molecule detection, and even those pure `numpy` functions, are aware of image metadata. They "know" which dimension corresponds to `"z"` axis, which axes they should iterate along or where to save the image. As a result, **your code will be very concise**:
Almost all the functions, such as filtering, deconvolution, labeling, single molecule
detection, and even those pure `numpy` functions, are aware of image metadata. They
"know" which dimension corresponds to `"z"` axis, which axes they should iterate along
or where to save the image. As a result, **your code will be very concise**:

```python
import impy as ip
Expand All @@ -52,7 +57,7 @@ img_prj.imsave(f"Max-{img.name}") # Save in the same place. Don't spend tim

### Supports many file formats

`impy` automatically chooses proper reader/writer according to the extension.
`impy` automatically chooses the proper reader/writer according to the extension.

- Tiff file (".tif", ".tiff")
- MRC file (".mrc", ".rec", ".st", ".map", ".map.gz")
Expand Down Expand Up @@ -111,8 +116,8 @@ img.imfilter(param=1.0)

### Command line usage

`impy` also supports command line based image analysis. All method of `ImgArray` is available
from commad line, such as
`impy` also supports command-line-based image analysis. All methods of `ImgArray` are
available from the command line, such as

```shell
impy path/to/image.tif ./output.tif --method gaussian_filter --sigma 2.0
Expand All @@ -127,7 +132,7 @@ out = img.gaussian_filter(sigma=2.0)
out.imsave("./output.tif")
```

For more complex procedure, it is possible to send image directly to `IPython`
For more complex procedures, it is possible to send images directly to `IPython`

```
impy path/to/image.tif -i
Expand Down
2 changes: 1 addition & 1 deletion impy/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
__version__ = "2.4.0"
__version__ = "2.4.1"
__author__ = "Hanjin Liu"
__email__ = "[email protected]"

Expand Down

0 comments on commit 90efea3

Please sign in to comment.