.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "transient_examples/PyFstat_example_short_transient_grid_search.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_transient_examples_PyFstat_example_short_transient_grid_search.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_transient_examples_PyFstat_example_short_transient_grid_search.py:


Short transient grid search
===========================

An example grid-based search for a short transient signal.
By default, the standard persistent-CW 2F-statistic
and the transient max2F statistic are compared.

You can turn on either `BSGL = True` or `BtSG = True` (not both!)
to test alternative statistics.

This is also ready to use on a GPU,
if you have one available and `pycuda` installed.
Just change to `tCWFstatMapVersion = "pycuda"`.

.. GENERATED FROM PYTHON SOURCE LINES 16-94

.. code-block:: Python
   :lineno-start: 17


    import os

    import numpy as np
    import PyFstat_example_make_data_for_short_transient_search as data

    import pyfstat

    tCWFstatMapVersion = "lal"

    if __name__ == "__main__":
        label = "PyFstatExampleShortTransientGridSearch"
        logger = pyfstat.set_up_logger(label=label, outdir=data.outdir)
        if not os.path.isdir(data.outdir) or not np.any(
            [f.endswith(".sft") for f in os.listdir(data.outdir)]
        ):
            raise RuntimeError(
                "Please first run PyFstat_example_make_data_for_short_transient_search.py !"
            )

        maxStartTime = data.tstart + data.duration

        m = 0.001
        dF0 = np.sqrt(12 * m) / (np.pi * data.duration)
        DeltaF0 = 100 * dF0
        F0s = [data.F0 - DeltaF0 / 2.0, data.F0 + DeltaF0 / 2.0, dF0]
        F1s = [data.F1]
        F2s = [data.F2]
        Alphas = [data.Alpha]
        Deltas = [data.Delta]

        BSGL = False
        BtSG = False

        logger.info("Standard CW search:")
        search1 = pyfstat.GridSearch(
            label=label + f"CW{'BSGL' if BSGL else ''}",
            outdir=data.outdir,
            sftfilepattern=os.path.join(data.outdir, f"*{data.label}*sft"),
            F0s=F0s,
            F1s=F1s,
            F2s=F2s,
            Alphas=Alphas,
            Deltas=Deltas,
            tref=data.tref,
            BSGL=BSGL,
        )
        search1.run()
        search1.print_max_twoF()
        search1.plot_1D(
            xkey="F0", xlabel="freq [Hz]", ylabel=search1.tex_labels[search1.detstat]
        )

        logger.info("with t0,tau bands:")
        label = f"tCW{'_BSGL' if BSGL else ''}{'_BtSG' if BtSG else ''}_FstatMap_{tCWFstatMapVersion}"
        search2 = pyfstat.TransientGridSearch(
            label=label,
            outdir=data.outdir,
            sftfilepattern=os.path.join(data.outdir, f"*{data.label}*sft"),
            F0s=F0s,
            F1s=F1s,
            F2s=F2s,
            Alphas=Alphas,
            Deltas=Deltas,
            tref=data.tref,
            transientWindowType="rect",
            t0Band=data.duration - 2 * data.Tsft,
            tauBand=data.duration,
            outputTransientFstatMap=True,
            tCWFstatMapVersion=tCWFstatMapVersion,
            BSGL=BSGL,
            BtSG=BtSG,
        )
        search2.run()
        search2.print_max_twoF()
        search2.plot_1D(
            xkey="F0", xlabel="freq [Hz]", ylabel=search2.tex_labels[search2.detstat]
        )


.. _sphx_glr_download_transient_examples_PyFstat_example_short_transient_grid_search.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: PyFstat_example_short_transient_grid_search.ipynb <PyFstat_example_short_transient_grid_search.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: PyFstat_example_short_transient_grid_search.py <PyFstat_example_short_transient_grid_search.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: PyFstat_example_short_transient_grid_search.zip <PyFstat_example_short_transient_grid_search.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_