<?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.14.0" xml:lang="en-US">
  <compounddef id="classgr_1_1satellites_1_1doppler__correction" kind="class" language="C++" prot="public">
    <compoundname>gr::satellites::doppler_correction</compoundname>
    <basecompoundref prot="public" virt="virtual">gr::sync_block</basecompoundref>
    <derivedcompoundref refid="classgr_1_1satellites_1_1doppler__correction__impl" prot="public" virt="non-virtual">gr::satellites::doppler_correction_impl</derivedcompoundref>
    <includes refid="doppler__correction_8h" local="no">doppler_correction.h</includes>
    <sectiondef kind="public-type">
      <memberdef kind="typedef" id="classgr_1_1satellites_1_1doppler__correction_1a5a3e4fd4fd1a63558a1ebdcf5fb980a7" prot="public" static="no">
        <type>boost::shared_ptr&lt; <ref refid="classgr_1_1satellites_1_1doppler__correction" kindref="compound">doppler_correction</ref> &gt;</type>
        <definition>typedef boost::shared_ptr&lt;doppler_correction&gt; gr::satellites::doppler_correction::sptr</definition>
        <argsstring></argsstring>
        <name>sptr</name>
        <qualifiedname>gr::satellites::doppler_correction::sptr</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/opt/local/var/macports/build/gr-satellites-4c327f95/work/gr-satellites-3.16.0/include/satellites/doppler_correction.h" line="48" column="31" bodyfile="/opt/local/var/macports/build/gr-satellites-4c327f95/work/gr-satellites-3.16.0/include/satellites/doppler_correction.h" bodystart="48" bodyend="-1"/>
      </memberdef>
    </sectiondef>
    <sectiondef kind="public-static-func">
      <memberdef kind="function" id="classgr_1_1satellites_1_1doppler__correction_1adf53c515850a3871cbaa9ada70b9e955" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="classgr_1_1satellites_1_1doppler__correction_1a5a3e4fd4fd1a63558a1ebdcf5fb980a7" kindref="member">sptr</ref></type>
        <definition>static sptr gr::satellites::doppler_correction::make</definition>
        <argsstring>(const char *filename, double samp_rate, double t0)</argsstring>
        <name>make</name>
        <qualifiedname>gr::satellites::doppler_correction::make</qualifiedname>
        <param>
          <type>const char *</type>
          <declname>filename</declname>
        </param>
        <param>
          <type>double</type>
          <declname>samp_rate</declname>
        </param>
        <param>
          <type>double</type>
          <declname>t0</declname>
        </param>
        <briefdescription>
<para>Build the Doppler Correction block. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>filename</parametername>
</parameternamelist>
<parameterdescription>
<para>Path of the text file describing the Doppler data </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>samp_rate</parametername>
</parameternamelist>
<parameterdescription>
<para>Sample rate </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>t0</parametername>
</parameternamelist>
<parameterdescription>
<para>Timestamp corresponding to the first sample </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/opt/local/var/macports/build/gr-satellites-4c327f95/work/gr-satellites-3.16.0/include/satellites/doppler_correction.h" line="57" column="17"/>
      </memberdef>
    </sectiondef>
    <briefdescription>
<para>Performs Doppler correction using a frequency vs. time file. </para>
    </briefdescription>
    <detaileddescription>
<para>The Doppler Correction block uses a text file listing frequency vs. time to perform Doppler correction on its input signal. The same block can be used for Doppler simulation by inverting the frequency values in the input file or by taking the complex conjugate of the output of the block.</para>
<para>The text file should contain lines with a timestamp and a frequency separated by a space. The timestamps are given in seconds, and typically consist of UNIX time. The t0 parameter in the block constructor gives the starting time, which is the timestamp corresponding to the first sample processed by the block. As long as the timestamps in the file and this timestamp are consistent, the block will work correctly. The frequencies are given in Hz.</para>
<para>The block can also use time tags such as those generated by the UHD Source block to update its internal timestamp. In this case the timestamps in the file should use UNIX seconds, since the UHD timestamps also use UNIX seconds. When using UHD time tags, the t0 parameter can be left as 0.</para>
<para>The Doppler correction block interpolates the frequency linearly between each pair of entries in the text file, and generates a correction with continuous phase. </para>
    </detaileddescription>
    <inheritancegraph>
      <node id="1">
        <label>gr::satellites::doppler_correction</label>
        <link refid="classgr_1_1satellites_1_1doppler__correction"/>
        <childnode refid="2" relation="public-inheritance">
        </childnode>
      </node>
      <node id="3">
        <label>gr::satellites::doppler_correction_impl</label>
        <link refid="classgr_1_1satellites_1_1doppler__correction__impl"/>
        <childnode refid="1" relation="public-inheritance">
        </childnode>
      </node>
      <node id="2">
        <label>gr::sync_block</label>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="1">
        <label>gr::satellites::doppler_correction</label>
        <link refid="classgr_1_1satellites_1_1doppler__correction"/>
        <childnode refid="2" relation="public-inheritance">
        </childnode>
      </node>
      <node id="2">
        <label>gr::sync_block</label>
      </node>
    </collaborationgraph>
    <location file="/opt/local/var/macports/build/gr-satellites-4c327f95/work/gr-satellites-3.16.0/include/satellites/doppler_correction.h" line="45" column="1" bodyfile="/opt/local/var/macports/build/gr-satellites-4c327f95/work/gr-satellites-3.16.0/include/satellites/doppler_correction.h" bodystart="46" bodyend="58"/>
    <listofallmembers>
      <member refid="classgr_1_1satellites_1_1doppler__correction_1adf53c515850a3871cbaa9ada70b9e955" prot="public" virt="non-virtual"><scope>gr::satellites::doppler_correction</scope><name>make</name></member>
      <member refid="classgr_1_1satellites_1_1doppler__correction_1a5a3e4fd4fd1a63558a1ebdcf5fb980a7" prot="public" virt="non-virtual"><scope>gr::satellites::doppler_correction</scope><name>sptr</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
