indii/fmri/namespace.hpp

namespace indii {
  namespace fmri {

/**
 * @mainpage fmrii fMRI Modelling Library
 *
 * This C++ library provides a number of models for working with
 * Functional Magnetic Resonance Imaging (fMRI) %data. At this stage
 * it provides:
 *
 * @li the regular and log space balloon models,
 * @li simple %neural models,
 * @li simple %experimental input models, and
 * @li compound models which combine any number of the above.
 *
 * All of the models are compatible with probabilistic methods
 * provided by the @c dysii Dynamic Systems Library
 * (http://www.indii.org/software/dysii/) for %model fitting and
 * parameter estimation.
 *
 * Features are added to the library as needed, so that it does lack
 * some completeness. What is included, however, is well documented
 * and tested, and may be considered fairly sound for research
 * purposes.
 *
 * The library has been optimised for performance, while maintaining a
 * modularity and generality that makes it suitable for a wide range
 * of applications within the fMRI domain.
 *
 * @section requirements Installation
 *
 * For requirements and installation instructions, see the @c
 * README.txt file included in the distribution.
 *
 * @section start Getting started
 *
 * To compile a program using the library, link in the @c fmrii
 * library along with @c dysii and its required libraries. See the @c
 * dysii documentation for more information on these.
 *
 * Browse through the documentation to see the features
 * available. Starting at the @em namespaces page and working down is
 * recommended. All classes are thoroughly documented, with examples
 * of use included in many cases, and references to further resources
 * with more detailed explanation where available.
 *
 * @section further Further information
 *
 * For further information see the website
 * (http://www.indii.org/software/fmrii/) or contact the author,
 * Lawrence Murray (lawrence@indii.org).
 */

  }
}

---