sheap Logo
0.0

Getting Started

  • Welcome to sheap’s documentation
    • Features
    • Installation
    • Prerequisites
    • References
    • License

Overview

  • sheap’s Overview
    • Overview
    • Key Features
    • Quickstart
    • Documentation

Optimization Strategy

  • Optimization Strategy

Profiles in sheap

  • Available continuum profiles
    • Continuum Profiles
      • Profiles
      • Constants
    • brokenpowerlaw()
    • delta0
    • exp_cutoff()
    • linear()
    • logparabola()
    • powerlaw()
  • Available line profiles
    • Line Profiles
      • Functions
    • emg_fwhm()
    • eval_hermite()
    • gauss_hermite_losvd_jax()
    • gaussian_fwhm()
    • lorentzian_fwhm()
    • skewed_gaussian()
    • top_hat()
    • voigt_pseudo()

Constants and Data

  • SuportData Resources
    • Bolometriccorrections
      • Bolometric Corrections (k_bol ≡ L_bol / λLλ)
      • YAML Tables
        • Bolometriccorrections
    • Defaultlimits
      • DefaultLimits
      • YAML Tables
        • Defaultlimits
    • Linerepository
      • LineRepository
        • Organization
        • Line Format
        • Regions
        • Fe Line Templates
      • YAML Files
        • Broad_And_Narrow
        • Broads
        • Feii_Izw1
        • Feii_Coronal
        • Feii_Forbidden
        • Feii_Model
        • Feii_Uv
        • Narrows
    • Singleepochestimators
      • SINGLE_EPOCH_ESTIMATORS (sorted by year of original paper)
      • YAML Tables
        • Singleepochestimators
    • Spectra
      • Spectra
        • Files and References
    • Regions
      • Regions
    • Sfddata
      • sfddata
    • Templates
      • ref

Tutorials

  • Welcome to sheap tutorials!
    • Notebook 1 – Introduction
    • Notebook 2 – Data Classes
    • Notebook 3 – What a example

API Reference

  • sheap package
    • Sheapectral
      • Sheapectral.spectra
      • Sheapectral.wdisp
      • Sheapectral.fwhm_lambda
      • Sheapectral.fwhm_kms
      • Sheapectral.result
      • Sheapectral.modelbuild
      • Sheapectral.plotter
      • Sheapectral.makemodel()
      • Sheapectral.fitmodel()
      • Sheapectral.estimate_posteriors()
      • Sheapectral.save_to_pickle()
      • Sheapectral.from_pickle()
      • Sheapectral.result_panda()
      • Sheapectral.quicklook()
      • Sheapectral.modelplot()
      • Sheapectral.sheap_set_up()
      • Sheapectral.makemodel()
      • Sheapectral.fitmodel()
      • Sheapectral.estimate_posteriors()
      • Sheapectral.from_pickle()
      • Sheapectral.save_to_pickle()
      • Sheapectral.result_panda()
      • Sheapectral.quicklook()
      • Sheapectral.plot_redshift_signal2noise_distribution
      • Sheapectral.plot_chi2
      • Sheapectral.plot_param_distribution()
      • Sheapectral.modelplot
    • sheap.Assistants package
      • sheap.Assistants.Parameters module
        • Key behavior
        • Parameter
        • Parameters
        • build_Parameters()
      • sheap.Assistants.parser_mapper module
        • Mappers & Parsers
        • apply_arithmetic_ties()
        • apply_tied_and_fixed_params()
        • build_tied()
        • descale_amp()
        • extract_float()
        • flatten_tied_map()
        • make_get_param_coord_value()
        • mapping_params()
        • parse_dependencies()
        • parse_dependency()
        • project_params()
        • project_params_clasic()
        • scale_amp()
        • get_sample_params()
        • get_multiple_sample_params()
        • summarize_spectral_lines()
    • sheap.Core package
      • SpectralLine
        • SpectralLine.to_dict()
        • SpectralLine.line_name
        • SpectralLine.center
        • SpectralLine.region
        • SpectralLine.component
        • SpectralLine.subregion
        • SpectralLine.amplitude
        • SpectralLine.element
        • SpectralLine.profile
        • SpectralLine.region_lines
        • SpectralLine.amplitude_relations
        • SpectralLine.subprofile
        • SpectralLine.rarity
        • SpectralLine.template_info
        • SpectralLine.to_dict()
      • SheapModel
        • SheapModel.lines
        • SheapModel.profile_functions
        • SheapModel.profile_names
        • SheapModel.params_dict
        • SheapModel.profile_params_index_list
        • SheapModel.params
        • SheapModel.uncertainty_params
        • SheapModel.original_idx
        • SheapModel.global_profile_params_index_list
        • SheapModel.attach_profiles()
        • SheapModel.combined_profile
        • SheapModel.flat_param_indices_global
        • SheapModel.flat_param_indices_local
        • SheapModel.as_df()
        • SheapModel.filter()
        • SheapModel.group_by()
        • SheapModel.param_subdict()
        • SheapModel.unique()
        • SheapModel.regions
        • SheapModel.components
        • SheapModel.subregions
        • SheapModel.elements
        • SheapModel.characteristics()
      • SheapResult
        • SheapResult.region_list
        • SheapResult.params
        • SheapResult.uncertainty_params
        • SheapResult.mask
        • SheapResult.profile_functions
        • SheapResult.profile_names
        • SheapResult.loss
        • SheapResult.profile_params_index_list
        • SheapResult.initial_params
        • SheapResult.scale
        • SheapResult.params_dict
        • SheapResult.outer_limits
        • SheapResult.inner_limits
        • SheapResult.model_keywords
        • SheapResult.kind_list
        • SheapResult.region_list
        • SheapResult.fitting_routine
        • SheapResult.params
        • SheapResult.uncertainty_params
        • SheapResult.mask
        • SheapResult.constraints
        • SheapResult.profile_functions
        • SheapResult.profile_names
        • SheapResult.loss
        • SheapResult.profile_params_index_list
        • SheapResult.initial_params
        • SheapResult.scale
        • SheapResult.params_dict
        • SheapResult.outer_limits
        • SheapResult.inner_limits
        • SheapResult.model_keywords
        • SheapResult.source
        • SheapResult.dependencies
        • SheapResult.free_params
        • SheapResult.residuals
        • SheapResult.chi2_red
        • SheapResult.posterior
        • SheapResult.fitkwargs
        • SheapResult.elapsed_time
        • SheapResult.params_class
        • SheapResult.to_dict()
      • ProfileConstraintSet
        • ProfileConstraintSet.init
        • ProfileConstraintSet.upper
        • ProfileConstraintSet.lower
        • ProfileConstraintSet.profile
        • ProfileConstraintSet.param_names
        • ProfileConstraintSet.profile_fn
      • FittingLimits
        • FittingLimits.upper_fwhm_kms
        • FittingLimits.lower_fwhm_kms
        • FittingLimits.vshift_kms
        • FittingLimits.max_amplitude
        • FittingLimits.upper_fwhm_kms
        • FittingLimits.lower_fwhm_kms
        • FittingLimits.init_fwhm_kms
        • FittingLimits.vshift_kms
        • FittingLimits.max_amplitude
        • FittingLimits.references
        • FittingLimits.from_dict()
      • sheap.Core.CoreDataStructures module
        • Core Data Structures
        • SheapModel
        • SheapResult
        • FittingLimits
        • ProfileConstraintSet
        • SpectralLine
      • sheap.Core.CoreTypeAliases module
        • Core Type Aliases
        • ArrayLike
        • ProfileFunc
        • SpectralLineList
    • sheap.MasterSampler package
      • sheap.MasterSampler.Samplers package
        • sheap.MasterSampler.Samplers.Utils package
        • sheap.MasterSampler.Samplers.McMcSampler module
        • sheap.MasterSampler.Samplers.MonteCarloSampler module
        • sheap.MasterSampler.Samplers.PseudoMonteCarloSampler module
      • sheap.MasterSampler.MasterSampler module
        • MasterSampler
        • MasterSampler
    • sheap.Minimizer package
      • sheap.Minimizer.LB_nonlinear module
        • make_build_linear_system_from_phys_profile()
        • build_varpro_loss_from_profile_and_params_obj()
      • sheap.Minimizer.Minimizer module
        • Minimization Routines
        • Minimizer
      • sheap.Minimizer.loss_builder module
        • Loss Function Builder
        • build_loss_function()
    • sheap.Plotting package
      • sheap.Plotting.SheapPlot module
        • SheapPlot
      • sheap.Plotting.ploting module
        • SheapPlot_old
        • plot_a_spectra()
        • plot_region()
      • sheap.Plotting.plots_ module
    • sheap.Profiles package
      • sheap.Profiles.Combine module
        • Log-Lambda Profile Combination Utilities
        • SPAF_loglambda()
      • sheap.Profiles.ProfileConstraintMaker module
        • Profile Constraint Maker
        • ProfileConstraintMaker()
      • sheap.Profiles.Profiles module
        • Profiles
      • sheap.Profiles.Utils module
        • Profile Utilities
        • build_grid_penalty()
        • make_fused_profiles()
        • make_integrator()
        • trapz_jax()
        • with_param_names()
        • GaussianSum
      • sheap.Profiles.balmercontinuum module
        • Balmer continuum
        • balmercontinuum()
      • sheap.Profiles.profiles_continuum module
        • Continuum Profiles
        • brokenpowerlaw()
        • delta0
        • exp_cutoff()
        • linear()
        • logparabola()
        • powerlaw()
      • sheap.Profiles.profiles_lines module
        • Line Profiles
        • emg_fwhm()
        • eval_hermite()
        • gauss_hermite_losvd_jax()
        • gaussian_fwhm()
        • lorentzian_fwhm()
        • skewed_gaussian()
        • top_hat()
        • voigt_pseudo()
      • sheap.Profiles.profiles_lines_loglambda module
        • Log-Lambda Emission Line Profiles
        • gaussian_fwhm_loglambda()
        • lorentzian_fwhm_loglambda()
        • skewed_gaussian_loglambda()
        • top_hat_loglambda()
        • voigt_pseudo_loglambda()
        • emg_fwhm_loglambda()
      • sheap.Profiles.profiles_templates module
        • Template-Based Profiles
        • make_host_function()
    • sheap.SheaProducts package
      • sheap.SheaProducts.Utils package
        • sheap.SheaProducts.Utils.CombineUtils module
        • sheap.SheaProducts.Utils.ExtractBasicParams module
        • sheap.SheaProducts.Utils.ExtractBasicParamsSampled module
        • sheap.SheaProducts.Utils.ExtractExtraParams module
        • sheap.SheaProducts.Utils.Helpers module
        • sheap.SheaProducts.Utils.MasterCombineProfile module
        • sheap.SheaProducts.Utils.MoldelSpectraReconstruction module
        • sheap.SheaProducts.Utils.Sample_handlers module
      • sheap.SheaProducts.SheaProducts module
        • SheaProducts Handling
        • SheaProducts
      • sheap.SheaProducts.SheapExtract module
        • posterior_param_extraction()
    • sheap.SheapModelBuilder package
      • sheap.SheapModelBuilder.SheapModelBuilder module
        • SheapModelBuilder
        • SheapModelBuilder
      • sheap.SheapModelBuilder.Utils module
        • SheapModelBuilder Utilities
        • default_known_tied_relations()
        • fe_ties()
        • flatten_index_ties()
        • group_lines()
    • sheap.SheapModelFitting package
      • sheap.SheapModelFitting.SheapModelFitting module
        • Complex Fitting
        • SheapModelFitting
    • sheap.Sheapectral package
      • sheap.Sheapectral.Utils package
        • sheap.Sheapectral.Utils.BasicCorrections module
        • sheap.Sheapectral.Utils.SpectralSetup module
      • sheap.Sheapectral.Sheapectral module
        • Main sheap Interface
        • Sheapectral
    • sheap.Utils package
      • sheap.Utils.extras package
        • sheap.Utils.extras.SheapSpectralList module
        • sheap.Utils.extras.can_be_usefull module
      • sheap.Utils.BasicFunctions module
        • Basic Functions
        • kms_to_wl()
        • vac_to_air()
        • wl_to_kms()
      • sheap.Utils.Constants module
        • Constants and Configuration
        • cm_per_mpc
        • read_yaml()
        • DEFAULT_C_KMS
      • sheap.Utils.Interp_tools module
        • cubic_spline_coefficients()
        • interpolate_nans()
        • replaze_nan_interpolation()
        • spline_eval()
        • vmap_interp()
      • sheap.Utils.Paper module
        • log10_to_linear()
        • median_with_errors()
        • posterior_extraction()
        • mad_std()
        • median_abs_deviation()
        • concordance_ccc()
        • band_stats()
        • summarize()
        • concordance_corrcoef()
        • agreement_stats()
        • errors_to_logspace()
        • weighted_quantile()
        • weighted_median()
        • weighted_nmad()
        • plot_ratio_with_sn()
        • extract_data()
        • plot_ratio_histogram()
        • plot_logdex_agreement()
        • compare_xy_stats()
        • compare_from_data_dict()
        • summary_similarity()
        • bins_centered_on_zero()
        • compare_res()
        • add_colorbar_from_dict()
        • plot_main_plot_panel()
        • plot_main_plot_subplots()
      • sheap.Utils.PathsFunctions module
        • Cross-matching spectra with metadata
        • cross_pandas_spectra()
        • cross_pandas_spectra_desi()
      • sheap.Utils.SpectralReaders module
        • FITS Spectrum Readers
        • batched_reader()
        • fits_reader_desi()
        • fits_reader_pyqso()
        • fits_reader_sdss()
        • fits_reader_simulation()
        • parallel_reader()
        • sequential_reader()
      • sheap.Utils.UncertaintyFunction module
        • Uncertainty Estimation via Residuals
        • Errorfromloop()
        • error_covariance_matrix()
        • error_for_loop_s()
        • make_residuals_free_fn()
        • residuals()
      • sheap.Utils.Vocalisations module
        • sounds()
    • sheap.cli module
      • version_msg()
sheap
  • sheap package
  • sheap.SheapModelFitting package
  • View page source

sheap.SheapModelFitting package

  • sheap.SheapModelFitting.SheapModelFitting module
    • Complex Fitting
      • Main Features
    • SheapModelFitting
      • SheapModelFitting.profile
      • SheapModelFitting.limits_map
      • SheapModelFitting.params_dict
      • SheapModelFitting.initial_params
      • SheapModelFitting.constraints
      • SheapModelFitting.profile_functions
      • SheapModelFitting.model
      • SheapModelFitting.host_info
      • SheapModelFitting.sheapesult
      • SheapModelFitting._prep_data()
      • SheapModelFitting._postprocess()
      • SheapModelFitting._build_fit_components()
      • SheapModelFitting._build_tied()
      • SheapModelFitting._stack_constraints()
      • SheapModelFitting._add_linear()
      • SheapModelFitting.to_result()
      • SheapModelFitting.from_builder()
      • SheapModelFitting.init_linear()
      • SheapModelFitting.to_result()
      • SheapModelFitting.from_builder()
      • SheapModelFitting.init_linear()
Previous Next

© Copyright .

Built with Sphinx using a theme provided by Read the Docs.