<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.6.3">
<compounddef id="classatsci__fs__checker" kind="class" prot="public">
<compoundname>atsci_fs_checker</compoundname>
<derivedcompoundref refid="classatsci__fs__checker__naive" prot="public" virt="non-virtual">atsci_fs_checker_naive</derivedcompoundref>
<includes refid="atsci__fs__checker_8h" local="no">atsci_fs_checker.h</includes>
<sectiondef kind="public-func">
<memberdef kind="function" id="classatsci__fs__checker_1af6dc8b2ac60bfa16b7c0a76cf850d032" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type></type>
<definition>atsci_fs_checker::atsci_fs_checker</definition>
<argsstring>()</argsstring>
<name>atsci_fs_checker</name>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/home/mandrake/rpm/BUILD/gnuradio-3.3.0/gr-atsc/src/lib/atsci_fs_checker.h" line="55"/>
</memberdef>
<memberdef kind="function" id="classatsci__fs__checker_1a61ce2227deb80a8d6921851171842c71" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
<type></type>
<definition>virtual atsci_fs_checker::~atsci_fs_checker</definition>
<argsstring>()=0</argsstring>
<name>~atsci_fs_checker</name>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/home/mandrake/rpm/BUILD/gnuradio-3.3.0/gr-atsc/src/lib/atsci_fs_checker.h" line="56"/>
</memberdef>
<memberdef kind="function" id="classatsci__fs__checker_1a288226c4f2a57a161e84bf4de935169e" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
<type>void</type>
<definition>virtual void atsci_fs_checker::reset</definition>
<argsstring>()=0</argsstring>
<name>reset</name>
<reimplementedby refid="classatsci__fs__checker__naive_1a5b1d57432945874baa43624bd07f2d70">reset</reimplementedby>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/home/mandrake/rpm/BUILD/gnuradio-3.3.0/gr-atsc/src/lib/atsci_fs_checker.h" line="59"/>
</memberdef>
<memberdef kind="function" id="classatsci__fs__checker_1a6770714d6b09f8c4bb9facd51814e67c" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
<type>void</type>
<definition>virtual void atsci_fs_checker::filter</definition>
<argsstring>(float input_sample, atsc::syminfo input_tag, float *output_sample, atsc::syminfo *output_tag)=0</argsstring>
<name>filter</name>
<reimplementedby refid="classatsci__fs__checker__naive_1ad17bd92ef8fc404335894be3c002ed25">filter</reimplementedby>
<param>
<type>float</type>
<declname>input_sample</declname>
</param>
<param>
<type><ref refid="structatsc_1_1syminfo" kindref="compound">atsc::syminfo</ref></type>
<declname>input_tag</declname>
</param>
<param>
<type>float *</type>
<declname>output_sample</declname>
</param>
<param>
<type><ref refid="structatsc_1_1syminfo" kindref="compound">atsc::syminfo</ref> *</type>
<declname>output_tag</declname>
</param>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/home/mandrake/rpm/BUILD/gnuradio-3.3.0/gr-atsc/src/lib/atsci_fs_checker.h" line="61"/>
</memberdef>
<memberdef kind="function" id="classatsci__fs__checker_1aa9acc7f6ad5fb19e8ffb599b9c959a34" prot="public" static="no" const="yes" explicit="no" inline="no" virt="pure-virtual">
<type>int</type>
<definition>virtual int atsci_fs_checker::delay</definition>
<argsstring>() const =0</argsstring>
<name>delay</name>
<reimplementedby refid="classatsci__fs__checker__naive_1a7e475c0f8a58abc4603ab9196220a876">delay</reimplementedby>
<briefdescription>
<para>return delay in samples from input to output </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/home/mandrake/rpm/BUILD/gnuradio-3.3.0/gr-atsc/src/lib/atsci_fs_checker.h" line="66"/>
</memberdef>
</sectiondef>
<briefdescription>
<para>abstract base class for ATSC field sync checker </para> </briefdescription>
<detaileddescription>
<para>Processes input samples one at a time looking for an occurence of either the field sync 1 or field sync 2 pattern.</para><para>Note that unlike <ref refid="classatsci__fs__correlator" kindref="compound">atsci_fs_correlator</ref>, this class uses the symbol_num in input_tag to avoid having to test each symbol position.</para><para>For each sample processed, an output sample and an output tag are produced. The output samples are identical to the input samples but are delayed by a number of samples given by <computeroutput><ref refid="classatsci__fs__checker_1aa9acc7f6ad5fb19e8ffb599b9c959a34" kindref="member">delay()</ref></computeroutput>. The output tag associated with the the given output sample indicates whether this sample is the beginning of one of the field syncs or is an ordinary sample. The tags are defined in <ref refid="atsci__sync__tag_8h" kindref="compound">atsci_sync_tag.h</ref>.</para><para>For ease of use, the field sync patterns are defined to begin with the first symbol of the 4 symbol data segment sync pattern that immediately proceeds the actual PN 511 code. This makes it easier for downstream code to determine the location of data segment syncs merely by counting. They'll occur every 832 samples assuming everything is working. </para> </detaileddescription>
<inheritancegraph>
<node id="5835">
<label>atsci_fs_checker_naive</label>
<link refid="classatsci__fs__checker__naive"/>
<childnode refid="5834" relation="public-inheritance">
</childnode>
</node>
<node id="5834">
<label>atsci_fs_checker</label>
<link refid="classatsci__fs__checker"/>
</node>
</inheritancegraph>
<location file="/home/mandrake/rpm/BUILD/gnuradio-3.3.0/gr-atsc/src/lib/atsci_fs_checker.h" line="50" bodyfile="/home/mandrake/rpm/BUILD/gnuradio-3.3.0/gr-atsc/src/lib/atsci_fs_checker.h" bodystart="50" bodyend="67"/>
<listofallmembers>
<member refid="classatsci__fs__checker_1af6dc8b2ac60bfa16b7c0a76cf850d032" prot="public" virt="non-virtual"><scope>atsci_fs_checker</scope><name>atsci_fs_checker</name></member>
<member refid="classatsci__fs__checker_1aa9acc7f6ad5fb19e8ffb599b9c959a34" prot="public" virt="pure-virtual"><scope>atsci_fs_checker</scope><name>delay</name></member>
<member refid="classatsci__fs__checker_1a6770714d6b09f8c4bb9facd51814e67c" prot="public" virt="pure-virtual"><scope>atsci_fs_checker</scope><name>filter</name></member>
<member refid="classatsci__fs__checker_1a288226c4f2a57a161e84bf4de935169e" prot="public" virt="pure-virtual"><scope>atsci_fs_checker</scope><name>reset</name></member>
<member refid="classatsci__fs__checker_1a61ce2227deb80a8d6921851171842c71" prot="public" virt="pure-virtual"><scope>atsci_fs_checker</scope><name>~atsci_fs_checker</name></member>
</listofallmembers>
</compounddef>
</doxygen>
