Emgu.CV.Bitmap.xml 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Emgu.CV.Bitmap</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Emgu.CV.BitmapExtension">
  8. <summary>
  9. Provide extension method to convert IInputArray to and from Bitmap
  10. </summary>
  11. </member>
  12. <member name="F:Emgu.CV.BitmapExtension.GrayscalePalette">
  13. <summary>
  14. The ColorPalette of Grayscale for Bitmap Format8bppIndexed
  15. </summary>
  16. </member>
  17. <member name="M:Emgu.CV.BitmapExtension.ColorPaletteToLookupTable(System.Drawing.Imaging.ColorPalette,Emgu.CV.Matrix{System.Byte}@,Emgu.CV.Matrix{System.Byte}@,Emgu.CV.Matrix{System.Byte}@,Emgu.CV.Matrix{System.Byte}@)">
  18. <summary>
  19. Convert the color palette to four lookup tables
  20. </summary>
  21. <param name="palette">The color palette to transform</param>
  22. <param name="bTable">Lookup table for the B channel</param>
  23. <param name="gTable">Lookup table for the G channel</param>
  24. <param name="rTable">Lookup table for the R channel</param>
  25. <param name="aTable">Lookup table for the A channel</param>
  26. </member>
  27. <member name="M:Emgu.CV.BitmapExtension.RawDataToBitmap(System.IntPtr,System.Int32,System.Drawing.Size,System.Type,System.Int32,System.Type,System.Boolean)">
  28. <summary>
  29. Convert raw data to bitmap
  30. </summary>
  31. <param name="scan0">The pointer to the raw data</param>
  32. <param name="step">The step</param>
  33. <param name="size">The size of the image</param>
  34. <param name="srcColorType">The source image color type</param>
  35. <param name="numberOfChannels">The number of channels</param>
  36. <param name="srcDepthType">The source image depth type</param>
  37. <param name="tryDataSharing">Try to create Bitmap that shares the data with the image</param>
  38. <returns>A bitmap representation of the image.</returns>
  39. </member>
  40. <member name="M:Emgu.CV.BitmapExtension.ToBitmap(Emgu.CV.Mat)">
  41. <summary>
  42. Convert the mat into Bitmap, the pixel values are copied over to the Bitmap
  43. </summary>
  44. <param name="mat">The Mat to be converted to Bitmap</param>
  45. <returns>A bitmap representation of the image.</returns>
  46. </member>
  47. <member name="M:Emgu.CV.BitmapExtension.ToBitmap(Emgu.CV.UMat)">
  48. <summary>
  49. Convert the umat into Bitmap, the pixel values are copied over to the Bitmap
  50. </summary>
  51. <param name="umat">The UMat to be converted to Bitmap</param>
  52. </member>
  53. <member name="M:Emgu.CV.BitmapExtension.ToBitmap(Emgu.CV.Cuda.GpuMat)">
  54. <summary>
  55. Convert the gpuMat into Bitmap, the pixel values are copied over to the Bitmap
  56. </summary>
  57. <param name="gpuMat">The gpu mat to be converted to Bitmap</param>
  58. <returns>A bitmap representation of the image.</returns>
  59. </member>
  60. <member name="M:Emgu.CV.BitmapExtension.ToImage``2(System.Drawing.Bitmap)">
  61. <summary>
  62. Create an Image &lt; TColor, TDepth &gt; from Bitmap
  63. </summary>
  64. <param name="bitmap">The Bitmap to be converted to Image &lt; TColor, TDepth &gt;</param>
  65. <typeparam name="TColor">The color type of the Image</typeparam>
  66. <typeparam name="TDepth">The depth type of the Image</typeparam>
  67. <returns>The Image &lt; TColor, TDepth &gt; converted from Bitmap</returns>
  68. </member>
  69. <member name="M:Emgu.CV.BitmapExtension.CopyFromBitmap``2(Emgu.CV.Image{``0,``1},System.Drawing.Bitmap)">
  70. <summary>
  71. Utility function for converting Bitmap to Image
  72. </summary>
  73. <param name="bmp">the bitmap to copy data from</param>
  74. <param name="image">The image to copy data to</param>
  75. <typeparam name="TColor">The color type of the Image</typeparam>
  76. <typeparam name="TDepth">The depth type of the Image</typeparam>
  77. </member>
  78. <member name="M:Emgu.CV.BitmapExtension.AsBitmap``2(Emgu.CV.Image{``0,``1})">
  79. <summary>
  80. Provide a more efficient way to convert Image&lt;Gray, Byte&gt;, Image&lt;Bgr, Byte&gt; and Image&lt;Bgra, Byte&gt; into Bitmap
  81. such that the image data is <b>shared</b> with Bitmap.
  82. If you change the pixel value on the Bitmap, you change the pixel values on the Image object as well!
  83. For other types of image this property has the same effect as ToBitmap()
  84. <b>Take extra caution not to use the Bitmap after the Image object is disposed</b>
  85. </summary>
  86. <typeparam name="TColor">The color of the image</typeparam>
  87. <typeparam name="TDepth">The depth of the image</typeparam>
  88. <param name="image">The image to create Bitmap from</param>
  89. <returns>A bitmap representation of the image. In the cases of Image&lt;Gray, Byte&gt;, Image&lt;Bgr, Byte&gt; and Image&lt;Bgra, Byte&gt;, the image data is shared between the Bitmap and the Image object.</returns>
  90. </member>
  91. <member name="M:Emgu.CV.BitmapExtension.ToBitmap``2(Emgu.CV.Image{``0,``1})">
  92. <summary>
  93. Convert this image into Bitmap, the pixel values are copied over to the Bitmap
  94. </summary>
  95. <typeparam name="TColor">The color type of the Image</typeparam>
  96. <typeparam name="TDepth">The depth type of the Image</typeparam>
  97. <param name="image">The image to be converted to Bitmap</param>
  98. <remarks> For better performance on Image&lt;Gray, Byte&gt; and Image&lt;Bgr, Byte&gt;, consider using the Bitmap property </remarks>
  99. <returns> This image in Bitmap format, the pixel data are copied over to the Bitmap</returns>
  100. </member>
  101. <member name="M:Emgu.CV.BitmapExtension.ToBitmap``2(Emgu.CV.Image{``0,``1},System.Int32,System.Int32)">
  102. <summary> Create a Bitmap image of certain size</summary>
  103. <param name="image">The image to be converted to Bitmap</param>
  104. <param name="width">The width of the bitmap</param>
  105. <param name="height"> The height of the bitmap</param>
  106. <typeparam name="TColor">The color type of the Image</typeparam>
  107. <typeparam name="TDepth">The depth type of the Image</typeparam>
  108. <returns> This image in Bitmap format of the specific size</returns>
  109. </member>
  110. <member name="M:Emgu.CV.BitmapExtension.ToBitmap``2(Emgu.CV.Cuda.CudaImage{``0,``1})">
  111. <summary>
  112. Convert the CudaImage to its equivalent Bitmap representation
  113. </summary>
  114. <param name="cudaImage">The cuda image to be converted to Bitmap</param>
  115. <typeparam name="TColor">The color type of the CudaImage</typeparam>
  116. <typeparam name="TDepth">The depth type of the CudaImage</typeparam>
  117. <returns> This image in Bitmap format, the pixel data are copied over to the Bitmap</returns>
  118. </member>
  119. <member name="T:Emgu.CV.BitmapFileReaderMat">
  120. <summary>
  121. Class that can be used to read file into Mat
  122. </summary>
  123. </member>
  124. <member name="M:Emgu.CV.BitmapFileReaderMat.ReadFile(System.String,Emgu.CV.Mat,Emgu.CV.CvEnum.ImreadModes)">
  125. <summary>
  126. Read the file into a Mat
  127. </summary>
  128. <param name="fileName">The name of the image file</param>
  129. <param name="mat">The Mat to read into</param>
  130. <param name="loadType">Image load type.</param>
  131. <returns>True if the file can be read into the Mat</returns>
  132. </member>
  133. <member name="T:Emgu.CV.BitmapFileWriterMat">
  134. <summary>
  135. Class that can be used to write the Mat to a file
  136. </summary>
  137. </member>
  138. <member name="M:Emgu.CV.BitmapFileWriterMat.WriteFile(Emgu.CV.Mat,System.String)">
  139. <summary>
  140. Write the Mat into the file
  141. </summary>
  142. <param name="mat">The Mat to write</param>
  143. <param name="fileName">The name of the file to be written into</param>
  144. <returns>True if the file has been written into Mat</returns>
  145. </member>
  146. </members>
  147. </doc>