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

.. only:: html

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

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

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

.. _sphx_glr_grid_examples_PyFstat_example_grid_search_F0F1.py:


Directed grid search: Linear spindown
==========================================

Search for CW signal including one spindown parameter
using a parameter space grid (i.e. no MCMC).

.. GENERATED FROM PYTHON SOURCE LINES 8-115

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


    import os

    import numpy as np

    import pyfstat

    label = "PyFstatExampleGridSearchF0F1"
    outdir = os.path.join("PyFstat_example_data", label)
    logger = pyfstat.set_up_logger(label=label, outdir=outdir)

    # Properties of the GW data
    sqrtSX = 1e-23
    tstart = 1000000000
    duration = 10 * 86400
    tend = tstart + duration
    tref = 0.5 * (tstart + tend)
    IFOs = "H1"

    # parameters for injected signals
    depth = 20
    inj = {
        "tref": tref,
        "F0": 30.0,
        "F1": -1e-10,
        "F2": 0,
        "Alpha": 1.0,
        "Delta": 1.5,
        "h0": sqrtSX / depth,
        "cosi": 0.0,
    }

    data = pyfstat.Writer(
        label=label,
        outdir=outdir,
        tstart=tstart,
        duration=duration,
        sqrtSX=sqrtSX,
        detectors=IFOs,
        **inj,
    )
    data.make_data()

    m = 0.01
    dF0 = np.sqrt(12 * m) / (np.pi * duration)
    dF1 = np.sqrt(180 * m) / (np.pi * duration**2)
    dF2 = 1e-17
    N = 100
    DeltaF0 = N * dF0
    DeltaF1 = N * dF1
    F0s = [inj["F0"] - DeltaF0 / 2.0, inj["F0"] + DeltaF0 / 2.0, dF0]
    F1s = [inj["F1"] - DeltaF1 / 2.0, inj["F1"] + DeltaF1 / 2.0, dF1]
    F2s = [inj["F2"]]
    Alphas = [inj["Alpha"]]
    Deltas = [inj["Delta"]]
    search = pyfstat.GridSearch(
        label=label,
        outdir=outdir,
        sftfilepattern=data.sftfilepath,
        F0s=F0s,
        F1s=F1s,
        F2s=F2s,
        Alphas=Alphas,
        Deltas=Deltas,
        tref=tref,
        minStartTime=tstart,
        maxStartTime=tend,
    )
    search.run()

    # report details of the maximum point
    max_dict = search.get_max_twoF()
    logger.info(
        "max2F={:.4f} from GridSearch, offsets from injection: {:s}.".format(
            max_dict["twoF"],
            ", ".join(
                [
                    "{:.4e} in {:s}".format(max_dict[key] - inj[key], key)
                    for key in max_dict.keys()
                    if not key == "twoF"
                ]
            ),
        )
    )
    search.generate_loudest()

    logger.info("Plotting 2F(F0)...")
    search.plot_1D(xkey="F0", xlabel="freq [Hz]", ylabel="$2\\mathcal{F}$")
    logger.info("Plotting 2F(F1)...")
    search.plot_1D(xkey="F1")
    logger.info("Plotting 2F(F0,F1)...")
    search.plot_2D(xkey="F0", ykey="F1", colorbar=True)

    logger.info("Making gridcorner plot...")
    F0_vals = np.unique(search.data["F0"]) - inj["F0"]
    F1_vals = np.unique(search.data["F1"]) - inj["F1"]
    twoF = search.data["twoF"].reshape((len(F0_vals), len(F1_vals)))
    xyz = [F0_vals, F1_vals]
    labels = [
        "$f - f_0$",
        "$\\dot{f} - \\dot{f}_0$",
        "$\\widetilde{2\\mathcal{F}}$",
    ]
    fig, axes = pyfstat.gridcorner(
        twoF, xyz, projection="log_mean", labels=labels, whspace=0.1, factor=1.8
    )
    fig.savefig(os.path.join(outdir, label + "_projection_matrix.png"))


.. _sphx_glr_download_grid_examples_PyFstat_example_grid_search_F0F1.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_grid_search_F0F1.ipynb <PyFstat_example_grid_search_F0F1.ipynb>`

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

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

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

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


.. only:: html

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

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