:py:mod:`castor_etc.spectra.base`
=================================

.. py:module:: castor_etc.spectra.base

.. autodoc2-docstring:: castor_etc.spectra.base
   :parser: myst
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`SpectrumMixin <castor_etc.spectra.base.SpectrumMixin>`
     - .. autodoc2-docstring:: castor_etc.spectra.base.SpectrumMixin
          :parser: myst
          :summary:
   * - :py:obj:`NormMixin <castor_etc.spectra.base.NormMixin>`
     - .. autodoc2-docstring:: castor_etc.spectra.base.NormMixin
          :parser: myst
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`getStarData <castor_etc.spectra.base.getStarData>`
     - .. autodoc2-docstring:: castor_etc.spectra.base.getStarData
          :parser: myst
          :summary:
   * - :py:obj:`interp_EEM_table <castor_etc.spectra.base.interp_EEM_table>`
     - .. autodoc2-docstring:: castor_etc.spectra.base.interp_EEM_table
          :parser: myst
          :summary:
   * - :py:obj:`redshift_wavelengths <castor_etc.spectra.base.redshift_wavelengths>`
     - .. autodoc2-docstring:: castor_etc.spectra.base.redshift_wavelengths
          :parser: myst
          :summary:

Data
~~~~

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

   * - :py:obj:`fnu <castor_etc.spectra.base.fnu>`
     - .. autodoc2-docstring:: castor_etc.spectra.base.fnu
          :parser: myst
          :summary:
   * - :py:obj:`flam <castor_etc.spectra.base.flam>`
     - .. autodoc2-docstring:: castor_etc.spectra.base.flam
          :parser: myst
          :summary:

API
~~~

.. py:data:: fnu
   :canonical: castor_etc.spectra.base.fnu
   :value: 'def_unit(...)'

   .. autodoc2-docstring:: castor_etc.spectra.base.fnu
      :parser: myst

.. py:data:: flam
   :canonical: castor_etc.spectra.base.flam
   :value: 'def_unit(...)'

   .. autodoc2-docstring:: castor_etc.spectra.base.flam
      :parser: myst

.. py:function:: getStarData(temperature, metallicity, logg, stellar_model_dir, model_grid='ATLAS9')
   :canonical: castor_etc.spectra.base.getStarData

   .. autodoc2-docstring:: castor_etc.spectra.base.getStarData
      :parser: myst

.. py:function:: interp_EEM_table(Teff=[], Gmag=[], Bpmag=[], Rpmag=[])
   :canonical: castor_etc.spectra.base.interp_EEM_table

   .. autodoc2-docstring:: castor_etc.spectra.base.interp_EEM_table
      :parser: myst

.. py:function:: redshift_wavelengths(wavelengths, redshift)
   :canonical: castor_etc.spectra.base.redshift_wavelengths

   .. autodoc2-docstring:: castor_etc.spectra.base.redshift_wavelengths
      :parser: myst

.. py:class:: SpectrumMixin
   :canonical: castor_etc.spectra.base.SpectrumMixin

   .. autodoc2-docstring:: castor_etc.spectra.base.SpectrumMixin
      :parser: myst

   .. py:attribute:: __spectrum
      :canonical: castor_etc.spectra.base.SpectrumMixin.__spectrum
      :value: None

      .. autodoc2-docstring:: castor_etc.spectra.base.SpectrumMixin.__spectrum
         :parser: myst

   .. py:attribute:: __wavelengths
      :canonical: castor_etc.spectra.base.SpectrumMixin.__wavelengths
      :value: None

      .. autodoc2-docstring:: castor_etc.spectra.base.SpectrumMixin.__wavelengths
         :parser: myst

   .. py:property:: spectrum
      :canonical: castor_etc.spectra.base.SpectrumMixin.spectrum

      .. autodoc2-docstring:: castor_etc.spectra.base.SpectrumMixin.spectrum
         :parser: myst

   .. py:property:: wavelengths
      :canonical: castor_etc.spectra.base.SpectrumMixin.wavelengths

      .. autodoc2-docstring:: castor_etc.spectra.base.SpectrumMixin.wavelengths
         :parser: myst

   .. py:property:: _spectrum
      :canonical: castor_etc.spectra.base.SpectrumMixin._spectrum

      .. autodoc2-docstring:: castor_etc.spectra.base.SpectrumMixin._spectrum
         :parser: myst

   .. py:property:: _wavelengths
      :canonical: castor_etc.spectra.base.SpectrumMixin._wavelengths

      .. autodoc2-docstring:: castor_etc.spectra.base.SpectrumMixin._wavelengths
         :parser: myst

   .. py:method:: _check_existing_spectrum(overwrite, quiet=False)
      :canonical: castor_etc.spectra.base.SpectrumMixin._check_existing_spectrum

      .. autodoc2-docstring:: castor_etc.spectra.base.SpectrumMixin._check_existing_spectrum
         :parser: myst

   .. py:method:: spectrum_erg_to_photon()
      :canonical: castor_etc.spectra.base.SpectrumMixin.spectrum_erg_to_photon

      .. autodoc2-docstring:: castor_etc.spectra.base.SpectrumMixin.spectrum_erg_to_photon
         :parser: myst

   .. py:method:: redshift_wavelengths(redshift)
      :canonical: castor_etc.spectra.base.SpectrumMixin.redshift_wavelengths

      .. autodoc2-docstring:: castor_etc.spectra.base.SpectrumMixin.redshift_wavelengths
         :parser: myst

   .. py:method:: generate_uniform(wavelengths, value, unit='ABmag', overwrite=False, quiet=False)
      :canonical: castor_etc.spectra.base.SpectrumMixin.generate_uniform

      .. autodoc2-docstring:: castor_etc.spectra.base.SpectrumMixin.generate_uniform
         :parser: myst

   .. py:method:: generate_bb(T, redshift=0.0, emissivity=1.0, wavelengths=None, limits=[0.09, 1.2] << u.um, resolution=1 << u.nm, radius=1, dist=1 << u.kpc, overwrite=False, quiet=False)
      :canonical: castor_etc.spectra.base.SpectrumMixin.generate_bb

      .. autodoc2-docstring:: castor_etc.spectra.base.SpectrumMixin.generate_bb
         :parser: myst

   .. py:method:: generate_power_law(ref_wavelength, wavelengths, exponent, overwrite=False, quiet=False)
      :canonical: castor_etc.spectra.base.SpectrumMixin.generate_power_law

      .. autodoc2-docstring:: castor_etc.spectra.base.SpectrumMixin.generate_power_law
         :parser: myst

   .. py:method:: _generate_gaussian(wavelengths, spectrum, center, fwhm, peak=None, tot_flux=None, add=True, abs_peak=True)
      :canonical: castor_etc.spectra.base.SpectrumMixin._generate_gaussian
      :staticmethod:

      .. autodoc2-docstring:: castor_etc.spectra.base.SpectrumMixin._generate_gaussian
         :parser: myst

   .. py:method:: _generate_lorentzian(wavelengths, spectrum, center, fwhm, peak=None, tot_flux=None, add=True, abs_peak=True)
      :canonical: castor_etc.spectra.base.SpectrumMixin._generate_lorentzian
      :staticmethod:

      .. autodoc2-docstring:: castor_etc.spectra.base.SpectrumMixin._generate_lorentzian
         :parser: myst

   .. py:method:: add_emission_line(center, fwhm, peak=None, tot_flux=None, shape='gaussian', abs_peak=False)
      :canonical: castor_etc.spectra.base.SpectrumMixin.add_emission_line

      .. autodoc2-docstring:: castor_etc.spectra.base.SpectrumMixin.add_emission_line
         :parser: myst

   .. py:method:: add_absorption_line(center, fwhm, dip=None, tot_flux=None, shape='gaussian', abs_dip=False)
      :canonical: castor_etc.spectra.base.SpectrumMixin.add_absorption_line

      .. autodoc2-docstring:: castor_etc.spectra.base.SpectrumMixin.add_absorption_line
         :parser: myst

   .. py:method:: generate_emission_line(center, fwhm, peak=None, tot_flux=None, shape='gaussian', limits=[100, 1200] << u.nm, overwrite=False, quiet=False)
      :canonical: castor_etc.spectra.base.SpectrumMixin.generate_emission_line

      .. autodoc2-docstring:: castor_etc.spectra.base.SpectrumMixin.generate_emission_line
         :parser: myst

   .. py:method:: set_spectrum(wavelengths, spectrum, unit, overwrite=False, quiet=False)
      :canonical: castor_etc.spectra.base.SpectrumMixin.set_spectrum

      .. autodoc2-docstring:: castor_etc.spectra.base.SpectrumMixin.set_spectrum
         :parser: myst

   .. py:method:: use_custom_spectrum(filepath, wavelength_unit=u.AA, overwrite=False, quiet=False)
      :canonical: castor_etc.spectra.base.SpectrumMixin.use_custom_spectrum

      .. autodoc2-docstring:: castor_etc.spectra.base.SpectrumMixin.use_custom_spectrum
         :parser: myst

   .. py:method:: use_galaxy_spectrum(gal_type, overwrite=False, quiet=False)
      :canonical: castor_etc.spectra.base.SpectrumMixin.use_galaxy_spectrum

      .. autodoc2-docstring:: castor_etc.spectra.base.SpectrumMixin.use_galaxy_spectrum
         :parser: myst

   .. py:method:: _calc_xy()
      :canonical: castor_etc.spectra.base.SpectrumMixin._calc_xy

      .. autodoc2-docstring:: castor_etc.spectra.base.SpectrumMixin._calc_xy
         :parser: myst

   .. py:method:: _search_gaia()
      :canonical: castor_etc.spectra.base.SpectrumMixin._search_gaia

      .. autodoc2-docstring:: castor_etc.spectra.base.SpectrumMixin._search_gaia
         :parser: myst

   .. py:method:: _specify_target_parameters(run_gaia_search=True)
      :canonical: castor_etc.spectra.base.SpectrumMixin._specify_target_parameters

      .. autodoc2-docstring:: castor_etc.spectra.base.SpectrumMixin._specify_target_parameters
         :parser: myst

   .. py:method:: use_gaia_spectrum(TelescopeObj, ra=None, dec=None, srch_Gmax=21.0, srch_nmax=100, srch_rad=None, Teff=None, Gmag=None, logg=None, radius=None, metallicity=None, Bpmag=None, Rpmag=None, stellar_model_grid='ATLAS9', stellar_model_dir=None, bkg_sources=True, fov=None, fov_pa=0 * u.deg, overwrite=False, quiet=False)
      :canonical: castor_etc.spectra.base.SpectrumMixin.use_gaia_spectrum

      .. autodoc2-docstring:: castor_etc.spectra.base.SpectrumMixin.use_gaia_spectrum
         :parser: myst

   .. py:method:: use_pickles_spectrum(spectral_class, overwrite=False, quiet=False)
      :canonical: castor_etc.spectra.base.SpectrumMixin.use_pickles_spectrum

      .. autodoc2-docstring:: castor_etc.spectra.base.SpectrumMixin.use_pickles_spectrum
         :parser: myst

   .. py:method:: use_flare_simulator()
      :canonical: castor_etc.spectra.base.SpectrumMixin.use_flare_simulator

      .. autodoc2-docstring:: castor_etc.spectra.base.SpectrumMixin.use_flare_simulator
         :parser: myst

   .. py:method:: show_spectrum(plot=True)
      :canonical: castor_etc.spectra.base.SpectrumMixin.show_spectrum

      .. autodoc2-docstring:: castor_etc.spectra.base.SpectrumMixin.show_spectrum
         :parser: myst

   .. py:method:: calc_redleak_frac(TelescopeObj, quiet=False)
      :canonical: castor_etc.spectra.base.SpectrumMixin.calc_redleak_frac

      .. autodoc2-docstring:: castor_etc.spectra.base.SpectrumMixin.calc_redleak_frac
         :parser: myst

.. py:class:: NormMixin
   :canonical: castor_etc.spectra.base.NormMixin

   .. autodoc2-docstring:: castor_etc.spectra.base.NormMixin
      :parser: myst

   .. py:method:: norm_to_star(spectrum, radius=1, dist=1 << u.kpc)
      :canonical: castor_etc.spectra.base.NormMixin.norm_to_star
      :staticmethod:

      .. autodoc2-docstring:: castor_etc.spectra.base.NormMixin.norm_to_star
         :parser: myst

   .. py:method:: norm_to_AB_mag(ab_mag, passband=None, TelescopeObj=None)
      :canonical: castor_etc.spectra.base.NormMixin.norm_to_AB_mag

      .. autodoc2-docstring:: castor_etc.spectra.base.NormMixin.norm_to_AB_mag
         :parser: myst

   .. py:method:: norm_luminosity_dist(luminosity, dist)
      :canonical: castor_etc.spectra.base.NormMixin.norm_luminosity_dist

      .. autodoc2-docstring:: castor_etc.spectra.base.NormMixin.norm_luminosity_dist
         :parser: myst

   .. py:method:: get_AB_mag(TelescopeObj=None)
      :canonical: castor_etc.spectra.base.NormMixin.get_AB_mag

      .. autodoc2-docstring:: castor_etc.spectra.base.NormMixin.get_AB_mag
         :parser: myst