Compare - Revision history

Reel.Deal: add link to avs+ documentation

2022-09-18T03:20:14Z

add link to avs+ documentation

← Older revision		Revision as of 05:20, 18 September 2022
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	<div style="max-width:60em" >		<div style="max-width:60em" >

			<div {{BlueBox2\|40\|0\|3px solid purple}} >
			{{AvsPlusFullname}}<br>
			Up-to-date documentation: [https://avisynthplus.readthedocs.io/en/latest/avisynthdoc/corefilters/compare.html https://avisynthplus.readthedocs.io]
			</div>


	Compares two clips (the "filtered" clip and the "original" clip) and returns the following data for each frame:		Compares two clips (the "filtered" clip and the "original" clip) and returns the following data for each frame:
	:;Mean Absolute Deviation <sup>[[wikipedia:Statistical_dispersion\|1]]</sup>		:;Mean Absolute Deviation <sup>[[wikipedia:Statistical_dispersion\|1]]</sup>

Raffriff42: one more touch-up

2016-03-04T06:24:05Z

one more touch-up

← Older revision		Revision as of 08:24, 4 March 2016
Line 11:		Line 11:
	::''(minimum, average, maximum)''		::''(minimum, average, maximum)''
	:;PSNR		:;PSNR
	::''(~~cumulative~~)''		::''(minimum, average, maximum)''
			:;Overall PSNR

	These data are displayed on screen by default (see [[#Examples\|example image]]), or can optionally be written to a {{FuncArg\|logfile}}.		These data are displayed on screen by default (see [[#Examples\|example image]]), or can optionally be written to a {{FuncArg\|logfile}}.

Raffriff42: formatting, links, phrasing touch-up

2016-03-04T06:20:03Z

formatting, links, phrasing touch-up

← Older revision		Revision as of 08:20, 4 March 2016
Line 1:		Line 1:
	<div style="max-width:~~62em~~" >		__NOTOC__
			<div style="max-width:60em" >
			Compares two clips (the "filtered" clip and the "original" clip) and returns the following data for each frame:
			:;Mean Absolute Deviation <sup>[[wikipedia:Statistical_dispersion\|1]]</sup>
			::''(minimum, average, maximum)''
			:;Mean Deviation
			::''(minimum, average, maximum)''
			:;Max. Positive Deviation
			:;Max. Negative Deviation
			:;Peak Signal-to-Noise Ratio (PSNR) <sup>[[PSNR\|2]]</sup>
			::''(minimum, average, maximum)''
			:;PSNR
			::''(cumulative)''

			These data are displayed on screen by default (see [[#Examples\|example image]]), or can optionally be written to a {{FuncArg\|logfile}}.

			By default a ''PSNR graph'' is displayed; this graph shows overall PSNR visually as a timeline that grows left-to-right along the bottom of the screen as the clip plays.

			=== Syntax and Parameters ===
	{{FuncDef		{{FuncDef
	\|Compare(clip ''clip_filtered'', clip ''clip_original'', string ''channels'', string ''logfile'', bool ''show_graph'')}}\		\|Compare(clip ''clip_filtered'', clip ''clip_original''<br>
			[, string ''channels'', string ''logfile'', bool ''show_graph'' ] )
			}}

	{{Par2\|clip_filtered, clip_original\|clip\|}}		{{Par2\|clip_filtered, clip_original\|clip\|}}
	:~~This filter compares~~ the original clip and ~~its filtered version~~. ~~The filtered version will~~ be ~~returned with the results of the comparison displayed on screen (unless the {{FuncArg\|logfile}} option is used). For each frame~~, ~~the ''Mean Absolute Difference''~~, ~~''Mean Difference'' and ''Peak Signal-to-Noise Ratio'' (~~[[~~PSNR~~]]) is ~~given, as well as the ''min'' (minimum), ''avg'' (average), ''max'' (maximum) and ''overall'' PSNR up to that frame (calculated frame-wise)~~.		:The "filtered" clip and the "original" clip. Size and color formats must match.
			:Color format may be [[RGB24]], [[RGB32]], [[YUY2]] or [[YV12]].
			:The "filtered" clip is returned.

	{{Par2\|channels\|string\|""}}		{{Par2\|channels\|string\|""}}
	:Set the color channels to be compared with a combination of ''R'',''G'',''B'' [,''A''] or ''Y'',''U'',''V'', depending on the source color format. ~~If it is empty (~~default), ~~it means either "[[YUV]]" when the input clips~~ are ~~YCbCr or "[[RGB]]" when in the input clips are RGB~~.		:Set the color channels to be compared with a combination of ''R'',''G'',''B'' [,''A''] or ''Y'',''U'',''V'', depending on the source color format.
			:By default, all channels are compared.

	{{Par2\|show_graph\|bool\|true}}		{{Par2\|show_graph\|bool\|true}}
	:If true, (the default) ~~then Marc's{{Who\|Talk:Compare}}~~ PSNR graph is ~~also~~ drawn on ~~it (see [[#Examples\|example image]])~~.		:If true, (the default) the PSNR graph is drawn on the screen.

	{{Par2\|logfile\|string\|""}}		{{Par2\|logfile\|string\|""}}
	:If specified, the results will be written to a file ~~by this name~~ and not drawn on the clip. It is much faster if you need to compare a lot of frames.		:If specified, the results will be written to a file, and not drawn on the clip.
			:Using a {{FuncArg\|logfile}} is much faster if you need to compare a lot of frames.

	=====Examples=====		=== Examples ===
	* ~~displays~~ differences on screen:		* Basic usage – display differences on screen:
	<div {{BoxWidthIndent\|36\|2}} >		<div {{BoxWidthIndent\|36\|2}} >
	[[FFmpegSource\|FFmpegSource2]]("[http://www.sintel.org/ sintel].mp4")		[[FFmpegSource\|FFmpegSource2]]("[http://www.sintel.org/ sintel].mp4")
	A=[[BicubicResize]](640, 272)		A=[[BicubicResize]](640, 272)
	B=A.[[Sharpen]](1.0) ## ~~(the~~ filter under test)		B=A.[[Sharpen]](1.0) ## Sharpen is our ''filter under test''
	return Compare(A~~, B~~)		return Compare(B, A)
	</div>		</div>
	:[[File:Compare-Sintel-9507.png]]		:[[File:Compare-Sintel-9507.png]]

	* ~~for creating~~ a log file:		* Create a log file:
	<div {{BoxWidthIndent\|36\|2}} >		<div {{BoxWidthIndent\|36\|2}} >
	Compare(clip1, clip2, "", "compare.log")		Compare(clip1, clip2, "", "compare.log")
	</div>		</div>

	* ~~will only compare~~ chroma channels ~~of YUY2 clips~~:		* Compare chroma channels only:
	<div {{BoxWidthIndent\|36\|2}} >		<div {{BoxWidthIndent\|36\|2}} >
	Compare(clip1, clip2, "UV")		Compare(clip1, clip2, "UV")
Line 36:		Line 60:
	</div>		</div>

	=====~~Changes~~=====		=== External Links ===
			*[http://forum.doom9.org/showthread.php?t=29538 discussion]

			=== Changes ===
	{\| border="1"		{\| border="1"
	\|-		\|-

Raffriff42: add example image

2016-03-02T20:05:33Z

add example image

← Older revision		Revision as of 22:05, 2 March 2016
Line 10:		Line 10:

	{{Par2\|show_graph\|bool\|true}}		{{Par2\|show_graph\|bool\|true}}
	:If true, (the default) then Marc's{{Who\|Talk:Compare}} PSNR graph is also drawn on it.		:If true, (the default) then Marc's{{Who\|Talk:Compare}} PSNR graph is also drawn on it (see [[#Examples\|example image]]).

	{{Par2\|logfile\|string\|""}}		{{Par2\|logfile\|string\|""}}
	:If specified, the results will be written to a file by this name and not drawn on the clip. It is much faster if you need to compare a lot of frames.		:If specified, the results will be written to a file by this name and not drawn on the clip. It is much faster if you need to compare a lot of frames.

	~~'''~~Examples:~~'''~~		=====Examples=====
	<div {{BoxWidthIndent\|48\|0}} >		* displays differences on screen:
	# ~~displays differences on screen:~~		<div {{BoxWidthIndent\|36\|2}} >
	Compare(~~clip1~~, ~~clip2~~)		[[FFmpegSource\|FFmpegSource2]]("[http://www.sintel.org/ sintel].mp4")
			A=[[BicubicResize]](640, 272)
			B=A.[[Sharpen]](1.0) ## (the filter under test)
			return Compare(A, B)
	</div>		</div>
			:[[File:Compare-Sintel-9507.png]]

	<div {{BoxWidthIndent\|48\|0}} >		* for creating a log file:
	~~# for creating a log file:~~		<div {{BoxWidthIndent\|36\|2}} >
	Compare(clip1, clip2, "", "compare.log")		Compare(clip1, clip2, "", "compare.log")
	</div>		</div>

	<div {{BoxWidthIndent\|48\|0}} >		* will only compare chroma channels of YUY2 clips:
	~~# will only compare chroma channels of YUY2 clips:~~		<div {{BoxWidthIndent\|36\|2}} >
	Compare(clip1, clip2, "UV")		Compare(clip1, clip2, "UV")
	</div>		</div>
	</div>		</div>

	~~'''~~Changes~~:'''~~		=====Changes=====
	{\| border="1"		{\| border="1"
	\|-		\|-

Raffriff42: formatting, links, phrasing

2016-02-28T01:36:11Z

formatting, links, phrasing

← Older revision		Revision as of 03:36, 28 February 2016
Line 1:		Line 1:
	{{~~Template:~~FuncDef\|Compare(clip_filtered ''clip'', clip_original ~~''clip~~'', string ''channels'', string ''logfile'', bool ''show_graph'')}}		<div style="max-width:62em" >
			{{FuncDef
			\|Compare(clip ''clip_filtered'', clip ''clip_original'', string ''channels'', string ''logfile'', bool ''show_graph'')}}\

	This filter compares the original clip ~~"clip_original"~~ and its filtered version ~~"clip_filtered"~~. The filtered version will be returned with the results of the comparison. ~~Per~~ frame the Mean Absolute Difference, Mean Difference and Peak ~~signal~~-to-~~noise ratio~~ ([[PSNR]]) is given, as well as the min (minimum), avg (average) ~~and~~ max (maximum) PSNR up to that frame (calculated frame-wise)~~. Starting from v2.53, the 'Overall PSNR' (calculated over all pixels in all frames) is also shown on the output clip~~.		{{Par2\|clip_filtered, clip_original\|clip\|}}
			:This filter compares the original clip and its filtered version. The filtered version will be returned with the results of the comparison displayed on screen (unless the {{FuncArg\|logfile}} option is used). For each frame, the ''Mean Absolute Difference'', ''Mean Difference'' and ''Peak Signal-to-Noise Ratio'' ([[PSNR]]) is given, as well as the ''min'' (minimum), ''avg'' (average), ''max'' (maximum) and ''overall'' PSNR up to that frame (calculated frame-wise).

	~~The ''~~channels~~'' (default~~ ""~~) string is~~ a combination of R,G,B [,A] or Y,U,V, depending on the source ~~clips~~. If it is empty (default), it means either "[[YUV]]" when the input clips are YCbCr or "[[RGB]]" when in the input clips are RGB.		{{Par2\|channels\|string\|""}}
			:Set the color channels to be compared with a combination of ''R'',''G'',''B'' [,''A''] or ''Y'',''U'',''V'', depending on the source color format. If it is empty (default), it means either "[[YUV]]" when the input clips are YCbCr or "[[RGB]]" when in the input clips are RGB.

	If ~~''show_graph''~~ (default ~~true~~) ~~is true~~ then Marc's PSNR graph is also drawn on it.		{{Par2\|show_graph\|bool\|true}}
			:If true, (the default) then Marc's{{Who\|Talk:Compare}} PSNR graph is also drawn on it.

	If ~~a logfile is~~ specified, the results will be written to a file by this name and not drawn on the clip. It is much faster if you need to compare a lot of frames.		{{Par2\|logfile\|string\|""}}
			:If specified, the results will be written to a file by this name and not drawn on the clip. It is much faster if you need to compare a lot of frames.

	'''Examples:'''		'''Examples:'''
			<div {{BoxWidthIndent\|48\|0}} >
	# displays differences on screen:		# displays differences on screen:
	Compare(clip1, clip2)		Compare(clip1, clip2)
			</div>

			<div {{BoxWidthIndent\|48\|0}} >
	# for creating a log file:		# for creating a log file:
	Compare(clip1, clip2, "", "compare.log")		Compare(clip1, clip2, "", "compare.log")
			</div>

			<div {{BoxWidthIndent\|48\|0}} >
	# will only compare chroma channels of YUY2 clips:		# will only compare chroma channels of YUY2 clips:
	Compare(clip1, clip2, "UV")		Compare(clip1, clip2, "UV")
			</div>
			</div>

	'''Changes:'''		'''Changes:'''

Raffriff42: added category:Debugging/Diagnostic_filters

2015-06-03T22:10:23Z

added category:Debugging/Diagnostic_filters

← Older revision		Revision as of 00:10, 4 June 2015
Line 29:		Line 29:

	[[Category:Internal filters]]		[[Category:Internal filters]]
			[[Category:Debugging/Diagnostic_filters]]

Raffriff42: show_graph default=true (version 2.60)

2013-07-04T03:27:33Z

show_graph default=true (version 2.60)

← Older revision		Revision as of 05:27, 4 July 2013
Line 5:		Line 5:
	The ''channels'' (default "") string is a combination of R,G,B [,A] or Y,U,V, depending on the source clips. If it is empty (default), it means either "[[YUV]]" when the input clips are YCbCr or "[[RGB]]" when in the input clips are RGB.		The ''channels'' (default "") string is a combination of R,G,B [,A] or Y,U,V, depending on the source clips. If it is empty (default), it means either "[[YUV]]" when the input clips are YCbCr or "[[RGB]]" when in the input clips are RGB.

	If ''show_graph'' (default ~~false~~) is true then Marc's PSNR graph is also drawn on it.		If ''show_graph'' (default true) is true then Marc's PSNR graph is also drawn on it.

	If a logfile is specified, the results will be written to a file by this name and not drawn on the clip. It is much faster if you need to compare a lot of frames.		If a logfile is specified, the results will be written to a file by this name and not drawn on the clip. It is much faster if you need to compare a lot of frames.

Admin: 1 revision

2013-05-09T15:02:26Z

1 revision

← Older revision	Revision as of 17:02, 9 May 2013
(No difference)

Wilbert at 16:32, 6 June 2008

2008-06-06T16:32:20Z

New page

{{Template:FuncDef|Compare(clip_filtered ''clip'', clip_original ''clip'', string ''channels'', string ''logfile'', bool ''show_graph'')}}

This filter compares the original clip "clip_original" and its filtered version "clip_filtered". The filtered version will be returned with the results of the comparison. Per frame the Mean Absolute Difference, Mean Difference and Peak signal-to-noise ratio ([[PSNR]]) is given, as well as the min (minimum), avg (average) and max (maximum) PSNR up to that frame (calculated frame-wise). Starting from v2.53, the 'Overall PSNR' (calculated over all pixels in all frames) is also shown on the output clip.

The ''channels'' (default "") string is a combination of R,G,B [,A] or Y,U,V, depending on the source clips. If it is empty (default), it means either "[[YUV]]" when the input clips are YCbCr or "[[RGB]]" when in the input clips are RGB.

If ''show_graph'' (default false) is true then Marc's PSNR graph is also drawn on it.

If a logfile is specified, the results will be written to a file by this name and not drawn on the clip. It is much faster if you need to compare a lot of frames.

'''Examples:'''

# displays differences on screen:
Compare(clip1, clip2)

# for creating a log file:
Compare(clip1, clip2, "", "compare.log")

# will only compare chroma channels of YUY2 clips:
Compare(clip1, clip2, "UV")

'''Changes:'''
{| border="1"
|-
| v2.58
| Added YV12 support.
|}

[[Category:Internal filters]]