View source for Analyze CHOP

{{Summary			
	|short=The Analyze CHOP looks at the values of all the values of a channel, and outputs a single-number result into the output.		
	|opClass=analyzeCHOP_Class		
	|opFilter=True		
	|long=The Analyze CHOP looks at the values of all the values of a channel, and outputs a single-number result into the output. The output is one sample long. It can analyze for maximum, average, peaks and other aspects of a channel.		
	|opLicense=Non-Commercial		
	|opFamily=CHOP		
	|opType=analyze		
	|opLabel=Analyze		
}}			
{{ParameterPage			
	|pageName=Analyze		
	|pageSummary=		
	|opFamily=CHOP		
	|items=		
	{{Parameter|parSummary=This menu determines the function applied to the channel.	
		|parOrder=0	
		|opType=analyze	
		|parLabel=Function	
		|parName=function	
		|opFamily=CHOP	
		|parItems=	
		{{ParameterItem|itemName=average
			|parName=function
			|itemSummary=The average of the channel.
			|itemLabel=Average
			|opFamily=CHOP
		}}<!--
-->{{ParameterItem|itemName=maximum
			|parName=function
			|itemSummary=The maximum value of the channel.
			|itemLabel=Maximum
			|opFamily=CHOP
		}}<!--
-->{{ParameterItem|itemName=minimum
			|parName=function
			|itemSummary=The minimum value of the channel.
			|itemLabel=Minimum
			|opFamily=CHOP
		}}<!--
-->{{ParameterItem|itemName=maximumindex
			|parName=function
			|itemSummary=
			|itemLabel=Index of Maximum
			|opFamily=CHOP
		}}<!--
-->{{ParameterItem|itemName=minimumindex
			|parName=function
			|itemSummary=
			|itemLabel=Index of Minimum
			|opFamily=CHOP
		}}<!--
-->{{ParameterItem|itemName=sum
			|parName=function
			|itemSummary=The sum of all the samples in the channel.
			|itemLabel=Sum
			|opFamily=CHOP
		}}<!--
-->{{ParameterItem|itemName=rmspower
			|parName=function
			|itemSummary=The RMS (root-mean-square) of the channel.
			|itemLabel=RMS Power
			|opFamily=CHOP
		}}<!--
-->{{ParameterItem|itemName=firstpeakvalue
			|parName=function
			|itemSummary=The value of the first peak in the channel.
			|itemLabel=Value of First Peak
			|opFamily=CHOP
		}}<!--
-->{{ParameterItem|itemName=firstpeakindex
			|parName=function
			|itemSummary=The index of the first peak in the channel. The index of the first sample is 0.
			|itemLabel=Index of First Peak
			|opFamily=CHOP
		}}<!--
-->{{ParameterItem|itemName=lastpeakvalue
			|parName=function
			|itemSummary=
			|itemLabel=Value of Last Peak
			|opFamily=CHOP
		}}<!--
-->{{ParameterItem|itemName=lastpeakindex
			|parName=function
			|itemSummary=
			|itemLabel=Index of Last Peak
			|opFamily=CHOP
		}}<!--
-->{{ParameterItem|itemName=highestpeakvalue
			|parName=function
			|itemSummary=The value of the highest peak in the channel.
			|itemLabel=Value of Highest Peak
			|opFamily=CHOP
		}}<!--
-->{{ParameterItem|itemName=highestpeakindex
			|parName=function
			|itemSummary=The index of the highest peak in the channel. If multiple samples have the same highest peak value, it returns the index of the last peak sample.
			|itemLabel=Index of Highest Peak
			|opFamily=CHOP
		}}<!--
-->{{ParameterItem|itemName=lowestpeakvalue
			|parName=function
			|itemSummary=The value of the lowest peak in the channel.
			|itemLabel=Value of Lowest Peak
			|opFamily=CHOP
		}}<!--
-->{{ParameterItem|itemName=lowestpeakindex
			|parName=function
			|itemSummary=The index of the lowest peak in the channel. If multiple samples have the same lowest peak value, it returns the index of the last peak sample.
			|itemLabel=Index of Lowest Peak
			|opFamily=CHOP
		}}<!--
-->{{ParameterItem|itemName=totalpeaks
			|parName=function
			|itemSummary=The total number of peaks in the channel.
			|itemLabel=Total Peaks
			|opFamily=CHOP
		}}	
			
	|parType=	
		|parReadOnly=	
		}}		
	{{Parameter|parSummary=If the values of the first 2 samples are v0 and v1, if v0 > v1, count it as a peak. The default is to never count the first sample as a peak.	
		|opType=analyze	
		|parLabel=Allow Start Peaks	
		|parName=allowstart	
		|opFamily=CHOP	
		|parOrder=1	
	|parType=	
		|parReadOnly=	
		|parItems=	
		}}		
	{{Parameter|parSummary=If the values of the last 2 samples are vn and vm, if vm > vn, count it as a peak. The default is to never count the last sample as a peak.	
		|opType=analyze	
		|parLabel=Allow End Peaks	
		|parName=allowend	
		|opFamily=CHOP	
		|parOrder=2	
	|parType=	
		|parReadOnly=	
		|parItems=	
		}}		
	{{Parameter|parSummary=When no peaks are found, make this number (default is <code>-1</code>) the result that is output. When the Function is set to Peak Index or Peak Value, it is a way to detect that no peaks were found.	
		|opType=analyze	
		|parLabel=No Peak Value	
		|parName=nopeakvalue	
		|opFamily=CHOP	
		|parOrder=3	
	|parType=	
		|parReadOnly=	
		|parItems=	
		}}		
	{{Parameter|parSummary=Analyze instead for the First Valley, Highest Valley, and Lowest Valley, when the corresponding Function menu options are chosen.	
		|opType=analyze	
		|parLabel=Analyze Valleys vs Peaks	
		|parName=valleys	
		|opFamily=CHOP	
		|parOrder=4	
	|parType=	
		|parReadOnly=	
		|parItems=	
		}}		
			
}}			
{{:CHOP Filter Common Page			
}}			
{{InputsPage
								|opFamily=CHOP
								|opInputs={{OPInput
								|opFamily=CHOP
								|inputIndex=0
								|inputName=
								|inputSummary=
								}}
								}}{{History			
}}			
{{CHOPNavBox			
	|opFamily=CHOP		
}}			
{{#invoke:Category			
	|list|CHOPs}}