Helix SwarmHelix Swarm

diffing.html

  • //
  • guest/
  • sam_stafford/
  • calamari/
  • help/
  • diffing.html #1
  • View
  • Commits
  • Open Download .zip Download (3 KB) 
  1. <HTML>
  2. 	<HEAD>
  3. 		<TITLE></TITLE>
  4. 		<META NAME="GENERATOR" Content="Microsoft Visual Studio .NET 7.1">
  5. 	</HEAD>
  6. 	<BODY>
  7. 		<H3>Diffing with CALAMARI</H3>
  8. 		<UL>
  9. 			<LI>
  10. 				<a href="#how">How CALAMARI diffs files</a>
  11. 			<LI>
  12. 				<a href="#cli">Calling CALAMARI from the command line</a>
  13. 			<LI>
  14. 				<a href="#toolbar">The CALAMARI diff toolbar</a>
  15. 			<LI>
  16. 				<a href="#window">The CALAMARI diff window</a></LI></UL>
  17. 		<P>&nbsp;</P>
  18. 		<H4><a name="how">How CALAMARI diffs files</a></H4>
  19. 		<P>A "diff" is a comparison of two files that are similar in many ways but have 
  20. 			some significant difference.&nbsp; Since images are simply large arrays of 
  21. 			differently-colored pixels, CALAMARI expresses diffs by matching each pixel in 
  22. 			one image with the corresponding pixel in another image of the same size, and 
  23. 			comparing the two.&nbsp; The pairs of pixels which are different colors 
  24. 			comprise the "diff" between the two images, as illustrated here:</P>
  25. 		<P><img src="qrc:/doc/help/diff-how.png"></P>
  26. 		<P>&nbsp;</P>
  27. 		<H4><a name="cli">Calling CALAMARI from the command line</a></H4>
  28. 		<P>To diff two files in CALAMARI, call <STRONG>calamari</STRONG> with the names of 
  29. 			the two files as arguments:</P>
  30. 		<P><STRONG>calamari image1.png image2.png</STRONG></P>
  31. 		<P><STRONG></STRONG>&nbsp;</P>
  32. 		<H4><a name="toolbar">The CALAMARI diff toolbar</a></H4>
  33. 		<P><img src="qrc:/doc/help/diff-toolbar.png"></P>
  34. 		<P><STRONG>Diff stencil:</STRONG> Toggles a "stencil" which obscures the pixels 
  35. 			that are identical between the two images, leaving only the diffs.&nbsp; The 
  36. 			threshold at which two pixels are considered "identical" can be adjusted in the <STRONG>
  37. 				Color Options</STRONG> dialog.</P>
  38. 		<P><STRONG>Color Options:</STRONG> Opens a dialog that allows you to set the color 
  39. 			of the stencil and the threshold at which the stencil feature considers colors 
  40. 			to be identical.&nbsp; This dialog also allows you to set 
  41. 			additional&nbsp;options which are only relevant when merging files, and will 
  42. 			not be discussed here.</P>
  43. 		<P><STRONG>Zoom:</STRONG> By default, the diff view will automatically stretch to 
  44. 			fit the window.&nbsp; By unchecking that option, you can specify the exact 
  45. 			scale at which the image will be displayed.</P>
  46. 		<P>&nbsp;</P>
  47. 		<H4><a name="window"></a>The CALAMARI diff window</H4>
  48. 		<H4><img src="qrc:/doc/help/diff-window.png"></A></H4>
  49. 		<P><STRONG>Source images: </STRONG>These are the two images that were passed to 
  50. 			CALAMARI on the command line.&nbsp; Clicking on either of these images will set 
  51. 			the diff view to display that image.&nbsp; If the <STRONG>Zoom</STRONG> is set 
  52. 			to a greater size than will fit in the window, the source images will remain 
  53. 			scaled to fit the window, and will indicate what portion of the image is 
  54. 			currently visible in the diff view.</P>
  55. 		<P><STRONG>Diff slider: </STRONG>Moving this slider allows you to fade the diff 
  56. 			view between the two source images.</P>
  57. 		<P><STRONG>Diff view:</STRONG> The diff view displays either source image or a 
  58. 			blend between the two, depending on what the diff slider is currently set 
  59. 			to.&nbsp; If the <STRONG>Diff stencil</STRONG> option is currently enabled, 
  60. 			non-differing pixels will be obscured by the stencil.</P>
  61. 	</BODY>
  62. </HTML>
# Change User Description Committed
#1 5534 Sam Stafford A brand new help file, a bit of cosmetic sprucing, one critical bug
fix, and a partridge... in a pear tree. «		 19 years ago