<commit_before>ViTables Image Viewer 
=====================

This is a plug-in to ViTables_ to view data sets as images.  It uses
PyQtGraph_ to visualize the data sets in the workspace.  Valid viewable
data sets include 2D arrays (H,W) as monochrome images, 3D arrays as
RGB(A) (H,W,3) with or without the alpha channel, 3D arrays as N
monochrome images (N,H,W), and 4D arrays as N RGB(A) images (N,H,W,3).
A long term goal is to answer the problems addressed in `Issue #11`_.

This plug-in is designed to work with the development branch of ViTables
(2.2a1), and, therefore, uses ``setuptools`` to declare the entry points
into ``vitables.plugins``.

Screen Shot 
-----------

.. image:: example/screen_shot_20150521T140720.png


Installation 
------------

First, ensure that the correct version of ViTables_ and PyQtGraph_ are
installed.  The minimum version of ViTables necessary is (2.2a1) which
is currently the development branch.  The lowest know version of
PyQtGraph that has been tested is 0.9.10.  Once those dependencies have
been installed, run::

    python setup.py install

After running the install, launch ViTables, open the Preferences menu,
select the Plugins tab, and enable Image Viewer.  Once you restart
ViTables, you can right click on a data set and view it as an image.

Preferences 
-----------

The default ordering of the arrays in the file is assumed to be (Depth,
Width, Height, RGB(A)).  To change this order, go to Preferences ->
image_viewer and select the proper order.  To have this persist, simply
hit save before exiting the preferences menu.

### Notes ###

As noted in `Issue #33`_, the current development branch of ViTables
requires `setuptools-git` to work.  If you need to install ViTables from
an archived download, please refer to `this patch`_ to aid in
installation.  Alternatively, you can download the patched version of
the development branch here_.

.. _ViTables: http://vitables.org .. _PyQtGraph:
http://www.pyqtgraph.org .. _Issue #11:
https://github.com/uvemas/ViTables/issues/11 .. _Issue #33:
https://github.com/uvemas/ViTables/issues/33 .. _this patch:
https://github.com/kprussing/ViTables/commit/9ca932dc862704b30b7f49c997a35385cf59235c
.. _here: https://github.com/kprussing/ViTables/tree/install_fix
<commit_msg>Get the link format right<commit_after>ViTables Image Viewer 
=====================

This is a plug-in to ViTables_ to view data sets as images.  It uses
PyQtGraph_ to visualize the data sets in the workspace.  Valid viewable
data sets include 2D arrays (H,W) as monochrome images, 3D arrays as
RGB(A) (H,W,3) with or without the alpha channel, 3D arrays as N
monochrome images (N,H,W), and 4D arrays as N RGB(A) images (N,H,W,3).
A long term goal is to answer the problems addressed in `Issue #11`_.

This plug-in is designed to work with the development branch of ViTables
(2.2a1), and, therefore, uses ``setuptools`` to declare the entry points
into ``vitables.plugins``.

Screen Shot 
-----------

.. image:: example/screen_shot_20150521T140720.png


Installation 
------------

First, ensure that the correct version of ViTables_ and PyQtGraph_ are
installed.  The minimum version of ViTables necessary is (2.2a1) which
is currently the development branch.  The lowest know version of
PyQtGraph that has been tested is 0.9.10.  Once those dependencies have
been installed, run::

    python setup.py install

After running the install, launch ViTables, open the Preferences menu,
select the Plugins tab, and enable Image Viewer.  Once you restart
ViTables, you can right click on a data set and view it as an image.

Preferences 
-----------

The default ordering of the arrays in the file is assumed to be (Depth,
Width, Height, RGB(A)).  To change this order, go to Preferences ->
image_viewer and select the proper order.  To have this persist, simply
hit save before exiting the preferences menu.

### Notes ###

As noted in `Issue #33`_, the current development branch of ViTables
requires `setuptools-git` to work.  If you need to install ViTables from
an archived download, please refer to `this patch`_ to aid in
installation.  Alternatively, you can download the patched version of
the development branch here_.

.. _ViTables: http://vitables.org 
.. _PyQtGraph: http://www.pyqtgraph.org 
.. _Issue #11: https://github.com/uvemas/ViTables/issues/11 
.. _Issue #33: https://github.com/uvemas/ViTables/issues/33 
.. _this patch: https://github.com/kprussing/ViTables/commit/9ca932dc862704b30b7f49c997a35385cf59235c
.. _here: https://github.com/kprussing/ViTables/tree/install_fix

{'fraction_non_alphanumeric': 0.09938704028021016, 'fraction_numerical': 0.03064798598949212, 'mean_word_length': 4.01536772777168, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 8, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2421371', 'n_tokens_mistral': 1457, 'n_tokens_neox': 1348, 'n_words': 592}