geometry_extractor
==================

Extract geoemtric features -- surfaces and lines -- from periodic volumetric
data.

*Note:* This module uses pyopencl (via ``simple_cl``) for computations.

Example Usage
-------------
.. code-block:: python

    #First generate a periodic volume -- in this case a unit cell of a gyroid.
    
    NP = 128
    x = np.arange(NP) * 2*np.pi / NP - np.pi
    x = x.reshape(1, 1, NP)
    y = x.reshape(1, NP, 1)
    z = x.reshape(NP, 1, 1)
    
    gyroid = np.sin(x) * np.cos(y) + np.sin(y) * np.cos(z) + np.sin(z) * np.cos(x)    

    #Generate a mesh as a gyroid isosurface
    m = periodic_isosurface(gyroid, level=0)
    
    #Save the mesh as a PLY file
    m.save('gyroid.ply') #Use the mesh.save
    

``geometry_extractor`` can also be used in conjunction with an external
CLSession by specifying the ``clsession`` parameter in the relevant function
calls.  This may dramatically speed up certain operations by preventing data
copying.  Note that any function calls to with a specified ``clsession`` will
automatically compile the geometry extractor kernels for that OpenCL context.

    
Overview
--------

.. currentmodule:: ilpm.geometry_extractor

.. autosummary::
    periodic_isosurface
    periodic_complex_trace
    periodic_interpolate
    periodic_label
    periodic_path_unwrap
    set_opencl_params
    compile_code_in_external_session

   
Classes and Functions
---------------------

.. automodule:: ilpm.geometry_extractor
    :members: 
    :show-inheritance: