<?xml version="1.0" encoding="utf-8" standalone="yes"?>

<?xml-stylesheet href="./_c74_ref.xsl" type="text/xsl"?>

<!--This is an automatically generated file. DO NOT EDIT THIS FILE DIRECTLY. Rather, use the _ref.xml files found in the 'edits' folder.-->
<c74object name="spike~" module="msp" category="MSP Analysis">
	<digest>
		Report intervals of zero to non-zero transitions
	</digest>
	<description>
		<o>spike~</o> reports intervals of zero to non-zero transitions.
	</description>
	<!--METADATA-->
	<metadatalist>
		<metadata name="author">
			Cycling '74
		</metadata>
		<metadata name="tag">
			MSP
		</metadata>
		<metadata name="tag">
			MSP Analysis
		</metadata>
	</metadatalist>
	<!--INLETS-->
	<inletlist>
		<inlet id="0" type="signal">
			<digest>
				(signal) Input
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
		<inlet id="1" type="double">
			<digest>
				(float) Refractory period
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
	</inletlist>
	<!--OUTLETS-->
	<outletlist>
		<outlet id="0" type="double">
			<digest>
				(float) Outputs interval on zero to non-zero transition
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
	</outletlist>
	<!--ARGUMENTS-->
	<objarglist>
		<objarg name="refractory-period" optional="1" units="ms" type="int or float">
			<digest>
				Refractory period
			</digest>
			<description>
				Sets the refractory period.
			</description>
		</objarg>
	</objarglist>
	<!--MESSAGES-->
	<methodlist>
		<method name="bang">
			<arglist />
			<digest>
				Restart the refractory period countdown
			</digest>
			<description>
				<m>bang</m> will cause the object to restart the countdown of the refractory period from the time at which the <m>bang</m> was received.
			</description>
		</method>
		<method name="ft1">
			<arglist>
				<arg name="time-in-ms" optional="0" type="float" />
			</arglist>
			<digest>
				Set the refractory period
			</digest>
			<description>
				In right inlet: Sets the refractory period, in milliseconds. When a signal transition is detected, this value sets the time, in milliseconds, during which no transitions are reported. After the refractory period has elapsed, the <o>spike~</o> object reports the next zero to non-zero signal transition. The default is 0.
			</description>
		</method>
		<method name="signal">
			<arglist />
			<digest>
				Signal to be analyzed
			</digest>
			<description>
				In left inlet: A signal to be analyzed. The <o>spike~</o> object analyzes an incoming signal and reports the interval, in milliseconds, between transitions between zero and non-zero signal values. You can specify a refractory period, which defines how soon after detecting a transition the <o>spike~</o> object will report the next instance.
			</description>
		</method>
	</methodlist>
	<!--ATTRIBUTES-->
	<!--EXAMPLE-->
	<examplelist>
		<example img="spike~.png" caption="spike~ reports how often a zero to non-zero transition occurs in its input signal" />
	</examplelist>
	<!--SEEALSO-->
	<seealsolist>
		<seealso name="change~" />
		<seealso name="edge~" />
		<seealso name="zerox~" />
	</seealsolist>
	<misc name="Output">
		<entry name="float">
			<description>
				The interval, in milliseconds, since the last zero to non-zero signal transition has occurred (which includes the refractory period, if one is set).
			</description>
		</entry>
	</misc>
</c74object>
