bilby 3.1
  • Getting started
  • User guide
  • Gravitational waves
  • Tutorials
  • API reference
  • Development
  • Examples
Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
bilby
Logo
bilby

Getting started

  • Installation
  • Basics of parameter estimation
  • Examples
  • Acknowledging/Citing Bilby
  • Frequently Asked Questions

User guide

  • Priors
  • Likelihood
  • Sampling
  • Dynesty Guide
  • Bilby MCMC Guide
  • Bilby output
  • Hyper-parameters
  • Bilby and Parameters
  • Array API Support
  • Parallelisation
  • Random number generation
  • Plugins
  • Using Containers

Gravitational waves

  • Compact binary coalescence parameter estimation
  • Transient gravitational wave data I/O
  • Transient Gravitational wave priors
  • Transient gravitational wave reference information

Tutorials

  • Prior Distributions with Bilby
  • Conditional prior demonstration
  • Compare samplers
  • Fitting a model to data with both x and y errors with Bilby
  • Visualising the results

Development

  • Contributing to bilby
  • Code overview
  • Writing documentation

API reference

  • bilby.compat
    • bilby.compat.jax
      • JittedLikelihood
    • bilby.compat.patches
      • multivariate_logpdf
    • bilby.compat.pytrees
      • bilby.compat.pytrees.likelihood
        • analytical_1d_likelihood_flatten
        • analytical_1d_likelihood_unflatten
        • analytical_multidimensional_bimodal_covariant_gaussian_flatten
        • analytical_multidimensional_bimodal_covariant_gaussian_unflatten
        • analytical_multidimensional_covariant_gaussian_flatten
        • analytical_multidimensional_covariant_gaussian_unflatten
        • gaussian_likelihood_flatten
        • gaussian_likelihood_unflatten
        • joint_likelihood_flatten
        • joint_likelihood_unflatten
        • likelihood_flatten
        • likelihood_unflatten
        • multinomial_flatten
        • multinomial_unflatten
        • student_t_likelihood_flatten
        • student_t_likelihood_unflatten
        • zero_likelihood_flatten
        • zero_likelihood_unflatten
      • bilby.compat.pytrees.prior
        • cls
        • conditional_dict_flatten
        • conditional_dict_unflatten
        • conditional_flatten
        • conditional_unflatten
        • dict_flatten
        • dict_unflatten
        • dirichlet_dict_flatten
        • dirichlet_dict_unflatten
        • prior_flatten
        • prior_unflatten
      • bilby.compat.pytrees.utils
        • interp1d_flatten
        • interp1d_unflatten
        • tfs_flatten
        • tfs_unflatten
    • bilby.compat.types
    • bilby.compat.utils
      • array_module
      • copy_array
      • promote_to_array
      • xp_wrap
      • BackendNotImplementedError
  • bilby.core
    • bilby.core.fisher
      • FisherMatrixPosteriorEstimator
    • bilby.core.grid
      • grid_file_name
      • Grid
    • bilby.core.likelihood
      • function_to_celerite_mean_model
      • function_to_george_mean_model
      • Analytical1DLikelihood
      • AnalyticalMultidimensionalBimodalCovariantGaussian
      • AnalyticalMultidimensionalCovariantGaussian
      • CeleriteLikelihood
      • ExponentialLikelihood
      • GaussianLikelihood
      • GeorgeLikelihood
      • JointLikelihood
      • Likelihood
      • Multinomial
      • PoissonLikelihood
      • StudentTLikelihood
      • ZeroLikelihood
      • LikelihoodParameterError
      • MarginalizedLikelihoodReconstructionError
    • bilby.core.prior
      • bilby.core.prior.analytical
        • Beta
        • Categorical
        • Cauchy
        • ChiSquared
        • Cosine
        • DeltaFunction
        • DiscreteValues
        • Exponential
        • FermiDirac
        • Gamma
        • Gaussian
        • HalfGaussian
        • HalfNormal
        • LogGaussian
        • LogNormal
        • LogUniform
        • Logistic
        • Lorentzian
        • Normal
        • PowerLaw
        • Sine
        • StudentT
        • SymmetricLogUniform
        • Triangular
        • TruncatedGaussian
        • TruncatedNormal
        • Uniform
        • WeightedCategorical
        • WeightedDiscreteValues
      • bilby.core.prior.base
        • Constraint
        • Prior
        • PriorException
      • bilby.core.prior.conditional
        • conditional_prior_factory
        • ConditionalBasePrior
        • ConditionalBeta
        • ConditionalCauchy
        • ConditionalChiSquared
        • ConditionalCosine
        • ConditionalDeltaFunction
        • ConditionalExponential
        • ConditionalFermiDirac
        • ConditionalGamma
        • ConditionalGaussian
        • ConditionalHalfGaussian
        • ConditionalInterped
        • ConditionalLogNormal
        • ConditionalLogUniform
        • ConditionalLogistic
        • ConditionalPowerLaw
        • ConditionalSine
        • ConditionalStudentT
        • ConditionalSymmetricLogUniform
        • ConditionalTruncatedGaussian
        • ConditionalUniform
        • DirichletElement
        • ConditionalPriorException
        • IllegalRequiredVariablesException
      • bilby.core.prior.dict
        • create_default_prior
        • ConditionalPriorDict
        • DirichletPriorDict
        • PriorDict
        • ConditionalPriorDictException
        • IllegalConditionsException
        • PriorDictException
      • bilby.core.prior.interpolated
        • FromFile
        • Interped
      • bilby.core.prior.joint
        • BaseJointPriorDist
        • JointPrior
        • MultivariateGaussian
        • MultivariateGaussianDist
        • MultivariateNormal
        • MultivariateNormalDist
        • JointPriorDistError
      • bilby.core.prior.slabspike
        • SlabSpikePrior
    • bilby.core.result
      • get_weights_for_reweighting
      • make_pp_plot
      • plot_multiple
      • read_in_result
      • read_in_result_list
      • rejection_sample
      • result_file_name
      • reweight
      • sanity_check_labels
      • Result
      • ResultList
      • FileLoadError
      • FileMovedError
      • ResultError
      • ResultListError
    • bilby.core.sampler
      • apply_conversion_function
      • finalize_result
      • get_implemented_samplers
      • get_sampler_class
      • run_sampler
      • ImplementedSamplers
      • bilby.core.sampler.base_sampler
        • signal_wrapper
        • LikePriorEvaluator
        • MCMCSampler
        • NestedSampler
        • Sampler
        • Error
        • IllegalSamplingSetError
        • ResumeError
        • SamplerError
        • SamplerNotInstalledError
        • SamplingMarginalisedParameterError
      • bilby.core.sampler.dynamic_dynesty
        • DynamicDynesty
      • bilby.core.sampler.dynesty
        • dynesty_stats_plot
        • Dynesty
        • DynestySetupError
      • bilby.core.sampler.dynesty_utils
        • apply_boundaries_
        • propose_differential_evolution
        • propose_volumetric
        • ACTTrackingEnsembleWalk
        • AcceptanceTrackingRWalk
        • BaseEnsembleSampler
        • EnsembleAxisSamplerArgument
        • EnsembleSamplerArgument
        • EnsembleWalkSampler
      • bilby.core.sampler.emcee
        • Emcee
      • bilby.core.sampler.fake_sampler
        • FakeSampler
      • bilby.core.sampler.proposal
        • DifferentialEvolution
        • DrawFlatPrior
        • EnsembleEigenVector
        • EnsembleStretch
        • EnsembleWalk
        • JumpProposal
        • JumpProposalCycle
        • NormJump
        • Sample
    • bilby.core.series
      • CoupledTimeAndFrequencySeries
    • bilby.core.utils
      • bilby.core.utils.calculus
        • derivatives
        • interp1d
        • round_up_to_power_of_two
        • BoundedRectBivariateSpline
        • WrappedInterp1d
      • bilby.core.utils.cmd
        • run_commandline
        • set_up_command_line_arguments
      • bilby.core.utils.colors
        • tcolors
      • bilby.core.utils.constants
      • bilby.core.utils.conversion
        • ra_dec_to_theta_phi
        • theta_phi_to_ra_dec
      • bilby.core.utils.counter
        • Counter
      • bilby.core.utils.docs
        • docstring
      • bilby.core.utils.entry_points
      • bilby.core.utils.env
        • string_to_boolean
      • bilby.core.utils.introspection
        • get_dict_with_properties
        • get_function_path
        • infer_args_from_function_except_n_args
        • infer_args_from_method
        • infer_parameters_from_function
        • PropertyAccessor
      • bilby.core.utils.io
        • check_directory_exists_and_if_not_mkdir
        • decode_astropy_cosmology
        • decode_astropy_quantity
        • decode_astropy_unit
        • decode_bilby_json
        • decode_from_hdf5
        • decode_hdf5_dict
        • decode_lal_dict
        • decode_numpy_random_generator
        • decode_numpy_seed_sequence
        • encode_astropy_cosmology
        • encode_astropy_quantity
        • encode_astropy_unit
        • encode_for_hdf5
        • encode_lal_dict
        • encode_numpy_random_generator
        • encode_numpy_seed_sequence
        • load_json
        • move_old_file
        • recursively_decode_bilby_json
        • recursively_load_dict_contents_from_group
        • recursively_save_dict_contents_to_group
        • safe_file_dump
        • safe_save_figure
        • BilbyJsonEncoder
      • bilby.core.utils.log
        • env_package_list
        • get_version_information
        • loaded_modules_dict
        • setup_logger
      • bilby.core.utils.meta_data
        • GlobalMetaData
      • bilby.core.utils.parallel
        • bilby_pool
        • close_pool
        • create_pool
        • initialize_global_variables
      • bilby.core.utils.plotting
        • latex_plot_format
      • bilby.core.utils.random
        • generate_seeds
        • random_array_module
        • resolve_random_state
        • seed
        • Generator
      • bilby.core.utils.samples
        • kish_log_effective_sample_size
        • reflect
        • SamplesSummary
      • bilby.core.utils.series
        • create_frequency_series
        • create_time_series
        • create_white_noise
        • get_sampling_frequency
        • get_sampling_frequency_and_duration_from_frequency_array
        • get_sampling_frequency_and_duration_from_time_array
        • infft
        • nfft
        • safe_white_noise
        • IllegalDurationAndSamplingFrequencyException
  • bilby.gw
    • bilby.gw.compat
      • bilby.gw.compat.cython
      • bilby.gw.compat.jax
      • bilby.gw.compat.pytrees
        • cubic_spline_flatten
        • cubic_spline_unflatten
        • geometry_flatten
        • geometry_unflatten
        • interferometer_flatten
        • interferometer_list_flatten
        • interferometer_list_unflatten
        • interferometer_unflatten
        • likelihood_flatten
        • likelihood_unflatten
        • notch_list_flatten
        • notch_list_unflatten
        • precomputed_flatten
        • precomputed_unflatten
        • psd_flatten
        • psd_unflatten
        • recalibrate_flatten
        • recalibrate_unflatten
        • strain_data_flatten
        • strain_data_unflatten
        • wfg_flatten
        • wfg_unflatten
      • bilby.gw.compat.torch
    • bilby.gw.conversion
      • bilby_to_lalsimulation_spins
      • binary_love_fit_lambda_symmetric_mass_ratio_to_lambda_antisymmetric
      • binary_love_lambda_symmetric_to_lambda_1_lambda_2_automatic_marginalisation
      • binary_love_lambda_symmetric_to_lambda_1_lambda_2_manual_marginalisation
      • chirp_mass_and_mass_ratio_to_component_masses
      • chirp_mass_and_mass_ratio_to_total_mass
      • chirp_mass_and_primary_mass_to_mass_ratio
      • chirp_mass_and_total_mass_to_symmetric_mass_ratio
      • comoving_distance_to_luminosity_distance
      • comoving_distance_to_redshift
      • component_masses_to_chirp_mass
      • component_masses_to_mass_ratio
      • component_masses_to_symmetric_mass_ratio
      • component_masses_to_total_mass
      • compute_per_detector_log_likelihoods
      • compute_snrs
      • convert_to_lal_binary_black_hole_parameters
      • convert_to_lal_binary_neutron_star_parameters
      • eos_family_physical_check
      • fill_from_fixed_priors
      • fill_sample
      • generate_all_bbh_parameters
      • generate_all_bns_parameters
      • generate_component_masses
      • generate_component_spins
      • generate_mass_parameters
      • generate_posterior_samples_from_marginalized_likelihood
      • generate_sky_frame_parameters
      • generate_source_frame_parameters
      • generate_specific_parameters
      • generate_spin_parameters
      • generate_tidal_parameters
      • identity_map_conversion
      • identity_map_generation
      • lambda_1_lambda_2_to_delta_lambda_tilde
      • lambda_1_lambda_2_to_lambda_antisymmetric
      • lambda_1_lambda_2_to_lambda_symmetric
      • lambda_1_lambda_2_to_lambda_tilde
      • lambda_from_mass_and_family
      • lambda_symmetric_lambda_antisymmetric_to_lambda_1
      • lambda_symmetric_lambda_antisymmetric_to_lambda_1_lambda_2
      • lambda_symmetric_lambda_antisymmetric_to_lambda_2
      • lambda_tilde_delta_lambda_tilde_to_lambda_1_lambda_2
      • lambda_tilde_to_lambda_1_lambda_2
      • log_pressure_reparameterization_conversion
      • luminosity_distance_to_comoving_distance
      • luminosity_distance_to_redshift
      • mass_1_and_chirp_mass_to_mass_ratio
      • mass_2_and_chirp_mass_to_mass_ratio
      • neutron_star_family_physical_check
      • polytrope_or_causal_params_to_lambda_1_lambda_2
      • redshift_to_comoving_distance
      • redshift_to_luminosity_distance
      • spectral_params_to_lambda_1_lambda_2
      • spectral_pca_to_spectral
      • symmetric_mass_ratio_to_mass_ratio
      • total_mass_and_mass_ratio_to_component_masses
    • bilby.gw.cosmology
      • get_available_cosmologies
      • get_cosmology
      • set_cosmology
      • z_at_value
    • bilby.gw.detector
      • get_interferometer_with_fake_noise_and_injection
      • get_safe_signal_duration
      • inject_signal_into_gwpy_timeseries
      • load_data_by_channel_name
      • load_data_from_cache_file
      • bilby.gw.detector.calibration
        • build_calibration_lookup
        • curves_from_spline_and_prior
        • read_calibration_file
        • write_calibration_file
        • CubicSpline
        • Precomputed
        • Recalibrate
      • bilby.gw.detector.geometry
        • InterferometerGeometry
      • bilby.gw.detector.interferometer
        • Interferometer
      • bilby.gw.detector.networks
        • get_empty_interferometer
        • load_interferometer
        • InterferometerList
        • TriangularInterferometer
      • bilby.gw.detector.psd
        • PowerSpectralDensity
      • bilby.gw.detector.strain_data
        • InterferometerStrainData
        • Notch
        • NotchList
    • bilby.gw.eos
      • bilby.gw.eos.eos
        • spectral_adiabatic_index
        • EOSFamily
        • SpectralDecompositionEOS
        • TabularEOS
      • bilby.gw.eos.tov_solver
        • IntegrateTOV
    • bilby.gw.geometry
      • antenna_response
      • calculate_arm
      • detector_tensor
      • get_polarization_tensor
      • get_polarization_tensor_multiple_modes
      • rotation_matrix_from_delta
      • three_by_three_matrix_contraction
      • time_delay_from_geocenter
      • time_delay_geocentric
      • zenith_azimuth_to_theta_phi
    • bilby.gw.likelihood
      • get_binary_black_hole_likelihood
      • bilby.gw.likelihood.base
        • GravitationalWaveTransient
      • bilby.gw.likelihood.basic
        • BasicGravitationalWaveTransient
      • bilby.gw.likelihood.multiband
        • MBGravitationalWaveTransient
      • bilby.gw.likelihood.relative
        • RelativeBinningGravitationalWaveTransient
      • bilby.gw.likelihood.roq
        • ROQGravitationalWaveTransient
        • BilbyROQParamsRangeError
    • bilby.gw.prior
      • convert_to_flat_in_component_mass_prior
      • secondary_mass_condition_function
      • AlignedSpin
      • BBHPriorDict
      • BNSPriorDict
      • CBCPriorDict
      • CalibrationPriorDict
      • ConditionalChiInPlane
      • ConditionalChiUniformSpinMagnitude
      • Cosmological
      • EOSCheck
      • HealPixMapPriorDist
      • HealPixPrior
      • UniformComovingVolume
      • UniformInComponentsChirpMass
      • UniformInComponentsMassRatio
      • UniformSourceFrame
      • BilbyPriorConversionError
    • bilby.gw.result
      • CBCResult
      • CompactBinaryCoalescenceResult
    • bilby.gw.sampler
      • bilby.gw.sampler.proposal
        • CorrelatedPolarisationPhaseJump
        • PolarisationPhaseJump
        • SkyLocationWanderJump
    • bilby.gw.source
      • binary_black_hole_frequency_sequence
      • binary_black_hole_roq
      • binary_neutron_star_frequency_sequence
      • binary_neutron_star_roq
      • gwsignal_binary_black_hole
      • lal_binary_black_hole
      • lal_binary_black_hole_relative_binning
      • lal_binary_neutron_star
      • lal_binary_neutron_star_relative_binning
      • lal_eccentric_binary_black_hole_no_spins
      • set_waveform_dictionary
      • sinegaussian
      • supernova
      • supernova_pca_model
    • bilby.gw.time
      • gps_time_to_utc
      • greenwich_mean_sidereal_time
      • greenwich_sidereal_time
      • n_leap_seconds
      • utc_to_julian_day
      • datetime
    • bilby.gw.utils
      • calculate_time_to_merger
      • convert_args_list_to_float
      • get_event_time
      • get_gracedb
      • get_open_strain_data
      • gracedb_to_json
      • gw_data_find
      • inner_product
      • lalsim_CreateSimNeutronStarFamily
      • lalsim_GetApproximantFromString
      • lalsim_SimInspiralChooseFDWaveform
      • lalsim_SimInspiralChooseFDWaveformSequence
      • lalsim_SimInspiralFD
      • lalsim_SimInspiralTransformPrecessingNewInitialConditions
      • lalsim_SimInspiralWaveformParamsInsertTidalLambda1
      • lalsim_SimInspiralWaveformParamsInsertTidalLambda2
      • lalsim_SimNeutronStarEOS3PDViableFamilyCheck
      • lalsim_SimNeutronStarEOS3PieceCausalAnalytic
      • lalsim_SimNeutronStarEOS3PieceDynamicPolytrope
      • lalsim_SimNeutronStarEOS4ParamSDGammaCheck
      • lalsim_SimNeutronStarEOS4ParamSDViableFamilyCheck
      • lalsim_SimNeutronStarEOS4ParameterSpectralDecomposition
      • lalsim_SimNeutronStarEOSMaxPseudoEnthalpy
      • lalsim_SimNeutronStarEOSSpeedOfSoundGeometerized
      • lalsim_SimNeutronStarFamMinimumMass
      • lalsim_SimNeutronStarLoveNumberK2
      • lalsim_SimNeutronStarMaximumMass
      • lalsim_SimNeutronStarRadius
      • matched_filter_snr
      • noise_weighted_inner_product
      • optimal_snr_squared
      • overlap
      • plot_spline_pos
      • read_frame_file
      • safe_cast_mode_to_int
      • zenith_azimuth_to_ra_dec
    • bilby.gw.waveform_generator
      • GWSignalWaveformGenerator
      • LALCBCWaveformGenerator
      • WaveformGenerator
  • bilby.hyper
    • bilby.hyper.compat
      • bilby.hyper.compat.pytrees
        • hyperparameter_likelihood_flatten
        • hyperparameter_likelihood_unflatten
        • model_flatten
        • model_unflatten
    • bilby.hyper.likelihood
      • HyperparameterLikelihood
    • bilby.hyper.model
      • Model
  • bilby.bilby_mcmc
    • bilby.bilby_mcmc.chain
      • calculate_tau
      • Chain
      • Sample
    • bilby.bilby_mcmc.flows
      • BasicFlow
      • NVPFlow
    • bilby.bilby_mcmc.proposals
      • get_default_ensemble_proposal_cycle
      • get_proposal_cycle
      • remove_proposals_using_string
      • AdaptiveGaussianProposal
      • BaseGravitationalWaveTransientProposal
      • BaseProposal
      • CorrelatedPolarisationPhaseJump
      • DensityEstimateProposal
      • DifferentialEvolutionProposal
      • EnsembleProposal
      • EnsembleStretch
      • FisherMatrixProposal
      • FixedGaussianProposal
      • FixedJumpProposal
      • GMMProposal
      • KDEProposal
      • NormalizingFlowProposal
      • PhasePolarisationReversalProposal
      • PhaseReversalProposal
      • PolarisationReversalProposal
      • PriorProposal
      • ProposalCycle
      • StretchProposal
      • UniformProposal
    • bilby.bilby_mcmc.sampler
      • call_step
      • get_initial_maximimum_posterior_sample
      • BilbyMCMCSampler
      • BilbyPTMCMCSampler
      • Bilby_MCMC
    • bilby.bilby_mcmc.utils
      • ConvergenceInputs
      • ParallelTemperingInputs
Back to top
View this page
Edit this page

prior_flatten¶

prior_flatten(prior: Prior)[source]¶
Next
prior_unflatten
Previous
dirichlet_dict_unflatten
Copyright © 2019, The Bilby Developers
Made with Sphinx and @pradyunsg's Furo
On this page
  • prior_flatten
    • prior_flatten()