diffing.html #1

  • //
  • guest/
  • sam_stafford/
  • calamari/
  • help/
  • diffing.html
  • View
  • Commits
  • Open Download .zip Download (3 KB)
<HTML>
	<HEAD>
		<TITLE></TITLE>
		<META NAME="GENERATOR" Content="Microsoft Visual Studio .NET 7.1">
	</HEAD>
	<BODY>
		<H3>Diffing with CALAMARI</H3>
		<UL>
			<LI>
				<a href="#how">How CALAMARI diffs files</a>
			<LI>
				<a href="#cli">Calling CALAMARI from the command line</a>
			<LI>
				<a href="#toolbar">The CALAMARI diff toolbar</a>
			<LI>
				<a href="#window">The CALAMARI diff window</a></LI></UL>
		<P>&nbsp;</P>
		<H4><a name="how">How CALAMARI diffs files</a></H4>
		<P>A "diff" is a comparison of two files that are similar in many ways but have 
			some significant difference.&nbsp; Since images are simply large arrays of 
			differently-colored pixels, CALAMARI expresses diffs by matching each pixel in 
			one image with the corresponding pixel in another image of the same size, and 
			comparing the two.&nbsp; The pairs of pixels which are different colors 
			comprise the "diff" between the two images, as illustrated here:</P>
		<P><img src="qrc:/doc/help/diff-how.png"></P>
		<P>&nbsp;</P>
		<H4><a name="cli">Calling CALAMARI from the command line</a></H4>
		<P>To diff two files in CALAMARI, call <STRONG>calamari</STRONG> with the names of 
			the two files as arguments:</P>
		<P><STRONG>calamari image1.png image2.png</STRONG></P>
		<P><STRONG></STRONG>&nbsp;</P>
		<H4><a name="toolbar">The CALAMARI diff toolbar</a></H4>
		<P><img src="qrc:/doc/help/diff-toolbar.png"></P>
		<P><STRONG>Diff stencil:</STRONG> Toggles a "stencil" which obscures the pixels 
			that are identical between the two images, leaving only the diffs.&nbsp; The 
			threshold at which two pixels are considered "identical" can be adjusted in the <STRONG>
				Color Options</STRONG> dialog.</P>
		<P><STRONG>Color Options:</STRONG> Opens a dialog that allows you to set the color 
			of the stencil and the threshold at which the stencil feature considers colors 
			to be identical.&nbsp; This dialog also allows you to set 
			additional&nbsp;options which are only relevant when merging files, and will 
			not be discussed here.</P>
		<P><STRONG>Zoom:</STRONG> By default, the diff view will automatically stretch to 
			fit the window.&nbsp; By unchecking that option, you can specify the exact 
			scale at which the image will be displayed.</P>
		<P>&nbsp;</P>
		<H4><a name="window"></a>The CALAMARI diff window</H4>
		<H4><img src="qrc:/doc/help/diff-window.png"></A></H4>
		<P><STRONG>Source images: </STRONG>These are the two images that were passed to 
			CALAMARI on the command line.&nbsp; Clicking on either of these images will set 
			the diff view to display that image.&nbsp; If the <STRONG>Zoom</STRONG> is set 
			to a greater size than will fit in the window, the source images will remain 
			scaled to fit the window, and will indicate what portion of the image is 
			currently visible in the diff view.</P>
		<P><STRONG>Diff slider: </STRONG>Moving this slider allows you to fade the diff 
			view between the two source images.</P>
		<P><STRONG>Diff view:</STRONG> The diff view displays either source image or a 
			blend between the two, depending on what the diff slider is currently set 
			to.&nbsp; If the <STRONG>Diff stencil</STRONG> option is currently enabled, 
			non-differing pixels will be obscured by the stencil.</P>
	</BODY>
</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.