<commit_before>Real-Time ARFI Image Visualization using VTK
============================================

Setup
-----

1. [Install CMake and build the VTK Libraries.](http://www.vtk.org/Wiki/VTK/Configure_and_Build)

 Some random notes on building this on Windows 10 with Qt 5.2.1 (OpenGL):

 * The Qt version will default to 4; you need to manually change this to 5 (if you choose to use 5).

 * `Qt5_DIR` had to be manually set to `C:/Qt/Qt5.2.1/5.2.1/msvc2012_64_opengl/lib/cmake/Qt5`

 * Errors related to `glu32` not being found can be fixed by setting 
  `CMAKE_PREFIX_PATH=C:/Program Files (x86)/Microsoft SDKs/Windows/v7.1A/Lib` 
  on my system.  This was non-obvious since the wiki page points you to a path in the Qt 
  install.
      
 This build worked "out of the box" on Fedora 23 with the system-wide VTK developer tools installed.

2. Create a new directory named `build` and change to that directory.

    `mkdir build && cd build`

3. Type `cmake ..`

4. Build the project.

    `make`

5. Test that the script works by inputting image names through standard input (stdin).

    `cd ..`
    
    `ls -d images/JPG/dog-* | ./build/ARFIVisualization `<commit_msg>update README for Visual Studio build<commit_after>Real-Time ARFI Image Visualization using VTK
============================================


Install CMake and build the VTK Libraries
-----------------------------------------

http://www.vtk.org/Wiki/VTK/Configure_and_Build

Some random notes on building this on Windows 10 with Qt 5.2.1 (OpenGL):

* The Qt version will default to 4; you need to manually change this to 5 (if you choose to use 5).

* `Qt5_DIR` had to be manually set to `C:/Qt/Qt5.2.1/5.2.1/msvc2012_64_opengl/lib/cmake/Qt5`

* Errors related to `glu32` not being found can be fixed by setting 
  `CMAKE_PREFIX_PATH=C:/Program Files (x86)/Microsoft SDKs/Windows/v7.1A/Lib` 
  on my system.  This was non-obvious since the wiki page points you to a path in the Qt 
  install.
      
This build worked "out of the box" on Fedora 23 with the system-wide VTK developer tools installed.

Compile Project
---------------
* Linux

  * Create a new directory named `build` and change to that directory.

    `mkdir build && cd build`

  * Type `cmake ..`

  * Build the project.

    `make`

* Visual Studio

  * Setup cmake using some of the config options noted above to build VTK.
  
  * Make sure to link to your build VTK directory.
  
  * Use Release and BUILD_ALL in VS.
  
  * Make sure that your PATH environmental variable points to your VTK DLLS (e.g., ``C:\VTK\bin\Release``)

Running the ARFIVisualiation
----------------------------
Test that the script works by inputting image names through standard input (stdin).  For example:
    
    `ls -d images/JPG/dog-* | ./build/ARFIVisualization `
{'fraction_non_alphanumeric': 0.1411722659042173, 'fraction_numerical': 0.023230879199428164, 'mean_word_length': 2.947813822284908, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1578729', 'n_tokens_mistral': 915, 'n_tokens_neox': 851, 'n_words': 355}