Metadata-Version: 1.1
Name: emva1288
Version: 0.2.0
Summary: EMVA1288 reference implementation
Home-page: https://github.com/EMVA1288/emva1288
Author: Federico Ariza
Author-email: ariza.federico@gmail.com
License: UNKNOWN
Description: EMVA1288
        ========
        
        This is the reference implementation for the EMVA1288 Standard for
        Measurement and Presentation of Specifications for Machine Vision
        Sensors and Cameras.
        
        Please visit `Emva1288
        Website <http://www.emva.org/cms/index.php?idcat=26>`__ for information
        and latest releases of the standard.
        
        Installation
        ============
        
        For inexperienced windows users it is recommended to use a prepackaged
        python distribution that contains the required packages. One excellent
        option for Windows users is `Anaconda <http://continuum.io/>`__
        
        Once the python environment is installed just run
        ``pip install emva1288``
        
        Description
        ===========
        
        If you are in a rush there is one utility class that allows to do the
        full process in a very simple way
        
        ::
        
            from emva1288 import Emva1288
        
            # Load your data descriptor file
            e = Emva1288(filename)
            # Print the results
            e.results()
            # Plot the graphics
            e.plot()
        
        If you are interested keep reading.
        
        The code is dvidided in 7 parts
        
        parser.ParseEmvaDescriptorFile
        ------------------------------
        
        This class takes an EMVA1288 descriptor file and loads its content into
        a python dictionary.
        
        An EMVA1288 descriptor file is a file that contains the description of
        an EMVA1288 test including exposure times, photon count and
        corresponding images
        
        `Example of a descriptor file <https://github.com/EMVA1288/emva1288/blob/master/examples/EMVA1288_Descriptor_File.txt>`__
        
        loader.LoadImageData
        --------------------
        
        This class takes a dictionary (product of
        ``parser.ParseEmvaDescriptorFile``). Load the related images and reduce
        it's data to the minimum possible, **preserving all relevant image data
        in as integers**. The resulting data is a Python dictionary.
        
        `Example of the reduced data <https://github.com/EMVA1288/emva1288/blob/master/examples/EMVA1288_image_data.txt>`__
        
        data.Data1288
        -------------
        
        This class takes a dictionary with image data (product of
        ``loader.LoadImageData``), and transforms it into data that can be used
        for the EMVA1288 computations. It is important to note, that this is
        separate from ``LoadImageData`` because this step, produces float values
        that are not easily transportable (db, json, etc...) without loosing
        accuracy.
        
        results.Results1288
        -------------------
        
        This class takes the data from ``data.Data1288`` and compute the actual
        EMVA1288 values.
        
        plotting.Plotting1288
        ---------------------
        
        This class takes a ``results.Results1288`` object and produces all the
        plots needed to create a reference datasheet of the EMVA1288 test
        
        report.Report1288
        -----------------
        This class creates a directory with all the files needed to compile a latex
        report.
        
        report.marketing
        ~~~~~~~~~~~~~~~~
        This is a function that returns a named tuple to fill with the marketing data
        needed for the report
        
        report.op
        ~~~~~~~~~
        Function that returns a named tuple serving as a place holder for all the data
        needed for an operation point in the report
        
        Usage
        =====
        
        To use the code, you need to have a set of images that correspond to an
        EMVA1288 test. There are some sample image sets provided by the standard
        development group. `Example
        datasets <https://emva1288.plan.io/projects/emva1288-standard-public/files>`__.
        
        Download one or all of these datasets, extract its content, and use them
        as input in the examples shown below.
        
        Examples
        ========
        
        -  `A simple example <https://github.com/EMVA1288/emva1288/blob/master/examples/simple_emva_process.py>`__
        -  `Step by step example <https://github.com/EMVA1288/emva1288/blob/master/examples/full_emva_process.py>`__
        -  `Experimental report generation module <https://github.com/EMVA1288/emva1288/blob/report/examples/simple_emva_process.py>`__
        
Keywords: sensors,cameras
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
