reference.xml 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  1. <?xml version='1.0' encoding='UTF-8'?>
  2. <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
  3. "http://forrest.apache.org/dtd/document-v20.dtd">
  4. <!--
  5. Copyright (c) 2010-2010 by Bernhard Bablok (bablokb@users.sourceforge.net)
  6. $Revision: 1.6 $
  7. $Author: bablokb $
  8. -->
  9. <document>
  10. <header>
  11. <title>im4java Reference</title>
  12. </header>
  13. <body>
  14. <section id="config">
  15. <title>Configuration</title>
  16. <p>
  17. You can configure the behaviour of the im4java-library with
  18. the following environment-variables and system-properties:
  19. </p>
  20. <dl>
  21. <dt>IM4JAVA_TOOLPATH (environment)</dt>
  22. <dd>Default searchpath for <a href="../tools/index.html">commandline
  23. tools</a>. Must use the platform-specific
  24. path-delimiter.
  25. </dd>
  26. </dl>
  27. <dl>
  28. <dt>im4java.useGM (system-property)</dt>
  29. <dd>If true, use <a href="ext:graphicsmagick">GraphicsMagick</a>
  30. instead of <a href="ext:imagemagick">ImageMagick</a>.
  31. </dd>
  32. </dl>
  33. <dl>
  34. <dt>im4java.maxProcs (system-property)</dt>
  35. <dd>The maximum number of asynchronous processes the
  36. <code>org.im4java.process.ProcessExecutor</code> will run
  37. concurrently. If unset or if the
  38. property has the value <em>auto</em>, the number returned by
  39. <code>Runtime.availableProcessors()</code> is used. Note
  40. that the ProcessExecutor will at least use one process.
  41. </dd>
  42. </dl>
  43. </section>
  44. <section id="tests">
  45. <title>Test Cases</title>
  46. <p>
  47. The package <code>org.im4java.test</code> contains a growing
  48. number of test-cases, demonstrating the various features of
  49. the im4java-library. Here is a quick overview.
  50. </p>
  51. <dl>
  52. <dt>TestCase1</dt><dd>Simple use of convert</dd>
  53. <dt>TestCase2</dt><dd>Operation and sub-operations</dd>
  54. <dt>TestCase3</dt><dd>Using montage</dd>
  55. <dt>TestCase4</dt><dd>The ChannelMixer-class</dd>
  56. <dt>TestCase5</dt><dd>Using mogrify</dd>
  57. <dt>TestCase6</dt><dd>Using identify</dd>
  58. <dt>TestCase7</dt><dd>Using composite</dd>
  59. <dt>TestCase8</dt><dd>Using the Info-class</dd>
  60. <dt>TestCase9</dt><dd>The NoiseFilter-class</dd>
  61. <dt>TestCase10</dt><dd>Piping</dd>
  62. <dt>TestCase11</dt><dd>Dynamic operations</dd>
  63. <dt>TestCase12</dt><dd>Reading BufferedImage</dd>
  64. <dt>TestCase13</dt><dd>Writing BufferedImage</dd>
  65. <dt>TestCase14</dt><dd>GraphicsMagick</dd>
  66. <dt>TestCase15</dt><dd>Using jpegtran</dd>
  67. <dt>TestCase16</dt>
  68. <dd>
  69. Asynchronous execution. Basic version.
  70. </dd>
  71. <dt>TestCase16a</dt>
  72. <dd>
  73. Asynchronous execution. This version uses
  74. <code>Executors.newSingleThreadExecutor()</code> to aquire a
  75. <code>ExecutorService</code>.
  76. </dd>
  77. <dt>TestCase16b</dt>
  78. <dd>
  79. Asynchronous execution. This version uses a
  80. <code>ProcessExecutor</code> to run at most two processes in
  81. parallel.
  82. </dd>
  83. <dt>TestCase17</dt><dd>Using ufraw-batch</dd>
  84. <dt>TestCase18</dt><dd>Using exiftool</dd>
  85. <dt>TestCase19</dt><dd>Using dcraw</dd>
  86. <dt>TestCase20</dt><dd>Setting search PATHs</dd>
  87. <dt>TestCase21</dt><dd>Parallel processes</dd>
  88. <dt>TestCase22</dt><dd>Using the BatchConverter-class</dd>
  89. </dl>
  90. </section>
  91. </body>
  92. </document>