1db000b9a7e96c591a15487587de905724bd3e42
[opencv] / interfaces / swig / python / cv.i
1 /*M///////////////////////////////////////////////////////////////////////////////////////
2 //
3 //  IMPORTANT: READ BEFORE DOWNLOADING, COPYING, INSTALLING OR USING.
4 //
5 //  By downloading, copying, installing or using the software you agree to this license.
6 //  If you do not agree to this license, do not download, install,
7 //  copy or use the software.
8 //
9 //
10 //                        Intel License Agreement
11 //                For Open Source Computer Vision Library
12 //
13 // Copyright (C) 2000, Intel Corporation, all rights reserved.
14 // Third party copyrights are property of their respective owners.
15 //
16 // Redistribution and use in source and binary forms, with or without modification,
17 // are permitted provided that the following conditions are met:
18 //
19 //   * Redistribution's of source code must retain the above copyright notice,
20 //     this list of conditions and the following disclaimer.
21 //
22 //   * Redistribution's in binary form must reproduce the above copyright notice,
23 //     this list of conditions and the following disclaimer in the documentation
24 //     and/or other materials provided with the distribution.
25 //
26 //   * The name of Intel Corporation may not be used to endorse or promote products
27 //     derived from this software without specific prior written permission.
28 //
29 // This software is provided by the copyright holders and contributors "as is" and
30 // any express or implied warranties, including, but not limited to, the implied
31 // warranties of merchantability and fitness for a particular purpose are disclaimed.
32 // In no event shall the Intel Corporation or contributors be liable for any direct,
33 // indirect, incidental, special, exemplary, or consequential damages
34 // (including, but not limited to, procurement of substitute goods or services;
35 // loss of use, data, or profits; or business interruption) however caused
36 // and on any theory of liability, whether in contract, strict liability,
37 // or tort (including negligence or otherwise) arising in any way out of
38 // the use of this software, even if advised of the possibility of such damage.
39 //
40 //M*/
41
42 // 2004-03-16, Gabriel Schreiber <schreiber@ient.rwth-aachen.de>
43 //             Mark Asbach       <asbach@ient.rwth-aachen.de>
44 //             Institute of Communications Engineering, RWTH Aachen University
45 %{
46         #include "pyhelpers.h"
47         #include "pycvseq.hpp"
48         #include "error.h"
49 %}
50
51
52 // direct SWIG to generate python docstrings
53 %feature("autodoc", 1);
54
55 // include python-specific files
56 %include "./nointpb.i"
57 %include "./pytypemaps.i"
58 %include "./cvshadow.i" 
59
60 // parse OpenCV headers
61 %include "../general/cv.i"
62
63 // Accessors for the CvMat and IplImage data structure are defined here
64 %include "./cvarr.i"
65
66 // Python sequence compatibility for CvSeq
67 %include "./cvseq.i"
68
69
70 %include "./imagedata.i"
71
72 // We integrate OpenCV error handling into the Python exception mechanism
73 %include "./error.h"
74
75
76 // include some wrappers to manipulate CvSeq types
77 %include "./pycvseq.hpp"
78
79 // aliases from #defines
80 %include "./cvaliases_autogen.i"
81 %include "./cvaliases.i"
82
83 %pythoncode 
84 %{
85
86 __doc__ = """
87 OpenCV is the Intel Open CV library, an open source effort to provide
88 computer vision algorithms for standard PC hardware.
89
90 This wrapper was semi-automatically created from the C/C++ headers and therefore
91 contains no Python documentation. Because all identifiers are identical to their
92 C/C++ counterparts, you can consult the standard manuals that come with OpenCV.
93 """
94
95 # this tells OpenCV not to call exit() on errors but throw a python exception instead
96 cvRedirectError(function_ptr_generator(), void_ptr_generator(), void_ptrptr_generator())
97
98 %}