cine
====

This module is used to read Phatom CINE files.

Overview
--------

.. currentmodule:: ilpm.cine

.. autosummary:: 
    Cine


Example Usage
-------------

.. code-block:: python

    #!/usr/bin/env python
    from ilpm import cine
    
    #Load the cine
    c = cine.Cine('/Volumes/labshared2/dustin/2013_10_09_smoke_rings/2103_10_09_snoke_ring_close_III.cine')
    
    
    #Print some basic info
    print 'Total frames:', len(c)
    print 'Bit depth:', c.real_bpp
    print 'Frame size: %dx%d' % (c.width, c.height)
    print 'Frame rate:', c.frame_rate
    
    
    #Load a frame
    frame_num = len(c)//3
    t = c.get_time(frame_num)
    
    #Get the raw frame data
    raw = c[frame_num]
    #If the raw image has more than 8 bytes of data we need to fix this so we can
    #  save as a regular image!
    if c.real_bpp > 8:
        raw = (raw>>(c.real_bpp - 8)).astype('u1')
    
    #Get a gamma correceted frame - this should appear more natural when saved as
    #  a regular image.
    gamma_corrected = c.gamma_corrected_frame(frame_num)
    
    
    #Convert to Python Image Library objects to save as a PNG
    import Image
    Image.fromarray(raw).save('cine-test-raw.png')
    Image.fromarray(gamma_corrected).save('cine-test-gamma_corrected.png')
    
    
    #Plot some images with pylab.
    import pylab as P
    
    P.subplot(211)
    P.title('Raw Data (t=%d ms)' % (t*1E3))
    P.imshow(raw, cmap='gray')
    
    P.subplot(212)
    P.title('Gamma Corrected (t=%d ms)' % (t*1E3))
    P.imshow(gamma_corrected, cmap='gray')
    
    P.show()
    
   
Cine Class
----------

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