.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "user-guide/model-gallery/temporal/plot_template_phase_temporal.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

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

        :ref:`Go to the end <sphx_glr_download_user-guide_model-gallery_temporal_plot_template_phase_temporal.py>`
        to download the full example code. or to run this example in your browser via Binder

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

.. _sphx_glr_user-guide_model-gallery_temporal_plot_template_phase_temporal.py:


.. _PhaseCurve-temporal-model:

Phase curve temporal model
==========================

This model parametrises a PhaseCurve time model, i.e. with a template phasogram and timing parameters

.. GENERATED FROM PYTHON SOURCE LINES 10-29

.. code-block:: Python


    import astropy.units as u
    from astropy.time import Time
    from gammapy.modeling.models import (
        Models,
        PowerLawSpectralModel,
        SkyModel,
        TemplatePhaseCurveTemporalModel,
    )

    path = "$GAMMAPY_DATA/tests/phasecurve_LSI_DC.fits"
    t_ref = 43366.275 * u.d
    f0 = 1.0 / (26.7 * u.d)

    phase_model = TemplatePhaseCurveTemporalModel.read(path, t_ref, 0.0, f0)
    time_range = [Time("59100", format="mjd"), Time("59200", format="mjd")]

    phase_model.plot(time_range, n_points=400)




.. image-sg:: /user-guide/model-gallery/temporal/images/sphx_glr_plot_template_phase_temporal_001.png
   :alt: plot template phase temporal
   :srcset: /user-guide/model-gallery/temporal/images/sphx_glr_plot_template_phase_temporal_001.png
   :class: sphx-glr-single-img


.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    <Axes: xlabel='Time [iso]', ylabel='Norm / A.U.'>



.. GENERATED FROM PYTHON SOURCE LINES 30-33

YAML representation
-------------------
Here is an example YAML file using the model:

.. GENERATED FROM PYTHON SOURCE LINES 33-42

.. code-block:: Python


    model = SkyModel(
        spectral_model=PowerLawSpectralModel(),
        temporal_model=phase_model,
        name="phase_curve_model",
    )
    models = Models([model])

    print(models.to_yaml())




.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    components:
    -   name: phase_curve_model
        type: SkyModel
        spectral:
            type: PowerLawSpectralModel
            parameters:
            -   name: index
                value: 2.0
            -   name: amplitude
                value: 1.0e-12
                unit: cm-2 s-1 TeV-1
            -   name: reference
                value: 1.0
                unit: TeV
        temporal:
            type: TemplatePhaseCurveTemporalModel
            parameters:
            -   name: t_ref
                value: 43366.275
                unit: d
            -   name: phi_ref
                value: 0.0
            -   name: f0
                value: 0.03745318352059925
                unit: d-1
            -   name: f1
                value: 0.0
                unit: s-2
            -   name: f2
                value: 0.0
                unit: s-3
            scale: utc
            filename: /home/runner/work/gammapy-docs/gammapy-docs/gammapy-datasets/dev/tests/phasecurve_LSI_DC.fits
    metadata:
        creator: Gammapy 1.3.dev241+g0271bebfc
        date: '2024-05-03T15:02:32.300910'
        origin: null






.. _sphx_glr_download_user-guide_model-gallery_temporal_plot_template_phase_temporal.py:

.. only:: html

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

    .. container:: binder-badge

      .. image:: images/binder_badge_logo.svg
        :target: https://mybinder.org/v2/gh/gammapy/gammapy-webpage/main?urlpath=lab/tree/notebooks/dev/user-guide/model-gallery/temporal/plot_template_phase_temporal.ipynb
        :alt: Launch binder
        :width: 150 px

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

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

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

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


.. only:: html

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

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