:py:mod:`castor_etc.spectra.models.flare`
=========================================

.. py:module:: castor_etc.spectra.models.flare

.. autodoc2-docstring:: castor_etc.spectra.models.flare
   :parser: myst
   :allowtitles:

Module Contents
---------------

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`boxcar_height_function_default <castor_etc.spectra.models.flare.boxcar_height_function_default>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare.boxcar_height_function_default
          :parser: myst
          :summary:
   * - :py:obj:`_kw_or_default <castor_etc.spectra.models.flare._kw_or_default>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare._kw_or_default
          :parser: myst
          :summary:
   * - :py:obj:`_check_unit <castor_etc.spectra.models.flare._check_unit>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare._check_unit
          :parser: myst
          :summary:
   * - :py:obj:`_integrate_spec_table <castor_etc.spectra.models.flare._integrate_spec_table>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare._integrate_spec_table
          :parser: myst
          :summary:
   * - :py:obj:`add_indent <castor_etc.spectra.models.flare.add_indent>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare.add_indent
          :parser: myst
          :summary:
   * - :py:obj:`_get_param_string <castor_etc.spectra.models.flare._get_param_string>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare._get_param_string
          :parser: myst
          :summary:
   * - :py:obj:`_format_doc <castor_etc.spectra.models.flare._format_doc>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare._format_doc
          :parser: myst
          :summary:
   * - :py:obj:`_P3 <castor_etc.spectra.models.flare._P3>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare._P3
          :parser: myst
          :summary:
   * - :py:obj:`_blackbody_partial_integral <castor_etc.spectra.models.flare._blackbody_partial_integral>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare._blackbody_partial_integral
          :parser: myst
          :summary:
   * - :py:obj:`blackbody_binned <castor_etc.spectra.models.flare.blackbody_binned>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare.blackbody_binned
          :parser: myst
          :summary:
   * - :py:obj:`blackbody_points <castor_etc.spectra.models.flare.blackbody_points>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare.blackbody_points
          :parser: myst
          :summary:
   * - :py:obj:`rebin <castor_etc.spectra.models.flare.rebin>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare.rebin
          :parser: myst
          :summary:
   * - :py:obj:`power_rv <castor_etc.spectra.models.flare.power_rv>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare.power_rv
          :parser: myst
          :summary:
   * - :py:obj:`shot_times <castor_etc.spectra.models.flare.shot_times>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare.shot_times
          :parser: myst
          :summary:
   * - :py:obj:`boxcar_decay <castor_etc.spectra.models.flare.boxcar_decay>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare.boxcar_decay
          :parser: myst
          :summary:
   * - :py:obj:`filter_to_SiIV_energy <castor_etc.spectra.models.flare.filter_to_SiIV_energy>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare.filter_to_SiIV_energy
          :parser: myst
          :summary:
   * - :py:obj:`flare_lightcurve <castor_etc.spectra.models.flare.flare_lightcurve>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare.flare_lightcurve
          :parser: myst
          :summary:
   * - :py:obj:`flare_rate <castor_etc.spectra.models.flare.flare_rate>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare.flare_rate
          :parser: myst
          :summary:
   * - :py:obj:`flare_series <castor_etc.spectra.models.flare.flare_series>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare.flare_series
          :parser: myst
          :summary:
   * - :py:obj:`flare_series_lightcurve <castor_etc.spectra.models.flare.flare_series_lightcurve>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare.flare_series_lightcurve
          :parser: myst
          :summary:
   * - :py:obj:`flare_spectrum <castor_etc.spectra.models.flare.flare_spectrum>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare.flare_spectrum
          :parser: myst
          :summary:
   * - :py:obj:`flare_spectra <castor_etc.spectra.models.flare.flare_spectra>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare.flare_spectra
          :parser: myst
          :summary:
   * - :py:obj:`flare_series_spectra <castor_etc.spectra.models.flare.flare_series_spectra>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare.flare_series_spectra
          :parser: myst
          :summary:
   * - :py:obj:`compute_flux_wavelength <castor_etc.spectra.models.flare.compute_flux_wavelength>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare.compute_flux_wavelength
          :parser: myst
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`FLARE_DATA_PATH <castor_etc.spectra.models.flare.FLARE_DATA_PATH>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare.FLARE_DATA_PATH
          :parser: myst
          :summary:
   * - :py:obj:`default_flarespec_path <castor_etc.spectra.models.flare.default_flarespec_path>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare.default_flarespec_path
          :parser: myst
          :summary:
   * - :py:obj:`default_flarespec <castor_etc.spectra.models.flare.default_flarespec>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare.default_flarespec
          :parser: myst
          :summary:
   * - :py:obj:`fuv <castor_etc.spectra.models.flare.fuv>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare.fuv
          :parser: myst
          :summary:
   * - :py:obj:`nuv <castor_etc.spectra.models.flare.nuv>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare.nuv
          :parser: myst
          :summary:
   * - :py:obj:`flare_defaults <castor_etc.spectra.models.flare.flare_defaults>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare.flare_defaults
          :parser: myst
          :summary:
   * - :py:obj:`_fd <castor_etc.spectra.models.flare._fd>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare._fd
          :parser: myst
          :summary:
   * - :py:obj:`_flare_params_doc <castor_etc.spectra.models.flare._flare_params_doc>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare._flare_params_doc
          :parser: myst
          :summary:
   * - :py:obj:`_param_doc_dic <castor_etc.spectra.models.flare._param_doc_dic>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare._param_doc_dic
          :parser: myst
          :summary:
   * - :py:obj:`_tbins_doc <castor_etc.spectra.models.flare._tbins_doc>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare._tbins_doc
          :parser: myst
          :summary:
   * - :py:obj:`_wbins_doc <castor_etc.spectra.models.flare._wbins_doc>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare._wbins_doc
          :parser: myst
          :summary:
   * - :py:obj:`_t0_doc <castor_etc.spectra.models.flare._t0_doc>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare._t0_doc
          :parser: myst
          :summary:
   * - :py:obj:`_eqd_doc <castor_etc.spectra.models.flare._eqd_doc>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare._eqd_doc
          :parser: myst
          :summary:
   * - :py:obj:`_Li <castor_etc.spectra.models.flare._Li>`
     - .. autodoc2-docstring:: castor_etc.spectra.models.flare._Li
          :parser: myst
          :summary:

API
~~~

.. py:data:: FLARE_DATA_PATH
   :canonical: castor_etc.spectra.models.flare.FLARE_DATA_PATH
   :value: None

   .. autodoc2-docstring:: castor_etc.spectra.models.flare.FLARE_DATA_PATH
      :parser: myst

.. py:data:: default_flarespec_path
   :canonical: castor_etc.spectra.models.flare.default_flarespec_path
   :value: None

   .. autodoc2-docstring:: castor_etc.spectra.models.flare.default_flarespec_path
      :parser: myst

.. py:data:: default_flarespec
   :canonical: castor_etc.spectra.models.flare.default_flarespec
   :value: 'read(...)'

   .. autodoc2-docstring:: castor_etc.spectra.models.flare.default_flarespec
      :parser: myst

.. py:data:: fuv
   :canonical: castor_etc.spectra.models.flare.fuv
   :value: None

   .. autodoc2-docstring:: castor_etc.spectra.models.flare.fuv
      :parser: myst

.. py:data:: nuv
   :canonical: castor_etc.spectra.models.flare.nuv
   :value: None

   .. autodoc2-docstring:: castor_etc.spectra.models.flare.nuv
      :parser: myst

.. py:function:: boxcar_height_function_default(eqd)
   :canonical: castor_etc.spectra.models.flare.boxcar_height_function_default

   .. autodoc2-docstring:: castor_etc.spectra.models.flare.boxcar_height_function_default
      :parser: myst

.. py:data:: flare_defaults
   :canonical: castor_etc.spectra.models.flare.flare_defaults
   :value: 'dict(...)'

   .. autodoc2-docstring:: castor_etc.spectra.models.flare.flare_defaults
      :parser: myst

.. py:function:: _kw_or_default(kws, keys)
   :canonical: castor_etc.spectra.models.flare._kw_or_default

   .. autodoc2-docstring:: castor_etc.spectra.models.flare._kw_or_default
      :parser: myst

.. py:function:: _check_unit(func, var, unit)
   :canonical: castor_etc.spectra.models.flare._check_unit

   .. autodoc2-docstring:: castor_etc.spectra.models.flare._check_unit
      :parser: myst

.. py:function:: _integrate_spec_table(spec_table)
   :canonical: castor_etc.spectra.models.flare._integrate_spec_table

   .. autodoc2-docstring:: castor_etc.spectra.models.flare._integrate_spec_table
      :parser: myst

.. py:data:: _fd
   :canonical: castor_etc.spectra.models.flare._fd
   :value: None

   .. autodoc2-docstring:: castor_etc.spectra.models.flare._fd
      :parser: myst

.. py:data:: _flare_params_doc
   :canonical: castor_etc.spectra.models.flare._flare_params_doc
   :value: <Multiline-String>

   .. autodoc2-docstring:: castor_etc.spectra.models.flare._flare_params_doc
      :parser: myst

.. py:data:: _param_doc_dic
   :canonical: castor_etc.spectra.models.flare._param_doc_dic
   :value: 'dict(...)'

   .. autodoc2-docstring:: castor_etc.spectra.models.flare._param_doc_dic
      :parser: myst

.. py:data:: _tbins_doc
   :canonical: castor_etc.spectra.models.flare._tbins_doc
   :value: <Multiline-String>

   .. autodoc2-docstring:: castor_etc.spectra.models.flare._tbins_doc
      :parser: myst

.. py:data:: _wbins_doc
   :canonical: castor_etc.spectra.models.flare._wbins_doc
   :value: <Multiline-String>

   .. autodoc2-docstring:: castor_etc.spectra.models.flare._wbins_doc
      :parser: myst

.. py:data:: _t0_doc
   :canonical: castor_etc.spectra.models.flare._t0_doc
   :value: <Multiline-String>

   .. autodoc2-docstring:: castor_etc.spectra.models.flare._t0_doc
      :parser: myst

.. py:data:: _eqd_doc
   :canonical: castor_etc.spectra.models.flare._eqd_doc
   :value: <Multiline-String>

   .. autodoc2-docstring:: castor_etc.spectra.models.flare._eqd_doc
      :parser: myst

.. py:function:: add_indent(txt)
   :canonical: castor_etc.spectra.models.flare.add_indent

   .. autodoc2-docstring:: castor_etc.spectra.models.flare.add_indent
      :parser: myst

.. py:function:: _get_param_string(*keys)
   :canonical: castor_etc.spectra.models.flare._get_param_string

   .. autodoc2-docstring:: castor_etc.spectra.models.flare._get_param_string
      :parser: myst

.. py:function:: _format_doc(func, **kws)
   :canonical: castor_etc.spectra.models.flare._format_doc

   .. autodoc2-docstring:: castor_etc.spectra.models.flare._format_doc
      :parser: myst

.. py:data:: _Li
   :canonical: castor_etc.spectra.models.flare._Li
   :value: None

   .. autodoc2-docstring:: castor_etc.spectra.models.flare._Li
      :parser: myst

.. py:function:: _P3(x)
   :canonical: castor_etc.spectra.models.flare._P3

   .. autodoc2-docstring:: castor_etc.spectra.models.flare._P3
      :parser: myst

.. py:function:: _blackbody_partial_integral(w, T)
   :canonical: castor_etc.spectra.models.flare._blackbody_partial_integral

   .. autodoc2-docstring:: castor_etc.spectra.models.flare._blackbody_partial_integral
      :parser: myst

.. py:function:: blackbody_binned(wbins, T, bolometric=None)
   :canonical: castor_etc.spectra.models.flare.blackbody_binned

   .. autodoc2-docstring:: castor_etc.spectra.models.flare.blackbody_binned
      :parser: myst

.. py:function:: blackbody_points(w, T, bolometric=None)
   :canonical: castor_etc.spectra.models.flare.blackbody_points

   .. autodoc2-docstring:: castor_etc.spectra.models.flare.blackbody_points
      :parser: myst

.. py:function:: rebin(bins_new, bins_old, y)
   :canonical: castor_etc.spectra.models.flare.rebin

   .. autodoc2-docstring:: castor_etc.spectra.models.flare.rebin
      :parser: myst

.. py:function:: power_rv(min, max, cumulative_index, n)
   :canonical: castor_etc.spectra.models.flare.power_rv

   .. autodoc2-docstring:: castor_etc.spectra.models.flare.power_rv
      :parser: myst

.. py:function:: shot_times(rate, time_span)
   :canonical: castor_etc.spectra.models.flare.shot_times

   .. autodoc2-docstring:: castor_etc.spectra.models.flare.shot_times
      :parser: myst

.. py:function:: boxcar_decay(tbins, t0, area_box, height_box, area_decay)
   :canonical: castor_etc.spectra.models.flare.boxcar_decay

   .. autodoc2-docstring:: castor_etc.spectra.models.flare.boxcar_decay
      :parser: myst

.. py:function:: filter_to_SiIV_energy(filter_wave, filter_response, energy, **flare_params)
   :canonical: castor_etc.spectra.models.flare.filter_to_SiIV_energy

   .. autodoc2-docstring:: castor_etc.spectra.models.flare.filter_to_SiIV_energy
      :parser: myst

.. py:function:: flare_lightcurve(tbins, t0, eqd, **flare_params)
   :canonical: castor_etc.spectra.models.flare.flare_lightcurve

   .. autodoc2-docstring:: castor_etc.spectra.models.flare.flare_lightcurve
      :parser: myst

.. py:function:: flare_rate(**flare_params)
   :canonical: castor_etc.spectra.models.flare.flare_rate

   .. autodoc2-docstring:: castor_etc.spectra.models.flare.flare_rate
      :parser: myst

.. py:function:: flare_series(time_span, **flare_params)
   :canonical: castor_etc.spectra.models.flare.flare_series

   .. autodoc2-docstring:: castor_etc.spectra.models.flare.flare_series
      :parser: myst

.. py:function:: flare_series_lightcurve(tbins, return_flares=False, **flare_params)
   :canonical: castor_etc.spectra.models.flare.flare_series_lightcurve

   .. autodoc2-docstring:: castor_etc.spectra.models.flare.flare_series_lightcurve
      :parser: myst

.. py:function:: flare_spectrum(wbins, SiIV, **flare_params)
   :canonical: castor_etc.spectra.models.flare.flare_spectrum

   .. autodoc2-docstring:: castor_etc.spectra.models.flare.flare_spectrum
      :parser: myst

.. py:function:: flare_spectra(wbins, tbins, t0, eqd, **flare_params)
   :canonical: castor_etc.spectra.models.flare.flare_spectra

   .. autodoc2-docstring:: castor_etc.spectra.models.flare.flare_spectra
      :parser: myst

.. py:function:: flare_series_spectra(wbins, tbins, **flare_params)
   :canonical: castor_etc.spectra.models.flare.flare_series_spectra

   .. autodoc2-docstring:: castor_etc.spectra.models.flare.flare_series_spectra
      :parser: myst

.. py:function:: compute_flux_wavelength(star_radius, star_eff_temp, dist_to_star, show_figure)
   :canonical: castor_etc.spectra.models.flare.compute_flux_wavelength

   .. autodoc2-docstring:: castor_etc.spectra.models.flare.compute_flux_wavelength
      :parser: myst