opencv.xml

Open CV Project for image processing in my College

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>openCV</name>
    </assembly>
    <members>
        <member name="F:openCV.cvlib.CV_LOAD_IMAGE_UNCHANGED">
            <summary>
            Left image unchanged
            </summary>
        </member>
        <member name="F:openCV.cvlib.CV_LOAD_IMAGE_GRAYSCALE">
            <summary>
            8 bit, gray
            </summary>
        </member>
        <member name="F:openCV.cvlib.CV_LOAD_IMAGE_COLOR">
            <summary>
            8 bit unless combined with CV_LOAD_IMAGE_ANYDEPTH, color
            </summary>
        </member>
        <member name="F:openCV.cvlib.CV_LOAD_IMAGE_ANYDEPTH">
            <summary>
            any depth, if specified on its own gray
            </summary>
        </member>
        <member name="F:openCV.cvlib.CV_LOAD_IMAGE_ANYCOLOR">
            <summary>
            by itself equivalent to CV_LOAD_IMAGE_UNCHANGED
            but can be modified with CV_LOAD_IMAGE_ANYDEPTH 
            </summary>
        </member>
        <member name="F:openCV.cvlib.CV_MAX_ARR">
            * Increments CvMat data reference counter */
        </member>
        <member name="F:openCV.cvlib.CV_GRAPH_VERTEX">
            * Retrieves index of a graph edge given its pointer */
        </member>
        <member name="F:openCV.cvlib.CV_DIST_USER">
            * get the next edge with the same origin point (counterwise) */
        </member>
        <member name="F:openCV.cvlib.CV_STORAGE_READ">
            * storage flags */
        </member>
        <member name="M:openCV.cvlib.CvCreateImage(openCV.CvSize,System.Int32,System.Int32)">
            <summary>
            Creates header and allocates data
            </summary>
            <param name="size">Image width and height.</param>
            <param name="depth">Bit depth of image elements. Can be one of:
            IPL_DEPTH_8U - uint 8-bit integers
            IPL_DEPTH_8S - signed 8-bit integers
            IPL_DEPTH_16U - uint 16-bit integers
            IPL_DEPTH_16S - signed 16-bit integers
            IPL_DEPTH_32S - signed 32-bit integers
            IPL_DEPTH_32F - single precision floating-point numbers
            IPL_DEPTH_64F - double precision floating-point numbers</param>
            <param name="channels">Number of channels per element(pixel). Can be 1, 2, 3 or 4. The channels are interleaved, for example the usual data layout of a color image is:
            b0 g0 r0 b1 g1 r1 ...
            Although in general IPL image format can store non-interleaved images as well and some of OpenCV can process it, this function can create interleaved images only.</param>
            <returns>IplImage</returns>
        </member>
        <member name="M:openCV.cvlib.CvCreateImageHeader(openCV.CvSize,System.Int32,System.Int32)">
            <summary>
            The function CvCreateImageHeader allocates, initializes, and
            returns the structure IplImage. This call is an analogue of
            iplCreateImageHeader( channels, 0, depth,
            channels == 1 ? "GRAY" : "RGB",
            channels == 1 ? "GRAY" : channels == 3 ? "BGR" :
            channels == 4 ? "BGRA" : "",
            IPL_DATA_ORDER_PIXEL, IPL_ORIGIN_TL, 4,
            size.width, size.height,0,0,0,0);
            though it does not use IPL functions by default
            (see also CV_TURN_ON_IPL_COMPATIBILITY macro)
            </summary>
            <param name="size">Image width and height.</param>
            <param name="depth">Image depth (see CreateImage).</param>
            <param name="channels">Number of channels (see CreateImage).</param>
            <returns>structure IplImage</returns>
        </member>
        <member name="M:openCV.cvlib.CvReleaseImageHeader(openCV.IplImage@)">
            <summary>
            The function CvReleaseImageHeader releases the header of a Image.
            </summary>
            <param name="image">ref to the deallocated header.</param>
        </member>
        <member name="M:openCV.cvlib.CvReleaseImage(openCV.IplImage@)">
            <summary>
            Releases header and image data
            The function CvReleaseImage releases the header and 
            the image data. This call is a shortened form of
            if( image.ptr != IntPtr.Zero )
            {
            cvReleaseData( ref image );
            cvReleaseImageHeader( ref image );
            }
            </summary>
            <param name="image">Reference to IplImage</param>
        </member>
        <member name="M:openCV.cvlib.CvInitImageHeader(openCV.IplImage@,openCV.CvSize,System.Int32,System.Int32,System.Int32,System.Int32)">
            <summary>
            The function cvInitImageHeader initializes the
            image header structure, pointer to which is passed by the user,
            and returns the pointer.
            </summary>
            <param name="image">Image header to initialize.</param>
            <param name="size">Image width and height.</param>
            <param name="depth">Image depth (see CreateImage).</param>
            <param name="channels">Number of channels (see CreateImage).</param>
            <param name="origin">IPL_ORIGIN_TL or IPL_ORIGIN_BL.</param>
            <param name="align">Alignment for image rows, typically 4 or 8 bytes.</param>
            <returns>pointer to passed image</returns>
        </member>
        <member name="M:openCV.cvlib.CvInitImageHeader(openCV.IplImage@,openCV.CvSize,System.Int32,System.Int32)">
            <summary>
            The function cvInitImageHeader initializes the
            image header structure, pointer to which is passed by the user,
            and returns the pointer.
            </summary>
            <param name="image">Image header to initialize.</param>
            <param name="size">Image width and height.</param>
            <param name="depth">Image depth (see CreateImage).</param>
            <param name="channels">Number of channels (see CreateImage).</param>
            <returns>pointer to passed image</returns>
        </member>
        <member name="M:openCV.cvlib.CvCloneImage(openCV.IplImage@)">
            <summary>
            Makes a full copy of image
            </summary>
            <param name="image">ref to IplImage</param>
            <returns>newly allocated image</returns>
        </member>
        <member name="M:openCV.cvlib.CvSetImageCOI(openCV.IplImage@,System.Int32)">
            <summary>
            The function cvSetImageCOI sets the channel of interest
            to a given value. Value 0 means that all channels are
            selected, 1 means that the first channel is selected etc.
            If ROI is NULL and coi != 0, ROI is allocated. Note that
            most of OpenCV functions do not support COI, so to process
            separate image/matrix channel one may copy
            (via cvCopy or cvSplit) the channel to separate
            image/matrix, process it and copy the result back
            (via cvCopy or cvCvtPlaneToPix) if need.
            </summary>
            <param name="image">reference to Image header.</param>
            <param name="coi">The coi.</param>
        </member>
        <member name="M:openCV.cvlib.CvGetImageCOI(openCV.IplImage@)">
            <summary>
            The function cvGetImageCOI returns channel of interest of 
            the image (it returns 0 if all the channels are selected).
            </summary>
            <param name="image">Reference to Image header. </param>
            <returns>channel of interest of the image (it returns 0 if 
            all the channels are selected)</returns>
        </member>
        <member name="M:openCV.cvlib.CvSetImageROI(openCV.IplImage@,openCV.CvRect)">
            <summary>
            The function cvSetImageROI sets the image ROI to a 
            given rectangle. If ROI is NULL and the value of the 
            parameter rect is not equal to the whole image, ROI 
            is allocated. Unlike COI, most of OpenCV functions do 
            support ROI and treat it in a way as it would be a 
            separate image (for example, all the pixel coordinates 
            are counted from top-left or bottom-left (depending on 
            the image origin) corner of ROI)
            </summary>
            <param name="image">Reference to Image header.</param>
            <param name="rect">ROI Rectangle</param>
        </member>
        <member name="M:openCV.cvlib.CvResetImageROI(openCV.IplImage@)">
            <summary>
            The function cvResetImageROI releases image ROI. After 
            that the whole image is considered selected.
            </summary>
            <param name="image">Image header</param>
        </member>
        <member name="M:openCV.cvlib.CvGetImageROI(openCV.IplImage@)">
            <summary>
            The function returns Roi of the channel of interest (coi).
            The rectangle cvRect(0,0,image.width,image.height)
            is returned if there is no ROI
            </summary>
            <param name="image">Image header.</param>
            <returns>Roi as Rectangle</returns>
        </member>
        <member name="M:openCV.cvlib.CvCreateMat(System.Int32,System.Int32,System.Int32)">
            <summary>
            The function cvCreateMat allocates header for the new matrix
            and underlying data, and returns a pointer to the created
            matrix. It is a short form for:
            CvMat mat = cvlib.CvCreateMatHeader( rows, cols, type );
            Matrices are stored row by row. All the rows are aligned by
            4 bytes.
            </summary>
            <param name="rows">Number of rows in the matrix.</param>
            <param name="cols">Number of columns in the matrix.</param>
            <param name="type">Type of the matrix elements. Usually it
            is specified in form CV_bit_depth(S|U|F)Cnumber_of_channels,
            for example: CV_8UC1 means an 8-bit unsigned single-channel
            matrix, CV_32SC2 means a 32-bit signed matrix with two
            channels.</param>
            <returns>Math Structure</returns>
        </member>
        <member name="M:openCV.cvlib.CvCreateMatHeader(System.Int32,System.Int32,System.Int32,System.IntPtr)">
            <summary>
            Creates new matrix header
            </summary>
            <param name="rows">N rows.</param>
            <param name="cols">M cols.</param>
            <param name="type">type of Matrix.</param>
            <param name="data">Initializing data or zero.</param>
            <returns>CvMat</returns>
        </member>
        <member name="M:openCV.cvlib.CvReleaseMat(openCV.CvMat@)">
            <summary>
            Deallocates matrix 
            </summary>
            <param name="mat">Matrix to deallocate</param>
        </member>
        <member name="M:openCV.cvlib.CvInitMatHeader(openCV.CvMat@,System.Int32,System.Int32,System.Int32,System.IntPtr,System.Int32)">
            <summary>
            Initializes matrix header
            </summary>
            <param name="mat">The matrix.</param>
            <param name="rows">N rows.</param>
            <param name="cols">M cols.</param>
            <param name="type">The type of the matrix.</param>
            <param name="data">Data or zero.
            Create a Array with data and use cvtools for creating the IntPtr.
            </param>
            <param name="step">Stepsize.</param>
            <returns>CvMat</returns>
        </member>
        <member name="M:openCV.cvlib.CvCloneMat(openCV.CvMat@)">
            <summary>
            Creates matrix copy 
            </summary>
            <param name="mat">Matrix to clone</param>
            <returns>Cloned Matrix</returns>
        </member>
        <member name="M:openCV.cvlib.CvCreateMatND(System.Int32,System.Int32[],System.Int32)">
            <summary>
            Creates multi-dimensional dense array
            </summary>
            <param name="dims">Number of array dimensions. 
            It must not exceed CV_MAX_DIM (=32 by default, though 
            it may be changed at build time)</param>
            <param name="sizes">Array of dimension sizes.</param>
            <param name="type">Type of array elements. The same as for CvMat.</param>
            <returns>CvMatND</returns>
        </member>
        <member name="M:openCV.cvlib.CvCreateMatNDHeader(System.Int32,System.Int32[],System.Int32)">
            <summary>
            Creates new matrix header
            </summary>
            <param name="dims">Number of dimension.</param>
            <param name="sizes">Array of sizes of the dimensions.</param>
            <param name="type">Type of array elements. The same as for CvMat.</param>
            <returns>CvMatND</returns>
        </member>
        <member name="M:openCV.cvlib.CvReleaseMatND(openCV.CvMatND@)">
            <summary>
            Deallocates multi-dimensional array 
            </summary>
            <param name="mat">The Natrix to deallocate</param>
        </member>
        <member name="M:openCV.cvlib.CvInitMatNDHeader(openCV.CvMatND@,System.Int32,System.Int32[],System.Int32,System.IntPtr)">
            <summary>
            Initializes multi-dimensional array header
            </summary>
            <param name="mat">The Matrix.</param>
            <param name="dims">Number of dimensions.</param>
            <param name="sizes">Array of dimension sizes.</param>
            <param name="type">Type of array elements. The same as for CvMat.</param>
            <param name="data">Optional data pointer assigned to the matrix header.
            Create a Array with data and use cvtools for creating the IntPtr.</param>
            <returns>CvMatND</returns>
        </member>
        <member name="M:openCV.cvlib.CvCloneMatND(openCV.CvMatND@)">
            <summary>
            Creates full copy of multi-dimensional array 
            </summary>
            <param name="mat">Array header.</param>
            <returns>CvMatND</returns>
        </member>
        <member name="M:openCV.cvlib.CvDecRefData(openCV.IplImage@)">
            <summary>
            Decrements array data reference counter 
            </summary>
            <param name="arr">Array header.</param>
        </member>
        <member name="M:openCV.cvlib.CvIncRefData(openCV.IplImage@)">
            <summary>
            Increments array data reference counter 
            </summary>
            <param name="arr">Array header.</param>
        </member>
        <member name="M:openCV.cvlib.CvCreateData(openCV.IplImage@)">
            <summary>
            Allocates array data