Browse Source

Documentation improvements.

pull/348/merge
Canming Huang 5 years ago
parent
commit
6fb83f61b3
  1. 1
      Emgu.CV.Cuda/CudaInvoke.cs
  2. 14
      Emgu.CV.Cuda/Imgproc/CudaHarrisCorner.cs
  3. 5
      Emgu.CV.Platform/DotNet/Operation.cs
  4. 6
      Emgu.CV.Platform/Emgu.CV.Bitmap/BitmapExtension.cs
  5. 1
      Emgu.CV/PInvoke/CvInvokeCore.cs
  6. 1
      Emgu.CV/PInvoke/CvInvokeImgproc.cs
  7. 8
      Emgu.CV/Stitching/ExposureCompensator.cs
  8. 1
      Emgu.CV/Superres/FrameSource.cs
  9. 1
      Emgu.CV/Videoio/VideoCapture.cs
  10. 6
      miscellaneous/Emgu.CV.html.shfbproj

1
Emgu.CV.Cuda/CudaInvoke.cs

@ -1029,6 +1029,7 @@ namespace Emgu.CV.Cuda
/// <param name="maxValue">Maximum value to use with CV_THRESH_BINARY and CV_THRESH_BINARY_INV thresholding types</param>
/// <param name="thresholdType">Thresholding type</param>
/// <param name="stream">Use a Stream to call the function asynchronously (non-blocking) or null to call the function synchronously (blocking).</param>
/// <returns>The computed threshold value if Otsu's or Triangle methods used.</returns>
public static double Threshold(IInputArray src, IOutputArray dst, double threshold, double maxValue, CvEnum.ThresholdType thresholdType, Stream stream = null)
{
using (InputArray iaSrc = src.GetInputArray())

14
Emgu.CV.Cuda/Imgproc/CudaHarrisCorner.cs

@ -26,11 +26,17 @@ namespace Emgu.CV.Cuda
/// </summary>
/// <param name="srcDepth">The depth of the source image</param>
/// <param name="srcChannels">The number of channels in the source image</param>
/// <param name="blockSize">Neighborhood size </param>
/// <param name="kSize"></param>
/// <param name="blockSize">Neighborhood size.</param>
/// <param name="kSize">Kernel size</param>
/// <param name="k">Harris detector free parameter.</param>
/// <param name="borderType">Boreder type, use REFLECT101 for default</param>
public CudaHarrisCorner(DepthType srcDepth, int srcChannels, int blockSize, int kSize, double k, CvEnum.BorderType borderType = BorderType.Default)
/// <param name="borderType">Border type.</param>
public CudaHarrisCorner(
DepthType srcDepth,
int srcChannels,
int blockSize,
int kSize,
double k,
CvEnum.BorderType borderType = BorderType.Default)
{
_ptr = CudaInvoke.cudaCreateHarrisCorner(CvInvoke.MakeType(srcDepth, srcChannels), blockSize, kSize, k, borderType, ref _sharedPtr);
}

5
Emgu.CV.Platform/DotNet/Operation.cs

@ -51,7 +51,7 @@ namespace Emgu.CV.UI
/// Call the specific method with the specific parameters on the provided <paramref name="instance"/>
/// </summary>
/// <param name="instance">The instance to call the method</param>
/// <returns></returns>
/// <returns>The result from invoking the specific method.</returns>
public Object InvokeMethod(Object instance)
{
if (!_mi.ContainsGenericParameters)
@ -76,7 +76,7 @@ namespace Emgu.CV.UI
/// <summary>
/// Represent this operation as a string
/// </summary>
/// <returns></returns>
/// <returns>The String representation of the operation</returns>
public override string ToString()
{
return String.Format(
@ -89,6 +89,7 @@ namespace Emgu.CV.UI
/// <summary>
/// Represent this operation as code
/// </summary>
/// <param name="language">The programming language</param>
/// <returns>The source code</returns>
public String ToCode(ProgrammingLanguage language)
{

6
Emgu.CV.Platform/Emgu.CV.Bitmap/BitmapExtension.cs

@ -83,7 +83,7 @@ namespace Emgu.CV
/// <param name="numberOfChannels">The number of channels</param>
/// <param name="srcDepthType">The source image depth type</param>
/// <param name="tryDataSharing">Try to create Bitmap that shares the data with the image</param>
/// <returns>The Bitmap</returns>
/// <returns>A bitmap representation of the image.</returns>
public static Bitmap RawDataToBitmap(IntPtr scan0, int step, Size size, Type srcColorType, int numberOfChannels,
Type srcDepthType, bool tryDataSharing = false)
{
@ -206,6 +206,7 @@ namespace Emgu.CV
/// <summary>
/// Convert the mat into Bitmap, the pixel values are copied over to the Bitmap
/// </summary>
/// <returns>A bitmap representation of the image.</returns>
public static Bitmap ToBitmap(this Mat mat)
{
if (mat.Dims > 3)
@ -266,6 +267,7 @@ namespace Emgu.CV
/// <summary>
/// Convert the gpuMat into Bitmap, the pixel values are copied over to the Bitmap
/// </summary>
/// <returns>A bitmap representation of the image.</returns>
public static Bitmap ToBitmap(this GpuMat gpuMat)
{
using (Mat tmp = new Mat())
@ -280,6 +282,7 @@ namespace Emgu.CV
/// </summary>
/// <typeparam name="TColor">The color type of the Image</typeparam>
/// <typeparam name="TDepth">The depth type of the Image</typeparam>
/// <returns>The Image &lt; TColor, TDepth &gt; converted from Bitmap</returns>
public static Image<TColor, TDepth> ToImage<TColor, TDepth>(this Bitmap bitmap) where
TColor : struct, IColor
where TDepth : new()
@ -594,6 +597,7 @@ namespace Emgu.CV
/// </summary>
/// <typeparam name="TColor">The color type of the CudaImage</typeparam>
/// <typeparam name="TDepth">The depth type of the CudaImage</typeparam>
/// <returns> This image in Bitmap format, the pixel data are copied over to the Bitmap</returns>
public static Bitmap ToBitmap<TColor, TDepth>(this CudaImage<TColor, TDepth> cudaImage) where
TColor : struct, IColor
where TDepth : new()

1
Emgu.CV/PInvoke/CvInvokeCore.cs

@ -848,6 +848,7 @@ namespace Emgu.CV
/// <param name="coeffs">The (degree + 1)-length array of equation coefficients (CV_32FC1 or CV_64FC1)</param>
/// <param name="roots">The degree-length output array of real or complex roots (CV_32FC2 or CV_64FC2)</param>
/// <param name="maxiter">The maximum number of iterations</param>
/// <returns>The max difference.</returns>
public static double SolvePoly(IInputArray coeffs, IOutputArray roots, int maxiter = 300)
{
using (InputArray iaCoeffs = coeffs.GetInputArray())

1
Emgu.CV/PInvoke/CvInvokeImgproc.cs

@ -1344,6 +1344,7 @@ namespace Emgu.CV
/// <param name="threshold">Threshold value</param>
/// <param name="maxValue">Maximum value to use with CV_THRESH_BINARY and CV_THRESH_BINARY_INV thresholding types</param>
/// <param name="thresholdType">Thresholding type </param>
/// <returns>The computed threshold value if Otsu's or Triangle methods used.</returns>
public static double Threshold(
IInputArray src,
IOutputArray dst,

8
Emgu.CV/Stitching/ExposureCompensator.cs

@ -75,7 +75,7 @@ namespace Emgu.CV.Stitching
/// <summary>
/// Create a new gain compensator
/// </summary>
/// <param name="nrFeeds"></param>
/// <param name="nrFeeds">nr feeds</param>
public GainCompensator(int nrFeeds)
{
_ptr = StitchingInvoke.cveGainCompensatorCreate(nrFeeds, ref _exposureCompensatorPtr);
@ -102,7 +102,7 @@ namespace Emgu.CV.Stitching
/// <summary>
/// Create a new exposure compensator
/// </summary>
/// <param name="nrFeeds"></param>
/// <param name="nrFeeds">nr feeds</param>
public ChannelsCompensator(int nrFeeds)
{
_ptr = StitchingInvoke.cveChannelsCompensatorCreate(nrFeeds, ref _exposureCompensatorPtr);
@ -152,7 +152,7 @@ namespace Emgu.CV.Stitching
/// </summary>
/// <param name="blWidth">block width</param>
/// <param name="blHeight">block height</param>
/// <param name="nrFeeds"></param>
/// <param name="nrFeeds">nr feeds</param>
public BlocksGainCompensator(int blWidth = 32, int blHeight = 32, int nrFeeds = 1)
{
_ptr = StitchingInvoke.cveBlocksGainCompensatorCreate(blWidth, blHeight, nrFeeds,
@ -183,7 +183,7 @@ namespace Emgu.CV.Stitching
/// </summary>
/// <param name="blWidth">Block width</param>
/// <param name="blHeight">Block height</param>
/// <param name="nrFeeds"></param>
/// <param name="nrFeeds">nr feeds</param>
public BlocksChannelsCompensator(int blWidth = 32, int blHeight = 32, int nrFeeds = 1)
{
_ptr = StitchingInvoke.cveBlocksChannelsCompensatorCreate(blWidth, blHeight, nrFeeds,

1
Emgu.CV/Superres/FrameSource.cs

@ -62,6 +62,7 @@ namespace Emgu.CV.Superres
/// <summary>
/// Get the next frame
/// </summary>
/// <param name="frame">The output array to put the frame to</param>
public void NextFrame(IOutputArray frame)
{
using (OutputArray oaFrame = frame.GetOutputArray())

1
Emgu.CV/Videoio/VideoCapture.cs

@ -522,6 +522,7 @@ namespace Emgu.CV
/// First call Grab() function follows by Retrieve()
/// </summary>
/// <param name="m">The output array where the image will be read into.</param>
/// <returns>False if no frames has been grabbed</returns>
public bool Read(IOutputArray m)
{
using (OutputArray oaM = m.GetOutputArray())

6
miscellaneous/Emgu.CV.html.shfbproj

@ -43,7 +43,7 @@
<DocumentationSource sourceFile="..\Solution\Windows.Desktop\Emgu.CV.sln" />
</DocumentationSources>
<NamespaceSummaries>
<NamespaceSummaryItem name="(global)" isDocumented="True">Emgu CV is a cross platform .Net wrapper to the OpenCV image processing library. Allowing OpenCV functions to be called from .NET compatible languages such as C#, VB, VC++, IronPython etc. The wrapper can be compiled in Mono and run on Windows, Linux, Mac OS X, iPhone, iPad and Android devices.</NamespaceSummaryItem>
<NamespaceSummaryItem name="(global)" isDocumented="True">Emgu CV is a cross platform .Net wrapper to the OpenCV image processing library. Allowing OpenCV functions to be called from .NET compatible languages such as C#, VB, VC++, IronPython etc. The wrapper can be compiled in Mono and run on Windows, Linux, Mac OS, iPhone, iPad and Android devices.</NamespaceSummaryItem>
<NamespaceSummaryItem name="Emgu" isDocumented="True">Root namespace for class and functions implemented by Emgu</NamespaceSummaryItem>
<NamespaceSummaryItem name="Emgu.CV" isDocumented="True">Wrapper of OpenCV's image processing functions.
Base functions (L1) can be found in CvInvoke class</NamespaceSummaryItem>
@ -66,7 +66,6 @@ Base functions (L1) can be found in CvInvoke class</NamespaceSummaryItem>
<NamespaceSummaryItem name="Emgu.CV.Tiff" isDocumented="True">Contains writer classes that can be used to write different tiff formats, such as tile tiff and geotiff.</NamespaceSummaryItem>
<NamespaceSummaryItem name="Emgu.CV.Util" isDocumented="True">A collection of utilities used by Emgu.CV projects</NamespaceSummaryItem>
<NamespaceSummaryItem name="Emgu.CV.OCR" isDocumented="True">Optical character recognition. Wraps the tesseract-ocr engine.</NamespaceSummaryItem>
<NamespaceSummaryItem name="Emgu.CV.Cvb" isDocumented="True">Contains interface for the CvBlob library</NamespaceSummaryItem>
<NamespaceSummaryItem name="Emgu.CV.Stitching" isDocumented="True">Image stitching</NamespaceSummaryItem>
<NamespaceSummaryItem name="Emgu.CV.VideoStab" isDocumented="True">The video stabilization module contains a set of functions and classes that can be used to solve the problem of video stabilization.</NamespaceSummaryItem>
<NamespaceSummaryItem name="Emgu.CV.OpenCL" isDocumented="True">Computer vision using OpenCL</NamespaceSummaryItem>
@ -97,6 +96,9 @@ Base functions (L1) can be found in CvInvoke class</NamespaceSummaryItem>
<NamespaceSummaryItem name="Emgu.CV.PpfMatch3d" isDocumented="True">Surface Matching module</NamespaceSummaryItem>
<NamespaceSummaryItem name="Emgu.CV.Rapid" isDocumented="True">Silhouette based 3D object tracking</NamespaceSummaryItem>
<NamespaceSummaryItem name="Emgu.CV.IntensityTransform" isDocumented="True">The module brings implementations of intensity transformation algorithms to adjust image contrast.</NamespaceSummaryItem>
<NamespaceSummaryItem name="Emgu.CV.Alphamat" isDocumented="True">Information Flow algorithm implementaton for alphamatting</NamespaceSummaryItem>
<NamespaceSummaryItem name="Emgu.CV.Quality" isDocumented="True">Image Quality Analysis (IQA) API</NamespaceSummaryItem>
<NamespaceSummaryItem name="Emgu.CV.Stereo" isDocumented="True">Stereo API</NamespaceSummaryItem>
</NamespaceSummaries>
<PlugInConfigurations>
</PlugInConfigurations>

Loading…
Cancel
Save