https://github.com/emmt/fineshift.jl
Fast sub-sample shift of multi-dimensional arrays in Julia
https://github.com/emmt/fineshift.jl
Last synced: 3 months ago
JSON representation
Fast sub-sample shift of multi-dimensional arrays in Julia
- Host: GitHub
- URL: https://github.com/emmt/fineshift.jl
- Owner: emmt
- License: other
- Created: 2019-07-03T12:57:50.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-15T06:33:15.000Z (almost 3 years ago)
- Last Synced: 2025-01-29T06:48:19.240Z (over 1 year ago)
- Language: Julia
- Size: 39.1 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# FineShift Package
| **License** | **Build Status** | **Code Coverage** |
|:--------------------------------|:----------------------------------------------------------------|:--------------------------------------------------------------------|
| [![License][License-img]][license-url] | [![Build Status][github-ci-img]][github-ci-url] [![Build Status][appveyor-img]][appveyor-url] | [![Code Coverage][coveralls-img]][coveralls-url] [![Code Coverage][codecov-img]][codecov-url] |
**FineShift** is a [**Julia**][julia-url] package for fast sub-sample
shifting of multi-dimensional arrays. It can also be used to apply separable
stationary linear filters of small sizes (a.k.a. **discrete correlations**
or **discrete convolutions**).
FineShift implements fine-shifting of Julia arrays by means of separable
interpolation. After installation (see below), calling `using FineShift`
provides the following methods:
- `fineshift` for fine-shifting along a dimension;
- `fineshift!` is an in-place version of for `fineshift`;
- `convolve` for separable convolution by a small sampled kernel;
- `convolve!` is an in-place version of for `convolve`;
- `correlate` for separable correlation by a small sampled kernel;
- `correlate!` is an in-place version of for `correlate`;
## Installation
The easiest way to install `FineShift` is via Julia registry
[`EmmtRegistry`](https://github.com/emmt/EmmtRegistry):
```julia
using Pkg
pkg"registry add General" # if you have not yet any registries
pkg"registry add https://github.com/emmt/EmmtRegistry"
pkg"add FineShift"
```
[doc-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
[doc-stable-url]: https://emmt.github.io/FineShift.jl/stable
[doc-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
[doc-dev-url]: https://emmt.github.io/FineShift.jl/dev
[license-url]: ./LICENSE.md
[license-img]: http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat
[github-ci-img]: https://github.com/emmt/FineShift.jl/actions/workflows/CI.yml/badge.svg?branch=master
[github-ci-url]: https://github.com/emmt/FineShift.jl/actions/workflows/CI.yml?query=branch%3Amaster
[appveyor-img]: https://ci.appveyor.com/api/projects/status/github/emmt/FineShift.jl?branch=master
[appveyor-url]: https://ci.appveyor.com/project/emmt/FineShift-jl/branch/master
[coveralls-img]: https://coveralls.io/repos/emmt/FineShift.jl/badge.svg?branch=master&service=github
[coveralls-url]: https://coveralls.io/github/emmt/FineShift.jl?branch=master
[codecov-img]: http://codecov.io/github/emmt/FineShift.jl/coverage.svg?branch=master
[codecov-url]: http://codecov.io/github/emmt/FineShift.jl?branch=master
[julia-url]: https://pkg.julialang.org/