vcs.maemo.org Git - opencv/blob - interfaces/matlab/src/funcs.h

   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 #ifndef FUNCS_H
  43 #define FUNCS_H
  44
  45
  46 #include "cv.h"
  47
  48 #include "qerr.h"
  49 #include "tmacro.h"
  50
  51 typedef enum {
  52         any, /* any type */
  53         row, /* only row */
  54         col, /* only column */
  55 } VecType; // vector type
  56
  57 /*F/////////////////////////////////////////////////////////////////////////////
  58 //  Name:        verifyDepth
  59 //  Purpose:     verify depth of image
  60 //  Parameters:
  61 //  Returns:
  62 //  Description: Depth is determined from classID and returned via
  63 //    depth parameter. If classID is not supported or bAnyDepth == false and
  64 //    determined depth is not equal to input desired depth then error is thrown.
  65 //
  66 //F*/
  67 void verifyDepth( mxClassID classID, bool bAnyDepth, int &depth );
  68
  69 /*F/////////////////////////////////////////////////////////////////////////////
  70 //  Name:        verifyArray
  71 //  Purpose:     verify mxArray
  72 //  Parameters:
  73 //  Returns:
  74 //  Description: If dims[i] > 0, then it is desired number of elements
  75 //    If dims[i] < 0, then it is filled with number of elements
  76 //    If ndim > 0 then it is desired number of dimensions, otherwise it is
  77 //    filled with number of dimensions.
  78 //
  79 //F*/
  80 void verifyArray( mxArray *mxArr, int *dims, int &ndim, bool bAllowEmpty,
  81                                   bool bAnyClass, mxClassID &classID );
  82
  83 void verifyMatrix( mxArray *mxArr, int &rows, int &cols, bool bAllowEmpty,
  84                                    bool bAnyClass, mxClassID &classID );
  85
  86 void verifyVector( mxArray *mxArr, int &num, VecType &type, bool bAllowEmpty,
  87                                    bool bAnyClass, mxClassID &classID );
  88
  89 void verifySeq( mxArray *mxArr, int maxIndex, int index,
  90                                 mxClassID &dataClass, void *&dataPtr, int &dataNum,
  91                                 CvRect &rect, int &type,
  92                                 int &h_prev, int &h_next, int &v_prev, int &v_next );
  93
  94 std::string get_string( const mxArray *mxArr );
  95
  96 #endif /* FUNCS_H */
  97