diff --git a/Cargo.toml b/Cargo.toml index 5852efe..d4f9dc1 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,8 @@ [package] authors = ["Eduardo Pinho "] +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" diff --git a/LICENSE-APACHE b/LICENSE-APACHE index e384bd6..0111845 100644 --- a/LICENSE-APACHE +++ b/LICENSE-APACHE @@ -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. diff --git a/LICENSE-MIT b/LICENSE-MIT index 7bb7889..4faaea2 100644 --- a/LICENSE-MIT +++ b/LICENSE-MIT @@ -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 diff --git a/README.md b/README.md index 1aacc4b..5f71f0c 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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::(); ``` -# 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 diff --git a/src/volume.rs b/src/volume.rs index 0564b6a..e38be6e 100644 --- a/src/volume.rs +++ b/src/volume.rs @@ -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