py4sci

Table Of Contents

Next topic

One-line installation

This Page

pyLICORS Documentation

pyLICORS is a Python package estimates the predictive state space of a spatio-temporal process given spatio-temporal data. Typically this is a video (2D random field) observed for \(T\) time steps.

Note

References are arxiv.org/abs/1211.3760 and arxiv.org/abs/1206.2398 .

pyLICORS can handle

  1. \((2+1)D\) space-time random fields (aka as videos = 2D images in time (1D))
    • sequences of images (bmp, jpg, or png)
    • videos (avi, mpg, or mov)
    • fMRI data formats (.gz, .img, nii.gz)
  2. \((1+1)D\) space-time random fields (e.g. cellular automata. They are less common in practice, but good for simulations and visualization: think of an image where space is vertical and time goes from left to right).
    • comma separated txt or dat files, where each row is the time evolution of the system at space point \(r\); column 1 is the entire system at time \(t=1\), column 2 the system at time \(t=2\), and so on.
    • images (bmp, jpg, or png)

Note

Although libraries used in pyLICORS are available for most platforms that run Python, it was developed on a Windows installation of Python. It has also been successfully tested on Ubuntu 11.10 (only difference that on Ubuntu built-in cv library was used for OpenCV; on Windows pyopencv).

These instruction may follow - sometimes unaware - a Windows style installation. In principle pyLICORS should not have any problems to run on Linux/MacOS.

If you do encounter problems, please let me know.

Pre-release of software and documentation

This is a very first planning release of the software: the main features are not available yet, it is just an initial draft. Core functions will be added over the course of the next months.

This means that the functionality and the documentation will change in the future. In particular, function names, class names, functionality of classes, internal structures of the code, etc. will certainly change (so all follow the Python PEP8 naming conventions ).

Warning

Users that want to use individual functions in the package to run specific parts of the analysis must be aware that their scripts will break when run with future releases of pyLICORS.

Indices and tables