# critter

> Matlab package for iterative image reconstruction

Latest version **1.1.0** (published 2016-08-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install critter
pnpm add critter
yarn add critter
bun add critter
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2016-08-13 |
| First published | 2016-05-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 0 |
| Author | KC Erb |
| Maintainers | kcerb |
| Keywords | matlab, package, iterative, reconstruction, MRI, image |

## Links

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

## Dependencies (3)

- [fft-tools](https://npm.io/package/fft-tools.md) ^0.0.0
- [matlab-spec](https://npm.io/package/matlab-spec.md) ^2.1.2
- [sense-mapper](https://npm.io/package/sense-mapper.md) ^1.0.0

## Alternatives

- [exif-parser](https://npm.io/package/exif-parser.md) — 3.8M weekly downloads
- [vite-plugin-compression](https://npm.io/package/vite-plugin-compression.md) — 569.5K weekly downloads
- [pica](https://npm.io/package/pica.md) — 442.4K weekly downloads
- [@reportportal/client-javascript](https://npm.io/package/@reportportal/client-javascript.md) — 408.8K weekly downloads
- [@tldraw/state](https://npm.io/package/@tldraw/state.md) — 316.0K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2016-08-13
- 1.0.0 — 2016-06-20
- 0.0.0 — 2016-05-18

## README

# The Critter Package

## Introduction

This is a MATLAB package for iterative image reconstruction via a variety of methods. Right now it just supports SCR and STCR (via TV regularization) but in the future it should support other methods such as ESPIRiT with L1-Wavelets, multi-coil STCR and so on.

### 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 critter` 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 `Critter` will be available.

It is crucial to note the difference in naming conventions between MATLAB and NPM. The npm package name is `critter` and the MATLAB package name is `+Critter`. 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 in the present environment, tests have been provided and can be run by executing `Critter.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/critter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._