Skip to content

Commit

Permalink
Almost there!
Browse files Browse the repository at this point in the history
- update cargo meta
- update readme
- update licenses
- update NiftiVolume trait documentation
  • Loading branch information
Enet4 committed May 25, 2017
1 parent 1cf9e92 commit 64594bc
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 8 deletions.
2 changes: 2 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
[package]
authors = ["Eduardo Pinho <[email protected]>"]
categories = ["parser-implementations"]
description = "Rust implementation of the NIfTI file format"
keywords = ["nifti", "neuroimaging", "standard", "parser"]
license = "MIT/Apache-2.0"
name = "nifti"
readme = "README.md"
Expand Down
2 changes: 1 addition & 1 deletion LICENSE-APACHE
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2016 Eduardo Pinho
Copyright 2017 Eduardo Pinho

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion LICENSE-MIT
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2016 Eduardo Pinho
Copyright (c) 2017 Eduardo Pinho

Permission is hereby granted, free of charge, to any
person obtaining a copy of this software and associated
Expand Down
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,7 @@

[![Build Status](https://travis-ci.org/Enet4/nifti-rs.svg?branch=master)](https://travis-ci.org/Enet4/nifti-rs)

This library is a pure Rust implementation for reading files in the NIFTI-1 format.

It is currently a work in progress.

This library is a pure Rust implementation for reading files in the [NIfTI](https://nifti.nimh.nih.gov/nifti-1/) format (more specifically NIfTI-1.1).

## Example

Expand Down Expand Up @@ -34,6 +31,19 @@ With the "ndarray_volumes" feature enabled, you can also convert a volume to an
let volume = obj.into_volume().to_ndarray::<f32>();
```

# License
## Roadmap

This library should hopefully fulfil a good number of use cases. However, it still is a bit far
from a complete solution. In particular, future versions should be able to:

- Write NIFTI files;
- Provide a more elegant volume API;
- Handle more kinds of volumes;
- Provide a real spatial-temporal interpretation of the volume (rather than just voxel-indexed);
- Maybe add support for NIFTI-2?

There are no deadlines for these features, so your help is much appreciated. Consider filing an [issue](issues) in case something is missing for your use case to work. Pull requests are also welcome.

## License

Apache-2/MIT
4 changes: 3 additions & 1 deletion src/volume.rs
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,11 @@ use num::FromPrimitive;
#[cfg(feature = "ndarray_volumes")] use std::ops::{Add, Mul};
#[cfg(feature = "ndarray_volumes")] use num::Num;


/// Public API for NIFTI volume data, exposed as a multi-dimensional
/// voxel array.
///
/// This API is currently experimental and will likely be subjected to
/// various changes and additions in future versions.
pub trait NiftiVolume {
/// Get the dimensions of the volume. Unlike how NIFTI-1
/// stores dimensions, the returned slice does not include
Expand Down

0 comments on commit 64594bc

Please sign in to comment.