x-psi
User Guide
Installation
Overview
FAQs and common problems
Publications
HPC systems
Development
Code of Conduct
Contributing
History
Future
Team and acknowledgements
Citation
Tutorials
Start here
Modeling
Instrument synergy
Hot region complexity
Global surface emission
Surface radiation field tools
Modeling (without statistics)
Polarization
Post-processing
Emitting Patterns 2D Projection
Importance Sampling
Module generator tutorial
Example script and modules
Example job
Posterior Inference using SBI
Likelihood API
Parameter
ParameterSubspace
Likelihood
Signal
Instrument
Data
Star
Spacetime
Photosphere
HotRegion
HotRegions
Elsewhere
Everywhere
Interstellar
Background
Extension modules
Overview of extension modules
Surface radiation field
Likelihoods
Tools
Posterior API
Prior
Posterior
Sample
PostProcessing
Wrappers for SBI
x-psi
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
X
|
Z
_
__call__() (xpsi.Background.Background method)
(xpsi.Instrument.Instrument method)
(xpsi.Interstellar.Interstellar method)
(xpsi.Likelihood.Likelihood method)
(xpsi.Parameter.Derive method)
(xpsi.Parameter.Parameter method)
(xpsi.ParameterSubspace.ParameterSubspace method)
(xpsi.Posterior.Posterior method)
(xpsi.Prior.Prior method)
(xpsi.Signal.Signal method)
__compute_cellParamVecs() (xpsi.HotRegion.HotRegion method)
__compute_rays() (xpsi.HotRegion.HotRegion method)
__construct_cellMesh() (xpsi.HotRegion.HotRegion method)
__getitem__() (xpsi.ParameterSubspace.ParameterSubspace method)
__iter__() (xpsi.ParameterSubspace.ParameterSubspace method)
__next__() (xpsi.ParameterSubspace.ParameterSubspace method)
__repr__() (xpsi.Parameter.Parameter method)
(xpsi.ParameterSubspace.ParameterSubspace method)
__setitem__() (xpsi.ParameterSubspace.ParameterSubspace method)
__str__() (xpsi.Likelihood.Likelihood method)
(xpsi.Parameter.Parameter method)
(xpsi.ParameterSubspace.ParameterSubspace method)
_animate() (xpsi.Photosphere.Photosphere static method)
_compute_cellParamVecs() (xpsi.Elsewhere.Elsewhere method)
(xpsi.Everywhere.Everywhere method)
_compute_rays() (xpsi.Elsewhere.Elsewhere method)
(xpsi.Everywhere.Everywhere method)
_construct_cellMesh() (xpsi.Elsewhere.Elsewhere method)
(xpsi.Everywhere.Everywhere method)
_driver() (xpsi.SBI_wrapper.Custom_SBI_Likelihood method)
_plot_sky_maps() (xpsi.Photosphere.Photosphere method)
_update_doc() (xpsi.ParameterSubspace.ParameterSubspace class method)
A
add_pulses() (xpsi.PostProcessing.ResidualPlot method)
attenuation() (xpsi.Interstellar.Interstellar method)
B
Background (class in xpsi.Background)
background (xpsi.Signal.Signal property)
background_signal (xpsi.Signal.Signal property)
BackgroundError (class in xpsi.Background)
bolometric_chi2 (xpsi.Signal.Signal property)
bounds (xpsi.Parameter.Parameter property)
(xpsi.PostProcessing._metadata.Metadata property)
C
cached (xpsi.Parameter.Parameter property)
(xpsi.ParameterSubspace.ParameterSubspace property)
cached_signal (xpsi.Instrument.Instrument property)
caching_target_names (xpsi.Signal.Signal property)
caching_targets (xpsi.Signal.Signal property)
cede (xpsi.HotRegion.HotRegion property)
channel_edges (xpsi.Instrument.Instrument property)
ChannelError (class in xpsi.Instrument)
channels (xpsi.Data.Data property)
(xpsi.Instrument.Instrument property)
check() (xpsi.Likelihood.Likelihood method)
clear_cache() (xpsi.ParameterSubspace.ParameterSubspace method)
combined (xpsi.PostProcessing.Runs property)
concentric (xpsi.HotRegion.HotRegion property)
construct_energy_array() (in module xpsi.Signal)
construct_matrix() (xpsi.Instrument.Instrument method)
contours (xpsi.PostProcessing._run.Run property)
CornerPlotter (class in xpsi.PostProcessing)
create_energy_array() (xpsi.Signal.Signal method)
Custom_SBI_Likelihood (class in xpsi.SBI_wrapper)
D
d (xpsi.Spacetime.Spacetime property)
d_sq (xpsi.Spacetime.Spacetime property)
Data (class in xpsi.Data)
data (xpsi.Signal.Signal property)
declare_settings() (xpsi.PostProcessing._signalplot.SignalPlot class method)
Derive (class in xpsi.Parameter)
doc (xpsi.Parameter.Parameter property)
draw() (xpsi.Prior.Prior method)
E
EdgesError (class in xpsi.Instrument)
effective_gravity() (in module xpsi.surface_radiation_field)
Elsewhere (class in xpsi.Elsewhere)
elsewhere (xpsi.Photosphere.Photosphere property)
elsewhere_atmosphere (xpsi.Photosphere.Photosphere property)
embed() (xpsi.Elsewhere.Elsewhere method)
(xpsi.Everywhere.Everywhere method)
(xpsi.HotRegion.HotRegion method)
(xpsi.HotRegions.HotRegions method)
(xpsi.Photosphere.Photosphere method)
energy_edges (xpsi.Instrument.Instrument property)
(xpsi.Signal.Signal property)
energy_integrator() (in module xpsi.tools)
energy_interpolator() (in module xpsi.tools)
ensemble() (in module xpsi.Sample)
epsilon (xpsi.Spacetime.Spacetime property)
estimate_hypercube_frac() (xpsi.Prior.Prior method)
eval_marginal_likelihood() (in module xpsi.likelihoods)
evaluate() (xpsi.Parameter.Parameter method)
Everywhere (class in xpsi.Everywhere)
everywhere (xpsi.Photosphere.Photosphere property)
evidence_error() (xpsi.PostProcessing.CornerPlotter method)
execute() (xpsi.PostProcessing._signalplot.SignalPlot method)
(xpsi.PostProcessing.PulsePlot method)
(xpsi.PostProcessing.ResidualPlot method)
(xpsi.PostProcessing.SpectrumPlot method)
execute_custom_cache_instructions() (xpsi.Signal.Signal method)
expected_attenuated_incident (xpsi.PostProcessing.SpectrumPlot property)
expected_background (xpsi.PostProcessing.SpectrumPlot property)
expected_counts (xpsi.PostProcessing.ResidualPlot property)
expected_incident (xpsi.PostProcessing.PulsePlot property)
(xpsi.PostProcessing.SpectrumPlot property)
expected_registered (xpsi.PostProcessing.PulsePlot property)
(xpsi.PostProcessing.SpectrumPlot property)
exposure_time (xpsi.Data.Data property)
F
f (xpsi.Spacetime.Spacetime property)
fast_energies (xpsi.Signal.Signal property)
fig (xpsi.PostProcessing._signalplot.SignalPlot property)
finalize() (xpsi.PostProcessing._signalplot.SignalPlot method)
(xpsi.PostProcessing.PulsePlot method)
(xpsi.PostProcessing.ResidualPlot method)
(xpsi.PostProcessing.SpectrumPlot method)
fixed (xpsi.Parameter.Parameter property)
G
get_attr() (xpsi.PostProcessing._postprocessor.PostProcessor method)
(xpsi.PostProcessing.Runs method)
get_param() (xpsi.ParameterSubspace.ParameterSubspace method)
getdist_backend (xpsi.PostProcessing._backends.NestedBackend property)
global_variables (xpsi.Photosphere.Photosphere property)
H
hot (xpsi.Photosphere.Photosphere property)
hot_atmosphere (xpsi.Photosphere.Photosphere property)
HotRegion (class in xpsi.HotRegion)
HotRegions (class in xpsi.HotRegions)
I
i (xpsi.Spacetime.Spacetime property)
ID (xpsi.PostProcessing._metadata.Metadata property)
image() (xpsi.Photosphere.Photosphere method)
images (xpsi.Photosphere.Photosphere property)
implementation (xpsi.PostProcessing._metadata.Metadata property)
incident_background (xpsi.Background.Background property)
incident_flux_signals (xpsi.Signal.Signal property)
incident_specific_flux_signals (xpsi.Signal.Signal property)
index() (xpsi.ParameterSubspace.ParameterSubspace method)
index_range (xpsi.Data.Data property)
Instrument (class in xpsi.Instrument)
instrument (xpsi.Signal.Signal property)
integrate() (xpsi.Elsewhere.Elsewhere method)
(xpsi.Everywhere.Everywhere method)
(xpsi.HotRegion.HotRegion method)
(xpsi.HotRegions.HotRegions method)
(xpsi.Photosphere.Photosphere method)
integrate_stokes() (xpsi.HotRegion.HotRegion method)
IntegrationError (class in xpsi.Elsewhere)
(class in xpsi.Everywhere)
intensity() (in module xpsi.surface_radiation_field)
intensity_from_globals() (in module xpsi.surface_radiation_field)
Interstellar (class in xpsi.Interstellar)
interstellar (xpsi.Signal.Signal property)
inverse_sample() (xpsi.Prior.Prior method)
inverse_sample_and_transform() (xpsi.Prior.Prior method)
is_hyperparameter (xpsi.Parameter.Parameter property)
isI (xpsi.Signal.Signal property)
isQ (xpsi.Signal.Signal property)
isQn (xpsi.Signal.Signal property)
isU (xpsi.Signal.Signal property)
isUn (xpsi.Signal.Signal property)
K
kde_settings (xpsi.PostProcessing._metadata.Metadata property)
KL_divergence() (xpsi.PostProcessing.CornerPlotter method)
L
labels (xpsi.PostProcessing._metadata.Metadata property)
leaves (xpsi.HotRegion.HotRegion property)
less_than_llzero (xpsi.Likelihood.Likelihood property)
Likelihood (class in xpsi.Likelihood)
likelihood (xpsi.Posterior.Posterior property)
(xpsi.PostProcessing.Runs property)
LikelihoodError (class in xpsi.Signal)
lines (xpsi.PostProcessing._run.Run property)
llzero (xpsi.Likelihood.Likelihood property)
load_image_data() (xpsi.Photosphere.Photosphere method)
load_runs() (xpsi.PostProcessing.Runs class method)
log_prob() (xpsi.SBI_wrapper.xpsi_wrappers method)
loglikelihood (xpsi.Signal.Signal property)
M
M (xpsi.Spacetime.Spacetime property)
margeStats (xpsi.PostProcessing._backends.NestedBackend property)
matrix (xpsi.Instrument.Instrument property)
merge() (xpsi.ParameterSubspace.ParameterSubspace method)
Metadata (class in xpsi.PostProcessing._metadata)
model_sum (xpsi.PostProcessing.ResidualPlot property)
module
xpsi
xpsi.Background
xpsi.Data
xpsi.Elsewhere
xpsi.Everywhere
xpsi.HotRegion
xpsi.HotRegions
xpsi.Instrument
xpsi.Interstellar
xpsi.Likelihood
xpsi.likelihoods
xpsi.Parameter
xpsi.ParameterSubspace
xpsi.Photosphere
xpsi.Posterior
xpsi.PostProcessing
xpsi.Prior
xpsi.Sample
xpsi.SBI_wrapper
xpsi.Signal
xpsi.Spacetime
xpsi.Star
xpsi.surface_radiation_field
xpsi.tools
N
name (xpsi.Parameter.Parameter property)
names (xpsi.ParameterSubspace.ParameterSubspace property)
(xpsi.PostProcessing._metadata.Metadata property)
needs_update (xpsi.Parameter.Parameter property)
(xpsi.ParameterSubspace.ParameterSubspace property)
nestcheck_backend (xpsi.PostProcessing._backends.NestedBackend property)
nested() (in module xpsi.Sample)
NestedBackend (class in xpsi.PostProcessing._backends)
num_cells (xpsi.Elsewhere.Elsewhere property)
(xpsi.Everywhere.Everywhere property)
(xpsi.HotRegion.HotRegion property)
num_rays (xpsi.Elsewhere.Elsewhere property)
(xpsi.Everywhere.Everywhere property)
(xpsi.HotRegion.HotRegion property)
O
Omega (xpsi.Spacetime.Spacetime property)
original_data (xpsi.Signal.Signal property)
original_instrument (xpsi.Signal.Signal property)
P
Parameter (class in xpsi.Parameter)
ParameterSubspace (class in xpsi.ParameterSubspace)
params (xpsi.ParameterSubspace.ParameterSubspace property)
(xpsi.PostProcessing._postprocessor.PostProcessor property)
parent_ID (xpsi.PostProcessing._metadata.Metadata property)
permit_prepend (xpsi.Parameter.Parameter property)
phase_bin__event_list() (xpsi.Data.Data class method)
phase_integrator() (in module xpsi.tools)
phase_interpolator() (in module xpsi.tools)
phases (xpsi.Data.Data property)
(xpsi.HotRegion.HotRegion property)
phases_in_cycles (xpsi.Everywhere.Everywhere property)
(xpsi.HotRegion.HotRegion property)
Photosphere (class in xpsi.Photosphere)
photospheres (xpsi.Star.Star property)
plot() (xpsi.PostProcessing.CornerPlotter method)
(xpsi.PostProcessing.SignalPlotter method)
plots (xpsi.PostProcessing.SignalPlotter property)
poisson_likelihood_given_background() (in module xpsi.likelihoods)
Posterior (class in xpsi.Posterior)
posteriors (xpsi.PostProcessing._postprocessor.PostProcessor property)
PostProcessor (class in xpsi.PostProcessing._postprocessor)
precisions (xpsi.PostProcessing._metadata.Metadata property)
precomputation() (in module xpsi.likelihoods)
prefix (xpsi.ParameterSubspace.ParameterSubspace property)
prepend_ID (xpsi.PostProcessing._metadata.Metadata property)
print_settings() (xpsi.Elsewhere.Elsewhere method)
(xpsi.Everywhere.Everywhere method)
(xpsi.HotRegion.HotRegion method)
(xpsi.HotRegions.HotRegions method)
Prior (class in xpsi.Prior)
prior (xpsi.Posterior.Posterior property)
PriorError (class in xpsi.Posterior)
psi() (xpsi.HotRegion.HotRegion static method)
PulseError (class in xpsi.HotRegion)
PulsePlot (class in xpsi.PostProcessing)
R
R (xpsi.Spacetime.Spacetime property)
r_g (xpsi.Spacetime.Spacetime property)
R_r_s (xpsi.Spacetime.Spacetime property)
r_s (xpsi.Spacetime.Spacetime property)
random_near_llzero (xpsi.Likelihood.Likelihood property)
RayError (class in xpsi.Elsewhere)
(class in xpsi.Everywhere)
(class in xpsi.HotRegion)
register() (xpsi.Signal.Signal method)
registered_background (xpsi.Background.Background property)
ResidualPlot (class in xpsi.PostProcessing)
ResponseError (class in xpsi.Instrument)
Run (class in xpsi.PostProcessing._run)
Runs (class in xpsi.PostProcessing)
runs (xpsi.PostProcessing.Runs property)
S
sample() (xpsi.SBI_wrapper.xpsi_wrappers method)
samples (xpsi.PostProcessing._run.Run property)
savefig() (xpsi.PostProcessing._signalplot.SignalPlot method)
set_params() (xpsi.PostProcessing._postprocessor.PostProcessor method)
set_phases() (xpsi.Everywhere.Everywhere method)
(xpsi.HotRegion.HotRegion method)
set_subset() (xpsi.PostProcessing._postprocessor.PostProcessor method)
(xpsi.PostProcessing.Runs method)
shifts (xpsi.Signal.Signal property)
Signal (class in xpsi.Signal)
signal (xpsi.Photosphere.Photosphere property)
SignalPlot (class in xpsi.PostProcessing._signalplot)
SignalPlotter (class in xpsi.PostProcessing)
signalQ (xpsi.Photosphere.Photosphere property)
signals (xpsi.Likelihood.Likelihood property)
(xpsi.Signal.Signal property)
signalU (xpsi.Photosphere.Photosphere property)
simulator() (xpsi.SBI_wrapper.xpsi_wrappers method)
Spacetime (class in xpsi.Spacetime)
spacetime (xpsi.Photosphere.Photosphere property)
SpectrumPlot (class in xpsi.PostProcessing)
sqrt_num_cells (xpsi.Elsewhere.Elsewhere property)
(xpsi.Everywhere.Everywhere property)
(xpsi.HotRegion.HotRegion property)
Star (class in xpsi.Star)
star (xpsi.Likelihood.Likelihood property)
strict_bounds (xpsi.Parameter.Parameter property)
subset (xpsi.PostProcessing._postprocessor.PostProcessor property)
(xpsi.PostProcessing.Runs property)
subset_to_plot (xpsi.PostProcessing._postprocessor.PostProcessor property)
(xpsi.PostProcessing.Runs property)
symbol (xpsi.Parameter.Parameter property)
synthesise() (in module xpsi.SBI_wrapper)
(xpsi.Likelihood.Likelihood method)
(xpsi.SBI_wrapper.Custom_SBI_Likelihood method)
(xpsi.Signal.Signal method)
synthesise_exposure() (in module xpsi.tools)
synthesise_given_total_count_number() (in module xpsi.tools)
SynthesiseData (class in xpsi.SBI_wrapper)
T
threads (xpsi.Likelihood.Likelihood property)
transform() (xpsi.Prior.Prior static method)
truth_vector (xpsi.PostProcessing._metadata.Metadata property)
truths (xpsi.PostProcessing._metadata.Metadata property)
U
ultranested() (in module xpsi.Sample)
unit_hypercube_frac (xpsi.Prior.Prior property)
update() (xpsi.Star.Star method)
V
value (xpsi.Parameter.Parameter property)
vector (xpsi.ParameterSubspace.ParameterSubspace property)
W
write_image_data() (xpsi.Photosphere.Photosphere method)
X
xpsi
module
xpsi.Background
module
xpsi.Data
module
xpsi.Elsewhere
module
xpsi.Everywhere
module
xpsi.HotRegion
module
xpsi.HotRegions
module
xpsi.Instrument
module
xpsi.Interstellar
module
xpsi.Likelihood
module
xpsi.likelihoods
module
xpsi.Parameter
module
xpsi.ParameterSubspace
module
xpsi.Photosphere
module
xpsi.Posterior
module
xpsi.PostProcessing
module
xpsi.Prior
module
xpsi.Sample
module
xpsi.SBI_wrapper
module
xpsi.Signal
module
xpsi.Spacetime
module
xpsi.Star
module
xpsi.surface_radiation_field
module
xpsi.tools
module
xpsi_wrappers (class in xpsi.SBI_wrapper)
Z
zeta (xpsi.Spacetime.Spacetime property)