autofit.SamplesStored#
- class autofit.SamplesStored(model: AbstractPriorModel, sample_list: List[Sample], samples_info: Dict | None = None)[source]#
Bases:
SamplesPDFThe Samples of a non-linear search, specifically the samples of a NonLinearSearch which maps out the posterior of parameter space and thus does provide information on parameter errors.
- Parameters:
model (af.ModelMapper) – Maps input vectors of unit parameter values to physical values and model instances via priors.
Methods
draw_randomly_via_pdfThe parameter vector of an individual sample of the non-linear search drawn randomly from the PDF, returned as a 1D list.
error_magnitudes_at_sigmaThe magnitude of every error after marginalization in 1D at an input sigma value of the probability density function (PDF), returned as two lists of values corresponding to the lower and upper errors.
errors_at_lower_sigmaThe lower error of every parameter marginalized in 1D at an input sigma value of its probability density function (PDF), returned as a list.
errors_at_sigmaThe lower and upper error of every parameter marginalized in 1D at an input sigma value of its probability density function (PDF), returned as a list.
errors_at_upper_sigmaThe upper error of every parameter marginalized in 1D at an input sigma value of its probability density function (PDF), returned as a list.
from_list_info_and_modelfrom_sample_indexThe parameters of an individual sample of the non-linear search, returned as a model instance.
from_tableWrite a table of parameters, posteriors, priors and likelihoods
info_to_jsonmax_log_likelihoodThe parameters of the maximum log likelihood sample of the NonLinearSearch returned as a model instance or list of values.
max_log_posteriorThe parameters of the maximum log posterior sample of the NonLinearSearch returned as a model instance.
median_pdfThe median of the probability density function (PDF) of every parameter marginalized in 1D, returned as a model instance or list of values.
minimiseA copy of this object with only important samples retained
model_centred_absoluteReturns a model where every free parameter is a GaussianPrior with mean the previous result's inferred maximum log likelihood parameter values and sigma the input absolute value a.
model_centred_max_lh_boundedReturns a model where every free parameter is a UniformPrior with lower_limit and upper_limit the previous result's inferred maximum log likelihood parameter values minus and plus the bound `b.
model_centred_relativeReturns a model where every free parameter is a GaussianPrior with mean the previous result's inferred maximum log likelihood parameter values and sigma a relative value from the result r.
offset_values_via_input_valuesThe values of an input_vector offset by the median_pdf(as_instance=False) (the PDF medians).
path_map_for_modelsamples_above_weight_threshold_fromReturns a new Samples object containing only the samples with a weight above the input threshold.
samples_drawn_randomly_via_pdf_fromDraw one or more samples randomly from the PDF, weighted by the sample weights.
save_covariance_matrixSave the covariance matrix as a CSV file.
subsamplessummaryvalues_at_lower_sigmaThe lower value of every parameter marginalized in 1D at an input sigma value of its probability density function (PDF), returned as a list.
values_at_sigmaThe value of every parameter marginalized in 1D at an input sigma value of its probability density function (PDF), returned as two lists of values corresponding to the lower and upper values parameter values.
values_at_upper_sigmaThe upper value of every parameter marginalized in 1D at an input sigma value of its probability density function (PDF), returned as a list.
values_for_pathReturns the value for a variable with a given path for each sample in the model
with_pathsCreate a copy of this object with only attributes specified by a list of paths.
without_pathsCreate a copy of this object with only attributes not specified by a list of paths.
write_tableWrite a table of parameters, posteriors, priors and likelihoods.
Attributes
covariance_matrixCompute the covariance matrix of the non-linear search samples, using the method np.cov() which is described at the following link:
instanceinstancesOne model instance for each sample
log_evidencelog_likelihoodlog_likelihood_listlog_posterior_listlog_prior_listmax_log_likelihood_indexThe index of the sample with the highest log likelihood.
max_log_likelihood_sampleThe index of the sample with the highest log likelihood.
max_log_posterior_indexThe index of the sample with the highest log posterior.
max_log_posterior_samplemodel_centredReturns a model where every free parameter is a GaussianPrior with mean the previous result's inferred maximum log likelihood parameter values and sigma values determined from the errors on each parameter or the prior config files
namesA list of names of unique priors in the same order as prior ids (and therefore sample columns)
parameter_listsparameters_extractpathsA list of paths to unique priors in the same order as prior ids (and therefore sample columns)
pdf_convergedTo analyse and visualize samples the analysis must be sufficiently converged to produce smooth enough PDF for error estimate and PDF generation.
prior_meansThe mean of every parameter used to link its inferred values and errors to priors used to sample the same (or similar) parameters in a subsequent search, where:
timetotal_iterationstotal_samplesunconverged_sample_sizeIf a set of samples are unconverged, alternative methods to compute their means, errors, etc are used.
weight_list