.. pyvsim documentation master file, created by
   sphinx-quickstart on Tue Aug 06 17:06:32 2013.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to pyvsim!
==================

pyvsim, Python Visualization Simulation is a tool for helping in the set-up 
of optical measurement systems.

It includes camera models and the possibility of importing CAD models for the 
calculation of parameters such as field and depth of view.

The physical simulation is written in a generic form, so the project can be 
adapted for many uses (maybe even 3d scenarios rendering).

For the moment, pyvsim is more concentrated in simulating PIV equipment, a nice
example of what it can already do is the configuration below.

.. figure:: ./pivdemo.png
    :scale: 50%
    :align: center
	
	A one-camera PIV configuration using a mirror
	
It can also be used to generate synthetic images of particles (but it's not so 
efficient doing so).

.. figure:: ./synth.png
    :scale: 50%
    :align: center
	
	An example synthetic image

This site is generated from the pyvsim source code, and it is an ongoing 
project.

.. toctree::

Getting started
===============
There is a simple tutorial in the :doc:`tutorial` page.

Download
========

In the `Google Code page <http://code.google.com/p/pyvsim/>`_, you can clone 
the latest version of pyvsim!

Index
======

If you need information about a specific function or class, check the index.

* :ref:`genindex`

Other useful indexes
====================
* :ref:`modindex`
* :ref:`search`