Getting Started
Overview
Optimization Strategy
Profiles in sheap
brokenpowerlaw()
delta0
exp_cutoff()
linear()
logparabola()
polynomial()
powerlaw()
emg_fwhm()
eval_hermite()
gauss_hermite_losvd_jax()
gaussian_fwhm()
lorentzian_fwhm()
skewed_gaussian()
top_hat()
voigt_pseudo()
Constants and Data
Tutorials
API Reference
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.profile_functions_from_region_list()
Sheapectral.modelplot
Sheapectral.plot_redshift_signal2noise_distribution
Sheapectral.plot_chi2
Sheapectral.plot_param_distribution()
Parameter
Parameters
build_Parameters()
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()
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
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.fitting_routine
SheapResult.constraints
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.init_fwhm_kms
FittingLimits.references
FittingLimits.from_dict()
ArrayLike
ProfileFunc
SpectralLineList
MasterSampler
Minimizer
build_loss_function()
SheapPlot
SheapPlot_old
plot_a_spectra()
plot_region()
SPAF_loglambda()
SPAF_loglambda_old()
ProfileConstraintMaker()
build_grid_penalty()
make_fused_profiles()
make_integrator()
trapz_jax()
with_param_names()
balmercontinuum()
gaussian_fwhm_loglambda()
lorentzian_fwhm_loglambda()
skewed_gaussian_loglambda()
top_hat_loglambda()
voigt_pseudo_loglambda()
emg_fwhm_loglambda()
make_host_function()
SheaProducts
SheapModelBuilder
default_known_tied_relations()
fe_ties()
flatten_index_ties()
group_lines()
SheapModelFitting
kms_to_wl()
vac_to_air()
wl_to_kms()
cm_per_mpc
read_yaml()
DEFAULT_C_KMS
cubic_spline_coefficients()
interpolate_nans()
replaze_nan_interpolation()
spline_eval()
vmap_interp()
log10_to_linear()
median_with_errors()
posterior_extraction()
median_abs_deviation()
mad_std()
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()
cross_pandas_spectra()
cross_pandas_spectra_desi()
batched_reader()
fits_reader_desi()
fits_reader_pyqso()
fits_reader_sdss()
fits_reader_simulation()
parallel_reader()
sequential_reader()
Errorfromloop()
error_covariance_matrix()
error_for_loop_s()
make_residuals_free_fn()
residuals()
sounds()
version_msg()
This module handles basic operations.
sheap version, location and Python version.
Get message about sheap version, location and Python version.