Skip to main content
Ctrl+K

JeansPy documentation

  • Installation
  • Quickstart
  • Tutorials
  • API reference
    • Topic guides
    • Theory and numerical methods
    • Citing JeansPy and its dependencies
    • References
  • GitHub
  • Installation
  • Quickstart
  • Tutorials
  • API reference
  • Topic guides
  • Theory and numerical methods
  • Citing JeansPy and its dependencies
  • References
  • GitHub

Section Navigation

  • Core utilities
    • jeanspy.model.C_J
    • DotDict
    • jeanspy.model.GMsun_m3s2
    • Model
    • Parameters
    • Model
    • configure_runtime
    • get_runtime_config
    • jeanspy.axisymmetric_factors.C_J
    • jeanspy.axisymmetric_factors.C_D
    • hyp2f1_1b_d_series
    • hyp2f1_1b_3half_series
    • hyp2f1_1b_3half_quad
    • hyp2f1_1b_3half_asymptotic
    • hyp2f1_1b_3half
    • dequad
    • generate_x_w
  • Spherical models
    • AnisotropyModel
    • BaesAnisotropyModel
    • ConstantAnisotropyModel
    • DMModel
    • DSphModel
    • ProjectedExponentialModel
    • NFWModel
    • OsipkovMerrittModel
    • PlummerModel
    • SersicModel
    • StellarModel
    • Uniform2dModel
    • ZhaoModel
    • PlummerModel
    • ZhaoModel
    • NFWModel
    • ConstantAnisotropyModel
    • BaesAnisotropyModel
    • OsipkovMerrittModel
    • DSphModel
    • BaesEta2AnisotropyModel
    • jeanspy.baes_eta2.DEFAULT_BAES_ETA2_KERNEL_N_QUAD
    • baes_eta2_kernel_appell_reference
    • baes_eta2_kernel_jax
  • Axisymmetric models
    • AxisymmetricDSphModel
    • AxisymmetricPlummerModel
    • AxisymmetricZhaoModel
    • AxisymmetricConstantAnisotropyModel
    • AxisymmetricStellarModel
    • AxisymmetricDMModel
    • AxisymmetricAnisotropyModel
    • intrinsic_axis_ratio
    • jeanspy.axisymmetric.InvalidAxisymmetricModelError
    • AxisymmetricDSphModel
    • AxisymmetricPlummerModel
    • AxisymmetricZhaoModel
    • AxisymmetricConstantAnisotropyModel
    • jfactor
    • dfactor
  • Statistical inference
    • FittableModel
    • FlatPriorModel
    • PhotometryPriorModel
    • SphericalDSphEstimationModel
    • plummer_nfw_constant_anisotropy_model
    • AxisymmetricDSphEstimationModel
    • AxisymmetricKinematicData
    • SamplingParameter
    • Sampler
    • AxisymmetricJeansLikelihoodModel
    • JeansLikelihoodModel
    • NumPyroSampler
    • ParameterSpec
    • SamplerRunResult
    • jeanspy.sampler_numpyro.StorageBackend
  • Alphabetical API dictionary
    • AnisotropyModel members
      • beta
      • f
      • is_required_param_names
      • kernel
      • params_all
      • params_all_with_model_name
      • required_param_names_combined
      • sampling_identity
      • update
    • BaesAnisotropyModel members
      • beta
      • f
      • integrand_kernel
      • is_required_param_names
      • kernel
      • params_all
      • params_all_with_model_name
      • required_param_names_combined
      • sampling_identity
      • update
    • ConstantAnisotropyModel members
      • beta
      • f
      • is_required_param_names
      • kernel
      • params_all
      • params_all_with_model_name
      • required_param_names_combined
      • sampling_identity
      • update
    • DMModel members
      • enclosed_mass
      • is_required_param_names
      • jfactor_cone
      • jfactor_spherical_aperture
      • mass_density_3d
      • params_all
      • params_all_with_model_name
      • required_param_names_combined
      • sampling_identity
      • update
      • validate_small_angle
    • DSphModel members
      • integrand_sigmalos2
      • is_required_param_names
      • params_all
      • params_all_with_model_name
      • required_param_names_combined
      • sampling_identity
      • sigmalos
      • sigmalos2
      • sigmar2
      • sigmat2
      • update
    • DotDict members
      • clear
      • copy
      • fromkeys
      • get
      • items
      • keys
      • pop
      • popitem
      • setdefault
      • update
      • values
    • ProjectedExponentialModel members
      • cdf_R
      • density
      • density_2d
      • density_2d_truncated
      • density_3d
      • half_light_radius
      • is_required_param_names
      • logdensity_2d
      • mean_density_2d
      • params_all
      • params_all_with_model_name
      • re_pc
      • required_param_names_combined
      • sampling_identity
      • update
    • FittableModel members
      • blobs_dtype
      • convert_params
      • inverse_temperature
      • is_required_param_names
      • lnlikelihood
      • lnlikelihoods
      • lnposterior
      • lnposterior_wbic
      • lnpriors
      • load_data
      • ndim
      • params_all
      • params_all_with_model_name
      • required_param_names_combined
      • sampling_identity
      • update
    • FlatPriorModel members
      • extract_value_by_name
      • get_index
      • is_required_param_names
      • load_config
      • lower
      • params_all
      • params_all_with_model_name
      • required_param_names_combined
      • sample
      • sampling_identity
      • update
      • upper
      • validate_config
      • write_config_template
    • Model members
      • is_required_param_names
      • params_all
      • params_all_with_model_name
      • required_param_names_combined
      • sampling_identity
      • update
    • NFWModel members
      • enclosed_mass
      • is_required_param_names
      • jfactor_cone
      • jfactor_small_angle_infinite_los
      • jfactor_spherical_aperture
      • mass_density_3d
      • params_all
      • params_all_with_model_name
      • required_param_names_combined
      • sampling_identity
      • update
      • validate_small_angle
    • OsipkovMerrittModel members
      • beta
      • f
      • is_required_param_names
      • kernel
      • params_all
      • params_all_with_model_name
      • required_param_names_combined
      • sampling_identity
      • update
    • Parameters members
      • clear
      • copy
      • get
      • index
      • items
      • keys
      • pop
      • popitem
      • setdefault
      • to_series
      • update
      • values
    • PhotometryPriorModel members
      • is_required_param_names
      • params_all
      • params_all_with_model_name
      • required_param_names_combined
      • reset_prior
      • sample
      • sampling_identity
      • update
    • PlummerModel members
      • cdf_R
      • density
      • density_2d
      • density_2d_normalized_re
      • density_2d_truncated
      • density_3d
      • half_light_radius
      • is_required_param_names
      • logdensity_2d
      • mean_density_2d
      • params_all
      • params_all_with_model_name
      • required_param_names_combined
      • sampling_identity
      • update
    • SersicModel members
      • b
      • b_CB
      • b_linear
      • cdf_R
      • density
      • density_2d
      • density_2d_normalized_re
      • density_2d_truncated
      • density_3d
      • density_3d_LGM
      • density_3d_VM20
      • density_3d_VM20bis
      • density_3d_auto
      • density_3d_numerical
      • half_light_radius
      • is_required_param_names
      • lgm_norm_3d
      • mean_density_2d
      • norm
      • p_LGM
      • params_all
      • params_all_with_model_name
      • required_param_names_combined
      • sampling_identity
      • update
    • SphericalDSphEstimationModel members
      • blobs_dtype
      • convert_params
      • data
      • inverse_temperature
      • is_required_param_names
      • lnlikelihood
      • lnlikelihoods
      • lnposterior
      • lnposterior_wbic
      • lnpriors
      • load_data
      • n_data
      • ndim
      • p_names_lnprob
      • params_all
      • params_all_with_model_name
      • release_shared_memory
      • required_param_names_combined
      • reset_data
      • sample
      • sample_data
      • sampling_identity
      • shared_memory_basename
      • update
    • StellarModel members
      • density
      • density_2d
      • density_2d_truncated
      • density_3d
      • is_required_param_names
      • params_all
      • params_all_with_model_name
      • required_param_names_combined
      • sampling_identity
      • update
    • Uniform2dModel members
      • cdf_R
      • density
      • density_2d
      • density_2d_truncated
      • density_3d
      • is_required_param_names
      • params_all
      • params_all_with_model_name
      • required_param_names_combined
      • sampling_identity
      • update
    • ZhaoModel members
      • enclosed_mass
      • is_required_param_names
      • jfactor_cone
      • jfactor_spherical_aperture
      • mass_density_3d
      • params_all
      • params_all_with_model_name
      • required_param_names_combined
      • sampling_identity
      • update
      • validate_small_angle
    • AxisymmetricDSphModel members
      • density_3d
      • dfactor
      • enclosed_mass
      • intrinsic_moments
      • jfactor
      • mass_density_3d
      • physical_params
      • potential_gradient
      • sampling_identity
      • sigmalos2
      • surface_density
    • AxisymmetricDSphEstimationModel members
      • blobs_dtype
      • convert_params
      • data
      • inverse_temperature
      • lnlikelihood
      • lnlikelihoods
      • lnposterior
      • lnposterior_wbic
      • lnpriors
      • n_data
      • ndim
      • p_names_lnprob
      • prior_names
      • reset_data
      • sample
      • sample_data
      • sampling_identity
    • AxisymmetricKinematicData members
      • as_kwargs
      • from_data
    • AxisymmetricPlummerModel members
      • density
      • density_3d
      • projected_axis_ratio
      • radial_derivative
      • surface_density
    • AxisymmetricZhaoModel members
      • density
      • dfactor
      • enclosed_mass
      • jfactor
      • mass_density_3d
      • potential_gradient
    • AxisymmetricConstantAnisotropyModel members
      • beta
    • AxisymmetricStellarModel members
      • density_3d
      • radial_derivative
      • surface_density
    • AxisymmetricDMModel members
      • enclosed_mass
      • mass_density_3d
      • potential_gradient
    • AxisymmetricAnisotropyModel members
      • beta
    • SamplingParameter members
      • to_physical
    • InvalidAxisymmetricModelError members
      • add_note
      • with_traceback
    • AxisymmetricDSphModel members
      • density_3d
      • enclosed_mass
      • intrinsic_moments
      • mass_density_3d
      • potential_gradient
      • sampling_identity
      • sigmalos2
      • surface_density
    • Model members
      • sampling_identity
    • PlummerModel members
      • density_2d
      • density_3d
      • log_prob_R
      • sample_R
      • sampling_identity
    • ZhaoModel members
      • enclosed_mass
      • enclosed_mass_analytic
      • enclosed_mass_betainc
      • enclosed_mass_numeric
      • has_analytic_enclosed_mass
      • mass_density_3d
      • resolve_params
      • sampling_identity
      • valid_mass_domain
    • NFWModel members
      • enclosed_mass
      • enclosed_mass_analytic
      • enclosed_mass_numeric
      • has_analytic_enclosed_mass
      • mass_density_3d
      • resolve_params
      • sampling_identity
      • valid_mass_domain
    • ConstantAnisotropyModel members
      • beta
      • f
      • kernel
      • sampling_identity
    • BaesAnisotropyModel members
      • beta
      • f
      • kernel
      • sampling_identity
    • OsipkovMerrittModel members
      • beta
      • f
      • kernel
      • sampling_identity
    • DSphModel members
      • sampling_identity
      • sigmalos2
      • sigmalos2_abel
      • sigmalos2_kernel
    • AxisymmetricPlummerModel members
      • density_3d
      • radial_derivative
      • surface_density
    • AxisymmetricZhaoModel members
      • enclosed_mass
      • mass_density_3d
      • potential_gradient
    • AxisymmetricConstantAnisotropyModel members
      • beta
    • Sampler members
      • burn_in
      • check_parameter_conversion
      • filename
      • get_blobs
      • get_chain
      • get_dataframe
      • get_last_sample
      • get_log_prob
      • reset_pool
      • run_mcmc
      • set_wrapper_function
    • AxisymmetricJeansLikelihoodModel members
      • __call__
      • sample_parameters
      • sampling_identity
    • JeansLikelihoodModel members
      • __call__
      • sample_parameters
    • NumPyroSampler members
      • checkpoint_path
      • chunk_suffix
      • chunks_dir
      • clear_resume_state
      • close
      • combine_trees
      • flush
      • list_chunk_paths
      • load_checkpoint
      • load_samples
      • metadata_path
      • pending_write_count
      • run
      • save_checkpoint
      • save_samples_chunk
      • to_datatree
      • uses_directory_stores
    • ParameterSpec members
      • build_distribution
      • exp
      • pow10
      • records_deterministic
      • resolved_deterministic_name
      • sample
    • BaesEta2AnisotropyModel members
      • beta
      • f
      • kernel
      • sampling_identity
  • Import modules
    • NumPy/SciPy
    • Explicit NumPy/SciPy sampling coordinates
    • Axisymmetric components and NumPy forward model
    • Axisymmetric observations and NumPy/SciPy inference
    • JAX
    • JAX axisymmetric forward model
    • Finite-cone NumPy J and D factors
    • emcee sampling and HDF5 storage
    • NumPyro likelihoods, sampling and storage
    • Spherical Sersic tracer
    • Specialized Baes anisotropy kernels
    • JAX hypergeometric numerical helpers
    • Double-exponential integration helpers
  • API reference
  • Alphabetical API dictionary
  • Model members

Model members#

  • is_required_param_names
  • params_all
  • params_all_with_model_name
  • required_param_names_combined
  • sampling_identity
  • update

previous

write_config_template

next

is_required_param_names
Show Source

© Copyright 2026, Shunichi Horigome.

Built with the PyData Sphinx Theme 0.21.0.