PageRenderTime 60ms CodeModel.GetById 29ms RepoModel.GetById 0ms app.codeStats 0ms

/reprap_python_beanshell/documentation/skeinforge_tools.analyze_plugins.statistic.html

https://github.com/TeamTeamUSA/SkeinFox
HTML | 143 lines | 123 code | 20 blank | 0 comment | 0 complexity | 919b805b2c11cd4d5f09c19e7d9516e9 MD5 | raw file
    

  1. 

  2. <!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
    3. 

  3. <html><head><title>Python: module skeinforge_tools.analyze_plugins.statistic</title>
    4. 

  4. </head><body bgcolor="#f0f0f8">
    5. 

  5. 

  6. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
    7. 

  7. <tr bgcolor="#7799ee">
    8. 

  8. <td valign=bottom>&nbsp;<br>
    9. 

  9. <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="skeinforge_tools.html"><font color="#ffffff">skeinforge_tools</font></a>.<a href="skeinforge_tools.analyze_plugins.html"><font color="#ffffff">analyze_plugins</font></a>.statistic</strong></big></big> ($Date: 2008/21/04 $)</font></td
    10. 

  10. ><td align=right valign=bottom
    11. 

  11. ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/enrique/Desktop/backup/babbleold/script/reprap/pyRepRap/skeinforge_tools/analyze_plugins/statistic.py">/home/enrique/Desktop/backup/babbleold/script/reprap/pyRepRap/skeinforge_tools/analyze_plugins/statistic.py</a></font></td></tr></table>
    12. 

  12.     <p><tt>Statistic is a script to generate statistics a gcode file.<br>
    13. 

  13.  <br>
    14. 

  14. The default 'Activate Statistic' checkbox is on.  When it is on, the functions described below will work when called from the skeinforge toolchain, when it is off, the functions will not be called from the toolchain.  The functions will still be called, whether or not the 'Activate Statistic' checkbox is on, when statistic is run directly.<br>
    15. 

  15.  <br>
    16. 

  16. When the 'Print Statistics' checkbox is on, the statistics will be printed to the console, the default is on.  When the 'Save Statistics' checkbox is on, the statistics will be save as a .txt file, the default is off.<br>
    17. 

  17.  <br>
    18. 

  18. To run statistic, in a shell in the folder which statistic is in type:<br>
    19. 

  19. &gt; python statistic.py<br>
    20. 

  20.  <br>
    21. 

  21. An explanation of the gcodes is at:<br>
    22. 

  22. <a href="http://reprap.org/bin/view/Main/Arduino_GCode_Interpreter">http://reprap.org/bin/view/Main/Arduino_GCode_Interpreter</a><br>
    23. 

  23.  <br>
    24. 

  24. and at:<br>
    25. 

  25. <a href="http://reprap.org/bin/view/Main/MCodeReference">http://reprap.org/bin/view/Main/MCodeReference</a><br>
    26. 

  26.  <br>
    27. 

  27. A gode example is at:<br>
    28. 

  28. <a href="http://forums.reprap.org/file.php?12,file=565">http://forums.reprap.org/file.php?12,file=565</a><br>
    29. 

  29.  <br>
    30. 

  30. This example generates statistics for the gcode file Screw Holder_comb.gcode.  This example is run in a terminal in the folder which contains Screw Holder_comb.gcode and statistic.py.<br>
    31. 

  31.  <br>
    32. 

  32.  <br>
    33. 

  33. &gt; python<br>
    34. 

  34. Python 2.5.1 (r251:54863, Sep 22 2007, 01:43:31)<br>
    35. 

  35. [GCC 4.2.1 (SUSE Linux)] on linux2<br>
    36. 

  36. Type "help", "copyright", "credits" or "license" for more information.<br>
    37. 

  37. &gt;&gt;&gt; import statistic<br>
    38. 

  38. &gt;&gt;&gt; statistic.<a href="#-main">main</a>()<br>
    39. 

  39. This brings up the statistic dialog.<br>
    40. 

  40.  <br>
    41. 

  41.  <br>
    42. 

  42. &gt;&gt;&gt; statistic.<a href="#-statisticFile">statisticFile</a>()<br>
    43. 

  43. The statistics file is saved as Screw Holder_comb_statistic.gcode</tt></p>
    44. 

  44. <p>
    45. 

  45. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    46. 

  46. <tr bgcolor="#aa55cc">
    47. 

  47. <td colspan=3 valign=bottom>&nbsp;<br>
    48. 

  48. <font color="#fffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
    49. 

  49.     
    50. 

  50. <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    51. 

  51. <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="__init__.html">__init__</a><br>
    52. 

  52. <a href="cStringIO.html">cStringIO</a><br>
    53. 

  53. </td><td width="25%" valign=top><a href="skeinforge_tools.skeinforge_utilities.euclidean.html">skeinforge_tools.skeinforge_utilities.euclidean</a><br>
    54. 

  54. <a href="skeinforge_tools.skeinforge_utilities.gcodec.html">skeinforge_tools.skeinforge_utilities.gcodec</a><br>
    55. 

  55. </td><td width="25%" valign=top><a href="math.html">math</a><br>
    56. 

  56. <a href="skeinforge_tools.polyfile.html">skeinforge_tools.polyfile</a><br>
    57. 

  57. </td><td width="25%" valign=top><a href="skeinforge_tools.skeinforge_utilities.preferences.html">skeinforge_tools.skeinforge_utilities.preferences</a><br>
    58. 

  58. <a href="sys.html">sys</a><br>
    59. 

  59. </td></tr></table></td></tr></table><p>
    60. 

  60. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    61. 

  61. <tr bgcolor="#ee77aa">
    62. 

  62. <td colspan=3 valign=bottom>&nbsp;<br>
    63. 

  63. <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
    64. 

  64.     
    65. 

  65. <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    66. 

  66. <td width="100%"><dl>
    67. 

  67. <dt><font face="helvetica, arial"><a href="skeinforge_tools.analyze_plugins.statistic.html#StatisticPreferences">StatisticPreferences</a>
    68. 

  68. </font></dt><dt><font face="helvetica, arial"><a href="skeinforge_tools.analyze_plugins.statistic.html#StatisticSkein">StatisticSkein</a>
    69. 

  69. </font></dt></dl>
    70. 

  70.  <p>
    71. 

  71. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    72. 

  72. <tr bgcolor="#ffc8d8">
    73. 

  73. <td colspan=3 valign=bottom>&nbsp;<br>
    74. 

  74. <font color="#000000" face="helvetica, arial"><a name="StatisticPreferences">class <strong>StatisticPreferences</strong></a></font></td></tr>
    75. 

  75.     
    76. 

  76. <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
    77. 

  77. <td colspan=2><tt>A&nbsp;class&nbsp;to&nbsp;handle&nbsp;the&nbsp;statistics&nbsp;preferences.<br>&nbsp;</tt></td></tr>
    78. 

  78. <tr><td>&nbsp;</td>
    79. 

  79. <td width="100%">Methods defined here:<br>
    80. 

  80. <dl><dt><a name="StatisticPreferences-__init__"><strong>__init__</strong></a>(self)</dt><dd><tt>Set&nbsp;the&nbsp;default&nbsp;preferences,&nbsp;execute&nbsp;title&nbsp;&amp;&nbsp;preferences&nbsp;fileName.</tt></dd></dl>
    81. 

  81. 

  82. <dl><dt><a name="StatisticPreferences-execute"><strong>execute</strong></a>(self)</dt><dd><tt>Write&nbsp;button&nbsp;has&nbsp;been&nbsp;clicked.</tt></dd></dl>
    83. 

  83. 

  84. </td></tr></table> <p>
    85. 

  85. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    86. 

  86. <tr bgcolor="#ffc8d8">
    87. 

  87. <td colspan=3 valign=bottom>&nbsp;<br>
    88. 

  88. <font color="#000000" face="helvetica, arial"><a name="StatisticSkein">class <strong>StatisticSkein</strong></a></font></td></tr>
    89. 

  89.     
    90. 

  90. <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
    91. 

  91. <td colspan=2><tt>A&nbsp;class&nbsp;to&nbsp;get&nbsp;statistics&nbsp;for&nbsp;a&nbsp;gcode&nbsp;skein.<br>&nbsp;</tt></td></tr>
    92. 

  92. <tr><td>&nbsp;</td>
    93. 

  93. <td width="100%">Methods defined here:<br>
    94. 

  94. <dl><dt><a name="StatisticSkein-__init__"><strong>__init__</strong></a>(self)</dt></dl>
    95. 

  95. 

  96. <dl><dt><a name="StatisticSkein-addLine"><strong>addLine</strong></a>(self, line)</dt><dd><tt>Add&nbsp;a&nbsp;line&nbsp;of&nbsp;text&nbsp;and&nbsp;a&nbsp;newline&nbsp;to&nbsp;the&nbsp;output.</tt></dd></dl>
    97. 

  97. 

  98. <dl><dt><a name="StatisticSkein-addToPath"><strong>addToPath</strong></a>(self, location)</dt><dd><tt>Add&nbsp;a&nbsp;point&nbsp;to&nbsp;travel&nbsp;and&nbsp;maybe&nbsp;extrusion.</tt></dd></dl>
    99. 

  99. 

  100. <dl><dt><a name="StatisticSkein-extruderSet"><strong>extruderSet</strong></a>(self, active)</dt><dd><tt>Maybe&nbsp;increment&nbsp;the&nbsp;number&nbsp;of&nbsp;times&nbsp;the&nbsp;extruder&nbsp;was&nbsp;toggled.</tt></dd></dl>
    101. 

  101. 

  102. <dl><dt><a name="StatisticSkein-getLocationSetFeedRateToSplitLine"><strong>getLocationSetFeedRateToSplitLine</strong></a>(self, splitLine)</dt></dl>
    103. 

  103. 

  104. <dl><dt><a name="StatisticSkein-helicalMove"><strong>helicalMove</strong></a>(self, isCounterclockwise, splitLine)</dt><dd><tt>Get&nbsp;statistics&nbsp;for&nbsp;a&nbsp;helical&nbsp;move.</tt></dd></dl>
    105. 

  105. 

  106. <dl><dt><a name="StatisticSkein-linearMove"><strong>linearMove</strong></a>(self, splitLine)</dt><dd><tt>Get&nbsp;statistics&nbsp;for&nbsp;a&nbsp;linear&nbsp;move.</tt></dd></dl>
    107. 

  107. 

  108. <dl><dt><a name="StatisticSkein-parseGcode"><strong>parseGcode</strong></a>(self, gcodeText)</dt><dd><tt>Parse&nbsp;gcode&nbsp;text&nbsp;and&nbsp;store&nbsp;the&nbsp;statistics.</tt></dd></dl>
    109. 

  109. 

  110. <dl><dt><a name="StatisticSkein-parseLine"><strong>parseLine</strong></a>(self, line)</dt><dd><tt>Parse&nbsp;a&nbsp;gcode&nbsp;line&nbsp;and&nbsp;add&nbsp;it&nbsp;to&nbsp;the&nbsp;statistics.</tt></dd></dl>
    111. 

  111. 

  112. </td></tr></table></td></tr></table><p>
    113. 

  113. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    114. 

  114. <tr bgcolor="#eeaa77">
    115. 

  115. <td colspan=3 valign=bottom>&nbsp;<br>
    116. 

  116. <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
    117. 

  117.     
    118. 

  118. <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    119. 

  119. <td width="100%"><dl><dt><a name="-getPreferencesConstructor"><strong>getPreferencesConstructor</strong></a>()</dt><dd><tt>Get&nbsp;the&nbsp;preferences&nbsp;constructor.</tt></dd></dl>
    120. 

  120.  <dl><dt><a name="-getStatisticGcode"><strong>getStatisticGcode</strong></a>(gcodeText)</dt><dd><tt>Get&nbsp;statistics&nbsp;for&nbsp;a&nbsp;gcode&nbsp;text.</tt></dd></dl>
    121. 

  121.  <dl><dt><a name="-main"><strong>main</strong></a>()</dt><dd><tt>Display&nbsp;the&nbsp;statistics&nbsp;dialog.</tt></dd></dl>
    122. 

  122.  <dl><dt><a name="-statisticFile"><strong>statisticFile</strong></a>(fileName<font color="#909090">=''</font>)</dt><dd><tt>Write&nbsp;statistics&nbsp;for&nbsp;a&nbsp;gcode&nbsp;file.&nbsp;&nbsp;If&nbsp;no&nbsp;fileName&nbsp;is&nbsp;specified,&nbsp;write&nbsp;statistics&nbsp;for&nbsp;the&nbsp;first&nbsp;gcode&nbsp;file&nbsp;in&nbsp;this&nbsp;folder&nbsp;that&nbsp;is&nbsp;not&nbsp;modified.</tt></dd></dl>
    123. 

  123.  <dl><dt><a name="-writeOutput"><strong>writeOutput</strong></a>(fileName, gcodeText<font color="#909090">=''</font>)</dt><dd><tt>Write&nbsp;statistics&nbsp;for&nbsp;a&nbsp;skeinforge&nbsp;gcode&nbsp;file,&nbsp;if&nbsp;'Write&nbsp;Statistics&nbsp;File&nbsp;for&nbsp;Skeinforge&nbsp;Chain'&nbsp;is&nbsp;selected.</tt></dd></dl>
    124. 

  124.  <dl><dt><a name="-writeStatisticFileGivenText"><strong>writeStatisticFileGivenText</strong></a>(fileName, gcodeText, statisticPreferences)</dt><dd><tt>Write&nbsp;statistics&nbsp;for&nbsp;a&nbsp;gcode&nbsp;file.</tt></dd></dl>
    125. 

  125. </td></tr></table><p>
    126. 

  126. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    127. 

  127. <tr bgcolor="#55aa55">
    128. 

  128. <td colspan=3 valign=bottom>&nbsp;<br>
    129. 

  129. <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
    130. 

  130.     
    131. 

  131. <tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    132. 

  132. <td width="100%"><strong>__author__</strong> = 'Enrique Perez (perez_enrique@yahoo.com)'<br>
    133. 

  133. <strong>__date__</strong> = '$Date: 2008/21/04 $'<br>
    134. 

  134. <strong>__license__</strong> = 'GPL 3.0'<br>
    135. 

  135. <strong>absolute_import</strong> = _Feature((2, 5, 0, 'alpha', 1), (2, 7, 0, 'alpha', 0), 16384)</td></tr></table><p>
    136. 

  136. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    137. 

  137. <tr bgcolor="#7799ee">
    138. 

  138. <td colspan=3 valign=bottom>&nbsp;<br>
    139. 

  139. <font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
    140. 

  140.     
    141. 

  141. <tr><td bgcolor="#7799ee"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    142. 

  142. <td width="100%">Enrique&nbsp;Perez&nbsp;(perez_enrique@yahoo.com)</td></tr></table>
    143. 

  143. </body></html>
    144.