PageRenderTime 56ms CodeModel.GetById 25ms RepoModel.GetById 1ms app.codeStats 0ms

/skein_engines/skeinforge-40/documentation/skeinforge_application.skeinforge_plugins.analyze_plugins.statistic.html

https://github.com/geoffd123/ReplicatorG
HTML | 185 lines | 158 code | 27 blank | 0 comment | 0 complexity | 9312733f82523658776c9b17cb7765a0 MD5 | raw file
    

  1. 

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

  3. <html><head><title>Python: module skeinforge_application.skeinforge_plugins.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_application.html"><font color="#ffffff">skeinforge_application</font></a>.<a href="skeinforge_application.skeinforge_plugins.html"><font color="#ffffff">skeinforge_plugins</font></a>.<a href="skeinforge_application.skeinforge_plugins.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/fabmetheus/skeinforge_application/skeinforge_plugins/analyze_plugins/statistic.py">/home/enrique/Desktop/backup/babbleold/script/reprap/fabmetheus/skeinforge_application/skeinforge_plugins/analyze_plugins/statistic.py</a></font></td></tr></table>
    12. 

  12.     <p>
    13. 

  13. <a href="skeinforge_application.skeinforge_plugins.analyze_plugins.skeinlayer.html">Previous</a> / <a href="skeinforge_application.skeinforge_plugins.analyze_plugins.vectorwrite.html">Next</a> / <a href="contents.html">Contents</a>
    14. 

  14. </p>
    15. 

  15. <p><tt><br>
    16. 

  16. Statistic is a script to generate statistics a gcode file.<br>
    17. 

  17.  <br>
    18. 

  18. The statistic manual page is at:<br>
    19. 

  19. <a href="http://fabmetheus.crsndoo.com/wiki/index.php/Skeinforge_Statistic">http://fabmetheus.crsndoo.com/wiki/index.php/Skeinforge_Statistic</a><br>
    20. 

  20.  <br>
    21. 

  21. <br />
    22. 

  22. <a href="#Operation">Operation</a><br />
    23. 

  23. <a href="#Settings">Settings</a><br />
    24. 

  24. &nbsp;&nbsp;<a href="#Extrusion Diameter over Thickness">Extrusion Diameter over Thickness</a><br />
    25. 

  25. &nbsp;&nbsp;<a href="#Print Statistics">Print Statistics</a><br />
    26. 

  26. &nbsp;&nbsp;<a href="#Save Statistics">Save Statistics</a><br />
    27. 

  27. <a href="#Gcodes">Gcodes</a><br />
    28. 

  28. <a href="#Examples">Examples</a><br />
    29. 

  29. <br />
    30. 

  30. <a name="Operation" id="Operation"></a><h2>Operation</h2>
    31. 

  31. <hr>
    32. 

  32. 

  33. 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>
    34. 

  34.  <br>
    35. 

  35. <a name="Settings" id="Settings"></a><h2>Settings</h2>
    36. 

  36. <hr>
    37. 

  37. 

  38. <a name="Extrusion Diameter over Thickness" id="Extrusion Diameter over Thickness"></a><h3>Extrusion Diameter over Thickness</h3>
    39. 

  39. 

  40. Default is 1.25.<br>
    41. 

  41.  <br>
    42. 

  42. The 'Extrusion Diameter over Thickness is the ratio of the extrusion diameter over the layer thickness, the default is 1.25.  The extrusion fill density ratio that is printed to the console, ( it is derived quantity not a parameter ) is the area of the extrusion diameter over the extrusion width over the layer thickness.  Assuming the extrusion diameter is correct, a high value means the filament will be packed tightly, and the object will be almost as dense as the filament.  If the fill density ratio is too high, there could be too little room for the filament, and the extruder will end up plowing through the extra filament.  A low fill density ratio means the filaments will be far away from each other, the object will be leaky and light.  The fill density ratio with the default extrusion settings is around 0.68.<br>
    43. 

  43.  <br>
    44. 

  44. <a name="Print Statistics" id="Print Statistics"></a><h3>Print Statistics</h3>
    45. 

  45. 

  46. Default is on.<br>
    47. 

  47.  <br>
    48. 

  48. When the 'Print Statistics' checkbox is on, the statistics will be printed to the console.<br>
    49. 

  49.  <br>
    50. 

  50. <a name="Save Statistics" id="Save Statistics"></a><h3>Save Statistics</h3>
    51. 

  51. 

  52. Default is off.<br>
    53. 

  53.  <br>
    54. 

  54. When the 'Save Statistics' checkbox is on, the statistics will be saved as a .txt file.<br>
    55. 

  55.  <br>
    56. 

  56. <a name="Gcodes" id="Gcodes"></a><h2>Gcodes</h2>
    57. 

  57. <hr>
    58. 

  58. 

  59. An explanation of the gcodes is at:<br>
    60. 

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

  61.  <br>
    62. 

  62. and at:<br>
    63. 

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

  64.  <br>
    65. 

  65. A gode example is at:<br>
    66. 

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

  67.  <br>
    68. 

  68. <a name="Examples" id="Examples"></a><h2>Examples</h2>
    69. 

  69. <hr>
    70. 

  70. 

  71. Below are examples of statistic being used.  These examples are run in a terminal in the folder which contains Screw Holder_penultimate.gcode and statistic.py.  The 'Save Statistics' checkbox is selected.<br>
    72. 

  72.  <br>
    73. 

  73. &gt; python statistic.py<br>
    74. 

  74. This brings up the statistic dialog.<br>
    75. 

  75.  <br>
    76. 

  76. &gt; python statistic.py Screw Holder_penultimate.gcode<br>
    77. 

  77. The statistic file is saved as Screw_Holder_penultimate_statistic.txt</tt>
    78. 

  78. <br />
    79. 

  79. <br />
    80. 

  80. <p>
    81. 

  81. <a href="skeinforge_application.skeinforge_plugins.analyze_plugins.skeinlayer.html">Previous</a> / <a href="skeinforge_application.skeinforge_plugins.analyze_plugins.vectorwrite.html">Next</a> / <a href="contents.html">Contents</a>
    82. 

  82. </p>
    83. 

  83. <hr>
    84. 

  84. </p>
    85. 

  85. <p>
    86. 

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

  87. <tr bgcolor="#aa55cc">
    88. 

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

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

  90.     
    91. 

  91. <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    92. 

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

  93. <a href="fabmetheus_utilities.archive.html">fabmetheus_utilities.archive</a><br>
    94. 

  94. <a href="cStringIO.html">cStringIO</a><br>
    95. 

  95. </td><td width="25%" valign=top><a href="fabmetheus_utilities.euclidean.html">fabmetheus_utilities.euclidean</a><br>
    96. 

  96. <a href="fabmetheus_utilities.gcodec.html">fabmetheus_utilities.gcodec</a><br>
    97. 

  97. <a href="math.html">math</a><br>
    98. 

  98. </td><td width="25%" valign=top><a href="fabmetheus_utilities.settings.html">fabmetheus_utilities.settings</a><br>
    99. 

  99. <a href="skeinforge_application.skeinforge_utilities.skeinforge_polyfile.html">skeinforge_application.skeinforge_utilities.skeinforge_polyfile</a><br>
    100. 

  100. <a href="skeinforge_application.skeinforge_utilities.skeinforge_profile.html">skeinforge_application.skeinforge_utilities.skeinforge_profile</a><br>
    101. 

  101. </td><td width="25%" valign=top><a href="sys.html">sys</a><br>
    102. 

  102. </td></tr></table></td></tr></table><p>
    103. 

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

  104. <tr bgcolor="#ee77aa">
    105. 

  105. <td colspan=3 valign=bottom>&nbsp;<br>
    106. 

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

  107.     
    108. 

  108. <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    109. 

  109. <td width="100%"><dl>
    110. 

  110. <dt><font face="helvetica, arial"><a href="skeinforge_application.skeinforge_plugins.analyze_plugins.statistic.html#StatisticRepository">StatisticRepository</a>
    111. 

  111. </font></dt><dt><font face="helvetica, arial"><a href="skeinforge_application.skeinforge_plugins.analyze_plugins.statistic.html#StatisticSkein">StatisticSkein</a>
    112. 

  112. </font></dt></dl>
    113. 

  113.  <p>
    114. 

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

  115. <tr bgcolor="#ffc8d8">
    116. 

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

  117. <font color="#000000" face="helvetica, arial"><a name="StatisticRepository">class <strong>StatisticRepository</strong></a></font></td></tr>
    118. 

  118.     
    119. 

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

  120. <td colspan=2><tt>A&nbsp;class&nbsp;to&nbsp;handle&nbsp;the&nbsp;statistics&nbsp;settings.<br>&nbsp;</tt></td></tr>
    121. 

  121. <tr><td>&nbsp;</td>
    122. 

  122. <td width="100%">Methods defined here:<br>
    123. 

  123. <dl><dt><a name="StatisticRepository-__init__"><strong>__init__</strong></a>(self)</dt><dd><tt>Set&nbsp;the&nbsp;default&nbsp;settings,&nbsp;execute&nbsp;title&nbsp;&amp;&nbsp;settings&nbsp;fileName.</tt></dd></dl>
    124. 

  124. 

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

  126. 

  127. </td></tr></table> <p>
    128. 

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

  129. <tr bgcolor="#ffc8d8">
    130. 

  130. <td colspan=3 valign=bottom>&nbsp;<br>
    131. 

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

  132.     
    133. 

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

  134. <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>
    135. 

  135. <tr><td>&nbsp;</td>
    136. 

  136. <td width="100%">Methods defined here:<br>
    137. 

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

  138. 

  139. <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>
    140. 

  140. 

  141. <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>
    142. 

  142. 

  143. <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>
    144. 

  144. 

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

  146. 

  147. <dl><dt><a name="StatisticSkein-getLocationSetFeedRateToSplitLine"><strong>getLocationSetFeedRateToSplitLine</strong></a>(self, splitLine)</dt><dd><tt>Get&nbsp;location&nbsp;ans&nbsp;set&nbsp;feed&nbsp;rate&nbsp;to&nbsp;the&nbsp;plsit&nbsp;line.</tt></dd></dl>
    148. 

  148. 

  149. <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>
    150. 

  150. 

  151. <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>
    152. 

  152. 

  153. <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>
    154. 

  154. 

  155. </td></tr></table></td></tr></table><p>
    156. 

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

  157. <tr bgcolor="#eeaa77">
    158. 

  158. <td colspan=3 valign=bottom>&nbsp;<br>
    159. 

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

  160.     
    161. 

  161. <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    162. 

  162. <td width="100%"><dl><dt><a name="-getNewRepository"><strong>getNewRepository</strong></a>()</dt><dd><tt>Get&nbsp;new&nbsp;repository.</tt></dd></dl>
    163. 

  163.  <dl><dt><a name="-getWindowAnalyzeFile"><strong>getWindowAnalyzeFile</strong></a>(fileName)</dt><dd><tt>Write&nbsp;statistics&nbsp;for&nbsp;a&nbsp;gcode&nbsp;file.</tt></dd></dl>
    164. 

  164.  <dl><dt><a name="-getWindowAnalyzeFileGivenText"><strong>getWindowAnalyzeFileGivenText</strong></a>(fileName, gcodeText, repository<font color="#909090">=None</font>)</dt><dd><tt>Write&nbsp;statistics&nbsp;for&nbsp;a&nbsp;gcode&nbsp;file.</tt></dd></dl>
    165. 

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

  166.  <dl><dt><a name="-writeOutput"><strong>writeOutput</strong></a>(fileName, fileNameSuffix, 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>
    167. 

  167. </td></tr></table><p>
    168. 

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

  169. <tr bgcolor="#55aa55">
    170. 

  170. <td colspan=3 valign=bottom>&nbsp;<br>
    171. 

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

  172.     
    173. 

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

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

  175. <strong>__date__</strong> = '$Date: 2008/21/04 $'<br>
    176. 

  176. <strong>__license__</strong> = 'GNU Affero General Public License http://www.gnu.org/licenses/agpl.html'<br>
    177. 

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

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

  179. <tr bgcolor="#7799ee">
    180. 

  180. <td colspan=3 valign=bottom>&nbsp;<br>
    181. 

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

  182.     
    183. 

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

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

  185. </body></html>
    186.