plot.hpp 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120
  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. // License Agreement
  11. // For Open Source Computer Vision Library
  12. //
  13. // Copyright (C) 2000-2008, Intel Corporation, all rights reserved.
  14. // Copyright (C) 2009-2012, Willow Garage Inc., all rights reserved.
  15. // Third party copyrights are property of their respective owners.
  16. //
  17. // Redistribution and use in source and binary forms, with or without modification,
  18. // are permitted provided that the following conditions are met:
  19. //
  20. // * Redistribution's of source code must retain the above copyright notice,
  21. // this list of conditions and the following disclaimer.
  22. //
  23. // * Redistribution's in binary form must reproduce the above copyright notice,
  24. // this list of conditions and the following disclaimer in the documentation
  25. // and/or other materials provided with the distribution.
  26. //
  27. // * The name of the copyright holders may not be used to endorse or promote products
  28. // derived from this software without specific prior written permission.
  29. //
  30. // This software is provided by the copyright holders and contributors "as is" and
  31. // any express or implied warranties, including, but not limited to, the implied
  32. // warranties of merchantability and fitness for a particular purpose are disclaimed.
  33. // In no event shall the Intel Corporation or contributors be liable for any direct,
  34. // indirect, incidental, special, exemplary, or consequential damages
  35. // (including, but not limited to, procurement of substitute goods or services;
  36. // loss of use, data, or profits; or business interruption) however caused
  37. // and on any theory of liability, whether in contract, strict liability,
  38. // or tort (including negligence or otherwise) arising in any way out of
  39. // the use of this software, even if advised of the possibility of such damage.
  40. //
  41. //M*/
  42. //################################################################################
  43. //
  44. // Created by Nuno Moutinho
  45. //
  46. //################################################################################
  47. #ifndef _OPENCV_PLOT_H_
  48. #define _OPENCV_PLOT_H_
  49. #ifdef __cplusplus
  50. #include <opencv2/core.hpp>
  51. /**
  52. @defgroup plot Plot function for Mat data
  53. */
  54. namespace cv
  55. {
  56. namespace plot
  57. {
  58. //! @addtogroup plot
  59. //! @{
  60. class CV_EXPORTS_W Plot2d : public Algorithm
  61. {
  62. public:
  63. CV_WRAP virtual void setMinX(double _plotMinX) = 0;
  64. CV_WRAP virtual void setMinY(double _plotMinY) = 0;
  65. CV_WRAP virtual void setMaxX(double _plotMaxX) = 0;
  66. CV_WRAP virtual void setMaxY(double _plotMaxY) = 0;
  67. CV_WRAP virtual void setPlotLineWidth(int _plotLineWidth) = 0;
  68. /**
  69. * @brief Switches data visualization mode
  70. *
  71. * @param _needPlotLine if true then neighbour plot points will be connected by lines.
  72. * In other case data will be plotted as a set of standalone points.
  73. */
  74. CV_WRAP virtual void setNeedPlotLine(bool _needPlotLine) = 0;
  75. CV_WRAP virtual void setPlotLineColor(Scalar _plotLineColor) = 0;
  76. CV_WRAP virtual void setPlotBackgroundColor(Scalar _plotBackgroundColor) = 0;
  77. CV_WRAP virtual void setPlotAxisColor(Scalar _plotAxisColor) = 0;
  78. CV_WRAP virtual void setPlotGridColor(Scalar _plotGridColor) = 0;
  79. CV_WRAP virtual void setPlotTextColor(Scalar _plotTextColor) = 0;
  80. CV_WRAP virtual void setPlotSize(int _plotSizeWidth, int _plotSizeHeight) = 0;
  81. CV_WRAP virtual void setShowGrid(bool needShowGrid) = 0;
  82. CV_WRAP virtual void setShowText(bool needShowText) = 0;
  83. CV_WRAP virtual void setGridLinesNumber(int gridLinesNumber) = 0;
  84. CV_WRAP virtual void setInvertOrientation(bool _invertOrientation) = 0;
  85. /**
  86. * @brief Sets the index of a point which coordinates will be printed on the top left corner of the plot (if ShowText flag is true).
  87. *
  88. * @param pointIdx index of the required point in data array.
  89. */
  90. CV_WRAP virtual void setPointIdxToPrint(int pointIdx) = 0;
  91. CV_WRAP virtual void render(OutputArray _plotResult) = 0;
  92. /**
  93. * @brief Creates Plot2d object
  94. *
  95. * @param data \f$1xN\f$ or \f$Nx1\f$ matrix containing \f$Y\f$ values of points to plot. \f$X\f$ values
  96. * will be equal to indexes of correspondind elements in data matrix.
  97. */
  98. CV_WRAP static Ptr<Plot2d> create(InputArray data);
  99. /**
  100. * @brief Creates Plot2d object
  101. *
  102. * @param dataX \f$1xN\f$ or \f$Nx1\f$ matrix \f$X\f$ values of points to plot.
  103. * @param dataY \f$1xN\f$ or \f$Nx1\f$ matrix containing \f$Y\f$ values of points to plot.
  104. */
  105. CV_WRAP static Ptr<Plot2d> create(InputArray dataX, InputArray dataY);
  106. };
  107. //! @}
  108. }
  109. }
  110. #endif
  111. #endif