EtherPatches - Revision history

Thijshijsijsjss: Fix typo

2024-01-14T15:29:33Z

Fix typo

← Older revision		Revision as of 17:29, 14 January 2024
Line 35:		Line 35:
	You could play around with some parameters. In particular:		You could play around with some parameters. In particular:
	* <code>hpass_window</code> and <code>vpass_window</code> set the window sizes for the horizontal and vertical passes over the pixels respectively. 5 resp. 20 seem to work well, but other configurations might be better, depending e.g. on your screen's resolution.		* <code>hpass_window</code> and <code>vpass_window</code> set the window sizes for the horizontal and vertical passes over the pixels respectively. 5 resp. 20 seem to work well, but other configurations might be better, depending e.g. on your screen's resolution.
	* <code>input_dir</code> and <code>output_dir</code> may be altered to use ~~dirrefent~~ input resp. output directories.		* <code>input_dir</code> and <code>output_dir</code> may be altered to use different input resp. output directories.
	* <code>batch</code> may be set to false to not use batch conversion, but instead convert just one file. In this case <code>filename</code> will be converted. Note that single file conversion is possible through the batch conversion, too (just place 1 screenshot in the <tt>input</tt> directory) and this single file conversion option is present for debugging reasons. But you could use it, if you want.		* <code>batch</code> may be set to false to not use batch conversion, but instead convert just one file. In this case <code>filename</code> will be converted. Note that single file conversion is possible through the batch conversion, too (just place 1 screenshot in the <tt>input</tt> directory) and this single file conversion option is present for debugging reasons. But you could use it, if you want.
	* <code>display</code> may be set to false to not display anything.		* <code>display</code> may be set to false to not display anything.

Thijshijsijsjss: Add synthax highlighting to method section

2023-10-08T11:15:12Z

Add synthax highlighting to method section

← Older revision		Revision as of 13:15, 8 October 2023
Line 49:		Line 49:
	The horizontal pass looks like this:		The horizontal pass looks like this:

			<syntaxhighlight lang="java">
	for ( int y = 0; y < h; y++ ) {		for ( int y = 0; y < h; y++ ) {
	color cur_marker = #FFFFFF;		color cur_marker = #FFFFFF;
Line 58:		Line 59:
	}		}
	}		}
			</syntaxhighlight>

	[[File:EtherPatch-example-2.png\|thumb\|right\|Intermediate result: after horizontal pass]]		[[File:EtherPatch-example-2.png\|thumb\|right\|Intermediate result: after horizontal pass]]
Line 68:		Line 70:
	* We use the variable <code>vpass_window</code> instead of <code>hpass_window</code>. As the lineheight in Etherpads is greater than the character width, we can allow for the vertical window to be of a greater size than the horizontal window.		* We use the variable <code>vpass_window</code> instead of <code>hpass_window</code>. As the lineheight in Etherpads is greater than the character width, we can allow for the vertical window to be of a greater size than the horizontal window.

			<syntaxhighlight lang="java">
	for ( int x = 0; x < w; x++ ) {		for ( int x = 0; x < w; x++ ) {
	color cur_marker = #FFFFFF;		color cur_marker = #FFFFFF;
Line 77:		Line 80:
	}		}
	}		}
			</syntaxhighlight>

	It might be interesting to note the three conditions there are for a window to continue with the current marker color:		It might be interesting to note the three conditions there are for a window to continue with the current marker color:
Line 85:		Line 89:
	(*At least, I think Java (and therefore Processing) implements lazy evaluation.. Either way, it doesn't really matter for our purposes, Processing allows for out of bounds retrieval calls in images.)		(*At least, I think Java (and therefore Processing) implements lazy evaluation.. Either way, it doesn't really matter for our purposes, Processing allows for out of bounds retrieval calls in images.)

			<syntaxhighlight lang="java">
	boolean is_marker_present( color m, int x, int y, int n ) {		boolean is_marker_present( color m, int x, int y, int n ) {
	for ( int i = 1; i < n + 1; i++ ) {		for ( int i = 1; i < n + 1; i++ ) {
Line 92:		Line 97:
	return false;		return false;
	}		}
			</syntaxhighlight>

	The funtion <code>is_marker_present_down(color, int, int, int)</code> is identical, except for adding <code>i</code> to <code>y</code> instead of <code>x</code>.		The funtion <code>is_marker_present_down(color, int, int, int)</code> is identical, except for adding <code>i</code> to <code>y</code> instead of <code>x</code>.

Thijshijsijsjss: Change note on example images to reflect current state of the git repo

2023-10-07T23:11:59Z

Change note on example images to reflect current state of the git repo

← Older revision		Revision as of 01:11, 8 October 2023
Line 28:		Line 28:

	==Notes==		==Notes==
	When cloning / downloading the repository, example files are included. <tt>example~~.png~~</tt>, ~~<tt>example-after-hpass.png</tt> and <tt>example-after-hpass-and-vpass.png</tt>~~ are used ~~as examples~~ in the <tt>README.md</tt> file. The <tt>input</tt> directory contains sample screenshots, and the <tt>output</tt> directory contains the patched versions of these samples. You could delete everything in the <tt>output</tt> directory and run the program to verify everything has been setup correctly: the same patched files should appear.		When cloning / downloading the repository, example files are included in the <tt>example</tt> directory, they are used in the <tt>README.md</tt> file. The <tt>input</tt> directory contains sample screenshots, and the <tt>output</tt> directory contains the patched versions of these samples. You could delete everything in the <tt>output</tt> directory and run the program to verify everything has been setup correctly: the same patched files should appear.

	Note that any file with name <tt>FILENAME.png</tt> in the <tt>input</tt> directory will be converted to a file with name <tt>PATCHED-FILENAME.png</tt> in the output directory.		Note that any file with name <tt>FILENAME.png</tt> in the <tt>input</tt> directory will be converted to a file with name <tt>PATCHED-FILENAME.png</tt> in the output directory.

Thijshijsijsjss: Fix typo

2023-10-07T23:03:46Z

Fix typo

← Older revision		Revision as of 01:03, 8 October 2023
Line 4:		Line 4:


	EtherPatches is a program to convert [[Etherpad]] screenshots to a 'patched'~~: one where~~ the text has been removed.		EtherPatches is a program to convert [[Etherpad]] screenshots to 'patched' ones in which the text has been removed.

	Find the code on [https://github.com/Nyxaeroz/EtherPatches GitHub].		Find the code on [https://github.com/Nyxaeroz/EtherPatches GitHub].

Thijshijsijsjss: Add punctuation

2023-10-05T22:03:36Z

Add punctuation

← Older revision		Revision as of 00:03, 6 October 2023
Line 96:		Line 96:

	==Limitations==		==Limitations==
	At the moment, the program will not be able to handle any lines that use white characters (in particular, a completely black marker color)		At the moment, the program will not be able to handle any lines that use white characters (in particular, a completely black marker color).

Thijshijsijsjss: Add punctuation

2023-10-05T22:01:28Z

Add punctuation

← Older revision		Revision as of 00:01, 6 October 2023
Line 23:		Line 23:
	<li>Select the Etherpad you want to patch.</li>		<li>Select the Etherpad you want to patch.</li>
	<li>Make sceenshots of the pad and save them to the directory called <tt>input</tt>.</li>		<li>Make sceenshots of the pad and save them to the directory called <tt>input</tt>.</li>
	<li>Run the program. A window will appear with the before-and-after. You can close it. (If he screenshots don't fully fit, that's okay, the display is unrelated to the conversion)</li>		<li>Run the program. A window will appear with the before-and-after. You can close it. (If he screenshots don't fully fit, that's okay, the display is unrelated to the conversion.)</li>
	<li>View your patched screenshots in the directory called <tt>output</tt>.		<li>View your patched screenshots in the directory called <tt>output</tt>.
	</ol>		</ol>

Thijshijsijsjss: Fix closing li tag

2023-10-05T22:00:23Z

Fix closing li tag

← Older revision		Revision as of 00:00, 6 October 2023
Line 17:		Line 17:
	* The easiest is downloading the [https://processing.org/ Processing IDE]		* The easiest is downloading the [https://processing.org/ Processing IDE]
	* You can also compile [https://github.com/processing/processing/wiki/Command-Line from the command line]		* You can also compile [https://github.com/processing/processing/wiki/Command-Line from the command line]
	* Your favorite IDE might offer plugins for Processing language and compilation support, like [https://marketplace.visualstudio.com/items?itemName=Luke-zhang-04.processing-vscode this one for vscode] <\li>		* Your favorite IDE might offer plugins for Processing language and compilation support, like [https://marketplace.visualstudio.com/items?itemName=Luke-zhang-04.processing-vscode this one for vscode] </li>
	<li>Next, you need to obtain the code. Again, there are several options:		<li>Next, you need to obtain the code. Again, there are several options:
	* Go to https://github.com/Nyxaeroz/EtherPatches, press the button that says <tt style="color:green;">code</tt>, download the zip and unzip it wherever you want this project to reside on your machine.		* Go to https://github.com/Nyxaeroz/EtherPatches, press the button that says <tt style="color:green;">code</tt>, download the zip and unzip it wherever you want this project to reside on your machine.

Thijshijsijsjss: Add extra spaces in code segments

2023-10-05T21:58:20Z

Add extra spaces in code segments

← Older revision		Revision as of 23:58, 5 October 2023
Line 49:		Line 49:
	The horizontal pass looks like this:		The horizontal pass looks like this:

	for (int y = 0; y < h; y++) {		for ( int y = 0; y < h; y++ ) {
	color cur_marker = #FFFFFF;		color cur_marker = #FFFFFF;
	for (int x = 0; x < w; x++ ) {		for ( int x = 0; x < w; x++ ) {
	color cur = input.get(x,y);		color cur = input.get( x, y );
	if ( cc(cur,#FFFFFF) ) { cur_marker = #FFFFFF; }		if ( cc( cur, #FFFFFF ) ) { cur_marker = #FFFFFF; }
	else if ( !cc(cur,cur_marker) && !is_marker_present(cur_marker, x, y, hpass_window) ) { cur_marker = cur; }		else if ( !cc( cur, cur_marker ) && !is_marker_present( cur_marker, x, y, hpass_window ) ) { cur_marker = cur; }
	output.set(x,y,cur_marker);		output.set( x ,y , cur_marker );
	}		}
	}		}
Line 68:		Line 68:
	* We use the variable <code>vpass_window</code> instead of <code>hpass_window</code>. As the lineheight in Etherpads is greater than the character width, we can allow for the vertical window to be of a greater size than the horizontal window.		* We use the variable <code>vpass_window</code> instead of <code>hpass_window</code>. As the lineheight in Etherpads is greater than the character width, we can allow for the vertical window to be of a greater size than the horizontal window.

	for (int x = 0; x < w; x++ ) {		for ( int x = 0; x < w; x++ ) {
	color cur_marker = #FFFFFF;		color cur_marker = #FFFFFF;
	for (int y = 0; y < h; y++) {		for ( int y = 0; y < h; y++ ) {
	color cur = output.get(x,y);		color cur = output.get( x, y );
	if ( cc(cur,#FFFFFF) ) { cur_marker = #FFFFFF; }		if ( cc( cur, #FFFFFF ) ) { cur_marker = #FFFFFF; }
	else if ( !cc(cur,cur_marker) && !is_marker_present_down(cur_marker, x, y, vpass_window) ) { cur_marker = cur;}		else if ( !cc( cur, cur_marker ) && !is_marker_present_down( cur_marker, x, y, vpass_window ) ) { cur_marker = cur; }
	output.set(x,y,cur_marker);		output.set( x, y, cur_marker );
	}		}
	}		}
Line 85:		Line 85:
	(*At least, I think Java (and therefore Processing) implements lazy evaluation.. Either way, it doesn't really matter for our purposes, Processing allows for out of bounds retrieval calls in images.)		(*At least, I think Java (and therefore Processing) implements lazy evaluation.. Either way, it doesn't really matter for our purposes, Processing allows for out of bounds retrieval calls in images.)

	boolean is_marker_present(color m, int x, int y, int n) {		boolean is_marker_present( color m, int x, int y, int n ) {
	for (int i = 1; i < n + 1; i++) {		for ( int i = 1; i < n + 1; i++ ) {
	color c = input.get(x+i, y);		color c = input.get( x+i, y );
	if ( cc(c, m) \|\| cc(c, #FFFFFF) \|\| x+i >= w) { return true; }		if ( cc( c, m ) \|\| cc( c, #FFFFFF ) \|\| x+i >= w ) { return true; }
	}		}
	return false;		return false;

Thijshijsijsjss: Add section of method

2023-10-05T21:55:38Z

Add section of method

← Older revision		Revision as of 23:55, 5 October 2023
Line 41:		Line 41:

	=Method=		=Method=
			This section discusses how one file is converted. For batch conversion, this process is then applied to multiple elements.

			First, an image is loaded into a <code>PImage</code>, which allows for pixel level retrieval and manipulation. This is exactly what we'll be doing: retrieving pixels from the input image and writing pixels to another <code>PImage</code>. Our task is to find 'bad' pixels (those's belonging to text) and replacing them with 'good' ones (the corresponding marker color).

			We make two passes over the pixels. First, a ''horizontal pass'' and then a ''vertical pass''. Each pass can be thought of as a window (of size 1x<code>hpass_winow</code> resp. <code>vpass_window</code>x1) moving over the pixels. The window keeps track of the current marker, and if the marker color is present elsewhere in the window, it is assumed we're still in the same line of text. N.B. increasing the window size will therefore result in an overadjustment: a <code>hpass_window</code> size of 20 will often remove single character adjustments.

			The horizontal pass looks like this:

			for (int y = 0; y < h; y++) {
			color cur_marker = #FFFFFF;
			for (int x = 0; x < w; x++ ) {
			color cur = input.get(x,y);
			if ( cc(cur,#FFFFFF) ) { cur_marker = #FFFFFF; }
			else if ( !cc(cur,cur_marker) && !is_marker_present(cur_marker, x, y, hpass_window) ) { cur_marker = cur; }
			output.set(x,y,cur_marker);
			}
			}

			[[File:EtherPatch-example-2.png\|thumb\|right\|Intermediate result: after horizontal pass]]

			Here, two helper functions are used: <code>cc(color, color)</code> for comparing two colors and <code>is_marker_present(color,int,int,int)</code> to check if the marker color is present.

			If a line of pixels starts with a 'bad' pixel, this will be assumed as the marker color, and hence will often produce a line of 'bad' pixels (see image of intermediate result). Hence, we need a vertical pass after the horizontal pass. The vertical pass is almost identical to the horizontal pass, with 3 notable exeptions:
			* Not the input image, but the result of the horizontal pass is used (which is at that time stored in <code>output</code> -- we will override this <code>PImage</code>).
			* Instead of looking at the pixels to the right of any pixel we're examining, we're looking at the pixels down. This allows us to 'jump' over these thin lines that are left as artefacts of the horizontal pass.
			* We use the variable <code>vpass_window</code> instead of <code>hpass_window</code>. As the lineheight in Etherpads is greater than the character width, we can allow for the vertical window to be of a greater size than the horizontal window.

			for (int x = 0; x < w; x++ ) {
			color cur_marker = #FFFFFF;
			for (int y = 0; y < h; y++) {
			color cur = output.get(x,y);
			if ( cc(cur,#FFFFFF) ) { cur_marker = #FFFFFF; }
			else if ( !cc(cur,cur_marker) && !is_marker_present_down(cur_marker, x, y, vpass_window) ) { cur_marker = cur;}
			output.set(x,y,cur_marker);
			}
			}

			It might be interesting to note the three conditions there are for a window to continue with the current marker color:
			* The color white is found (indicating the end of a marked segment -- we are thus fine continuing it for now).
			* We find another color, but our marker color appears within the window once more. This suggests we are not yet in a new marked segment, but rather have encountered part of a character of text.
			* The window reaches out of bounds of the image without having passed either of the previous two checks*. This is implied in the above code -- the marked segment will continue untill the edge of the screen, so we can continue it.

			(*At least, I think Java (and therefore Processing) implements lazy evaluation.. Either way, it doesn't really matter for our purposes, Processing allows for out of bounds retrieval calls in images.)

			boolean is_marker_present(color m, int x, int y, int n) {
			for (int i = 1; i < n + 1; i++) {
			color c = input.get(x+i, y);
			if ( cc(c, m) \|\| cc(c, #FFFFFF) \|\| x+i >= w) { return true; }
			}
			return false;
			}

			The funtion <code>is_marker_present_down(color, int, int, int)</code> is identical, except for adding <code>i</code> to <code>y</code> instead of <code>x</code>.

			==Limitations==
			At the moment, the program will not be able to handle any lines that use white characters (in particular, a completely black marker color)

Thijshijsijsjss: Remove image of intermediate step from intro section

2023-10-05T21:27:16Z

Remove image of intermediate step from intro section

← Older revision		Revision as of 23:27, 5 October 2023
Line 1:		Line 1:
	[[File:EtherPatch-example-1.png\|thumb\|right\|Original screenshot]]		[[File:EtherPatch-example-1.png\|thumb\|right\|Original screenshot]]

	~~[[File:EtherPatch-example-2.png\|thumb\|right\|Intermediate result: after horizontal pass]]~~		[[File:EtherPath-example-3.png\|thumb\|right\|End Result]]

	[[File:EtherPath-example-3.png\|thumb\|right\|End Result~~: after horizontal and vertical pass~~]]

← Older revision		Revision as of 23:27, 5 October 2023
Line 1:		Line 1:
	[[File:EtherPatch-example-1.png\|thumb\|right\|Original screenshot]]		[[File:EtherPatch-example-1.png\|thumb\|right\|Original screenshot]]

	~~[[File:EtherPatch-example-2.png\|thumb\|right\|Intermediate result: after horizontal pass]]~~		[[File:EtherPath-example-3.png\|thumb\|right\|End Result]]

	[[File:EtherPath-example-3.png\|thumb\|right\|End Result~~: after horizontal and vertical pass~~]]