# fft-tools

> Matlab package for Fourier transforms of MRI images.

Latest version **0.1.0** (published 2016-08-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install fft-tools
pnpm add fft-tools
yarn add fft-tools
bun add fft-tools
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2016-08-12 |
| First published | 2016-05-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 1 |
| Author | KC Erb |
| Maintainers | kcerb |
| Keywords | matlab, package, fourier, transform, tools |

## Links

- npm: https://www.npmjs.com/package/fft-tools
- Repository: https://github.com/edibella/fft-tools
- Homepage: https://github.com/edibella/fft-tools#readme
- Issues: https://github.com/edibella/fft-tools/issues
- npm.io page: https://npm.io/package/fft-tools

## Dependencies (1)

- [matlab-spec](https://npm.io/package/matlab-spec.md) ^2.0.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2016-08-12
- 0.0.1 — 2016-05-18
- 0.0.0 — 2016-05-18

## README

# The FftTools Package

## Introduction

This package adds functions and classes that support a variety of Fast Fourier Transform alternatives which have proven useful in a medical image processing workflow.

### NPM

This package uses the node package manager to manage its version control and dependencies. To use this package simply:

1. Install Node: https://nodejs.org/en/

2. Run `npm install fft-tools` at a unix-like terminal.

This will automatically download the files for this package (and the packages it depends on) into a `node_modules` folder. If you add this folder to your MATLAB path the package `FftTools` will be available.

It is crucial to note the difference in naming conventions between MATLAB and NPM. The npm package name is `fft-tools` and the MATLAB package name is '+FftTools'. If you are new to MATLAB packages please learn more about them here: http://www.mathworks.com/help/matlab/matlab_oop/scoping-classes-with-packages.html.

### Tests

To make sure this software works as expected, tests have been provided and which can be run by executing `FftTools.test`. These tests provide a very basic data-in data-out testing and it's these example data files that take up the bulk of the size of this repository.

Since all test data is stored in +tests/private, the files in this folder should not be version controlled. You need to tell your local `git` to not track changes in them via `git update-index --assume-unchanged` as described here: http://stackoverflow.com/questions/12288212/git-update-index-assume-unchanged-on-directory.

If you want to contribute to this project please keep tests in mind and do not commit any new data without telling git to "assume-unchanged" to avoid bloating the .git file.

### Docs

In the `docs/` directory some markdown files are provided explaining how to use each of the functions and classes this package provides.

---
_Source: https://npm.io/package/fft-tools · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._