LALInferenceProposal.h File Reference

Prototypes
LALInferenceProposal *	LALInferenceInitProposal (LALInferenceProposalFunction func, const char *name)
	Creates a new proposal object from the given func pointer and name. More...
void	LALInferenceRegisterProposal (LALInferenceVariables *propArgs, const char *name, INT4 *flag, ProcessParamsTable *command_line)
	Use a default flag and a check of the command-line to set proposal flags in proposal args. More...
void	LALInferenceAddProposalToCycle (LALInferenceProposalCycle *cycle, LALInferenceProposal *prop, INT4 weight)
	Adds weight copies of the proposal prop to the end of the proposal cycle. More...
void	LALInferenceRandomizeProposalCycle (LALInferenceProposalCycle *cycle, gsl_rng *rng)
	Randomizes the order of the proposals in the proposal cycle. More...
LALInferenceProposalCycle *	LALInferenceInitProposalCycle (void)
	Create a new proposal cycle. More...
LALInferenceVariables *	LALInferenceParseProposalArgs (LALInferenceRunState *runState)
	Go through all logic for deciding proposals to use. More...
REAL8	LALInferenceCyclicProposal (LALInferenceThreadState *thread, LALInferenceVariables *currentParams, LALInferenceVariables *proposedParams)
	Proposes a jump from the next proposal in the proposal cycle. More...
void	LALInferenceDeleteProposalCycle (LALInferenceProposalCycle *cycle)
	Completely remove the current proposal cycle, freeing the associated memory. More...
LALInferenceProposalCycle *	LALInferenceSetupDefaultInspiralProposalCycle (LALInferenceVariables *propArgs)
	A reasonable default proposal. More...
REAL8	LALInferenceSingleProposal (LALInferenceThreadState *thread, LALInferenceVariables *currentParams, LALInferenceVariables *proposedParams)
	Non-adaptive, sigle-variable update proposal with reasonable widths in each dimension. More...
REAL8	LALInferenceSingleAdaptProposal (LALInferenceThreadState *thread, LALInferenceVariables *currentParams, LALInferenceVariables *proposedParams)
	Like LALInferenceSingleProposal() but will use adaptation if the –adapt command-line flag given. More...
REAL8	LALInferencePolarizationPhaseJump (LALInferenceThreadState *thread, LALInferenceVariables *currentParams, LALInferenceVariables *proposedParams)
	Polarization-phase exact degeneracy. More...
REAL8	LALInferenceCorrPolarizationPhaseJump (LALInferenceThreadState *thread, LALInferenceVariables *currentParams, LALInferenceVariables *proposedParams)
	Polarization-phase correlation jump. More...
REAL8	LALInferenceCovarianceEigenvectorJump (LALInferenceThreadState *thread, LALInferenceVariables *currentParams, LALInferenceVariables *proposedParams)
	Choose a random covariance matrix eigenvector to jump along. More...
REAL8	LALInferenceSkyLocWanderJump (LALInferenceThreadState *thread, LALInferenceVariables *currentParams, LALInferenceVariables *proposedParams)
	Jump around by 0.01 radians in angle on the sky. More...
REAL8	LALInferenceDifferentialEvolutionFull (LALInferenceThreadState *thread, LALInferenceVariables *currentParams, LALInferenceVariables *proposedParams)
	Differential evolution, on all non-fixed, non-output parameters. More...
REAL8	LALInferenceDifferentialEvolutionNames (LALInferenceThreadState *thread, LALInferenceVariables *currentParams, LALInferenceVariables *proposedParams, const char *names[])
	Perform differential evolution on the parameters of the given names (the names array should be terminated by a NULL pointer). More...
REAL8	LALInferenceDifferentialEvolutionIntrinsic (LALInferenceThreadState *thread, LALInferenceVariables *currentParams, LALInferenceVariables *proposedParams)
	Perform differential evolution on only the intrinsic parameters. More...
REAL8	LALInferenceDifferentialEvolutionExtrinsic (LALInferenceThreadState *thread, LALInferenceVariables *currentParams, LALInferenceVariables *proposedParams)
	Perform a differential evolution step on only the extrinsic parameters. More...
REAL8	LALInferenceDrawApproxPrior (LALInferenceThreadState *thread, LALInferenceVariables *currentParams, LALInferenceVariables *proposedParams)
	Draws from an approximation to the true prior. More...
REAL8	LALInferenceDrawFlatPrior (LALInferenceThreadState *thread, LALInferenceVariables *currentParams, LALInferenceVariables *proposedParams)
	Draws from a flat prior for all variables where are flat prior is specified. More...
REAL8	LALInferenceSkyReflectDetPlane (LALInferenceThreadState *thread, LALInferenceVariables *currentParams, LALInferenceVariables *proposedParams)
	Reflects the sky location through the plane formed by three detectors. More...
REAL8	LALInferenceSkyRingProposal (LALInferenceThreadState *thread, LALInferenceVariables *currentParams, LALInferenceVariables *proposedParams)
REAL8	LALInferenceGlitchMorletProposal (LALInferenceThreadState *thread, LALInferenceVariables *currentParams, LALInferenceVariables *proposedParams)
REAL8	LALInferenceGlitchMorletReverseJump (LALInferenceThreadState *thread, LALInferenceVariables *currentParams, LALInferenceVariables *proposedParams)
REAL8	LALInferencePSDFitJump (LALInferenceThreadState *thread, LALInferenceVariables *currentParams, LALInferenceVariables *proposedParams)
REAL8	LALInferenceExtrinsicParamProposal (LALInferenceThreadState *thread, LALInferenceVariables *currentParams, LALInferenceVariables *proposedParams)
	Proposal for the extrinsic parameters. More...
REAL8	LALInferenceFrequencyBinJump (LALInferenceThreadState *thread, LALInferenceVariables *currentParams, LALInferenceVariables *proposedParams)
	Proposal to jump in frequency by one frequency bin. More...
REAL8	LALInferenceDistanceLikelihoodProposal (LALInferenceThreadState *thread, LALInferenceVariables *currentParams, LALInferenceVariables *proposedParams)
	Proposal which draws a sample from the distance likelihood function Requires the currentParams to have optimal_snr and matched_filter_snr. More...
void	LALInferenceZeroProposalStats (LALInferenceProposalCycle *cycle)
void	LALInferenceTrackProposalAcceptance (LALInferenceThreadState *thread)
	Function for updating proposal acceptance rates if tracking. More...
void	LALInferenceUpdateAdaptiveJumps (LALInferenceThreadState *thread, REAL8 targetAcceptance)
	Helper function to update the adaptive steps after each jump. More...
void	LALInferenceSetupClusteredKDEProposalsFromASCII (LALInferenceThreadState *thread, FILE *input, INT4 burnin, REAL8 weight, INT4 ptmcmc)
	Setup all clustered-KDE proposals with samples read from file. More...
void	LALInferenceAddClusteredKDEProposalToSet (LALInferenceVariables *propArgs, LALInferenceClusteredKDE *kde)
	Add a KDE proposal to the KDE proposal set. More...
void	LALInferenceDestroyClusteredKDEProposal (LALInferenceClusteredKDE *proposal)
	Destroy an existing clustered-KDE proposal. More...
void	LALInferenceSetupClusteredKDEProposalFromDEBuffer (LALInferenceThreadState *thread)
	Setup a clustered-KDE proposal from the differential evolution buffer. More...
void	LALInferenceSetupClusteredKDEProposalFromRun (LALInferenceThreadState *thread, REAL8 *samples, INT4 size, INT4 cyclic_reflective, INT4 ntrials)
	Setup a clustered-KDE proposal from the parameters in a run. More...
REAL8	LALInferenceClusteredKDEProposal (LALInferenceThreadState *thread, LALInferenceVariables *currentParams, LALInferenceVariables *proposedParams)
	A proposal based on the clustered kernal density estimate of a set of samples. More...
REAL8	LALInferenceStoredClusteredKDEProposal (LALInferenceThreadState *thread, LALInferenceVariables *currentParams, LALInferenceVariables *proposedParams, REAL8 *propDensity)
	An interface to the KDE proposal that avoids a KDE evaluation if possible. More...
void	LALInferenceInitClusteredKDEProposal (LALInferenceThreadState *thread, LALInferenceClusteredKDE *kde, REAL8 *array, INT4 nSamps, LALInferenceVariables *params, const char *name, REAL8 weight, LALInferenceKmeans *(*cluster_method)(gsl_matrix *, INT4, gsl_rng *), INT4 cyclic_reflective, INT4 ntrials)
	Initialize a clustered-KDE proposal. More...
void	LALInferenceDumpClusteredKDE (LALInferenceClusteredKDE *kde, char *outp_name, REAL8 *array)
	Dump draws from a KDE to file. More...
void	LALInferenceDumpClusteredKDEDraws (LALInferenceClusteredKDE *kde, char *outp_name, INT4 nSamps)
	Dump clustered KDE information to file. More...
void	LALInferenceComputeMaxAutoCorrLenFromDE (LALInferenceThreadState *thread, INT4 *maxACL)
	A wrapper for the KDE proposal that doesn't store KDE evaluations. More...
REAL8	LALInferenceComputeMaxAutoCorrLen (REAL8 *array, INT4 nPoints, INT4 nPar)
	Compute the maximum single-parameter autocorrelation length. More...
void	LALInferenceUpdateMaxAutoCorrLen (LALInferenceThreadState *thread)
	Update the estimatate of the autocorrelation length. More...
INT4	LALInferenceComputeEffectiveSampleSize (LALInferenceThreadState *thread)
	Determine the effective sample size based on the DE buffer. More...
void	LALInferenceSetupAdaptiveProposals (LALInferenceVariables *propArgs, LALInferenceVariables *params)
	Helper function to setup the adaptive step proposals before the run. More...
void	LALInferenceSetupGlitchProposal (LALInferenceIFOData *data, LALInferenceVariables *propArgs)
	Setup glitch-related stuff. More...
int	LALInferencePrintProposalTrackingHeader (FILE *fp, LALInferenceVariables *params)
	Output proposal tracking header to file *fp. More...
void	LALInferencePrintProposalTracking (FILE *fp, LALInferenceProposalCycle *cycle, LALInferenceVariables *theta, LALInferenceVariables *theta_prime, REAL8 logPropRatio, INT4 accepted)
	Output proposal tracking information to file *fp. More...
REAL8	LALInferenceEnsembleStretchFull (LALInferenceThreadState *thread, LALInferenceVariables *cp, LALInferenceVariables *proposedParams)
	Ensemble stretch moves - see http://dx.doi.org/10.2140/camcos.2010.5.65. More...
REAL8	LALInferenceEnsembleStretchIntrinsic (LALInferenceThreadState *thread, LALInferenceVariables *cp, LALInferenceVariables *pp)
REAL8	LALInferenceEnsembleStretchExtrinsic (LALInferenceThreadState *thread, LALInferenceVariables *cp, LALInferenceVariables *pp)
REAL8	LALInferenceEnsembleStretchNames (LALInferenceThreadState *thread, LALInferenceVariables *cpi, LALInferenceVariables *ppi, const char **names)
REAL8	LALInferenceEnsembleWalkFull (LALInferenceThreadState *thread, LALInferenceVariables *cp, LALInferenceVariables *proposedParams)
REAL8	LALInferenceEnsembleWalkIntrinsic (LALInferenceThreadState *thread, LALInferenceVariables *cp, LALInferenceVariables *pp)
REAL8	LALInferenceEnsembleWalkExtrinsic (LALInferenceThreadState *thread, LALInferenceVariables *cp, LALInferenceVariables *pp)
REAL8	LALInferenceEnsembleWalkNames (LALInferenceThreadState *thread, LALInferenceVariables *cpi, LALInferenceVariables *ppi, const char **names)
REAL8	LALInferenceSplineCalibrationProposal (LALInferenceThreadState *thread, LALInferenceVariables *cp, LALInferenceVariables *pp)
	Proposes jumps in the spline calibration parameters, if present. More...

Go to the source code of this file.

Data Structures
struct	LALInferenceClusteredKDE
	Struct to hold clustered-KDE estimates. More...

Macros
#define	MAX_STRLEN   512
#define	ADAPTSUFFIX   "adapt_sigma"
#define	ACCEPTSUFFIX   "accepted"
#define	PROPOSEDSUFFIX   "proposed"

Variables
const char *const	cycleArrayName
const char *const	cycleArrayLengthName
const char *const	cycleArrayCounterName
const char *const	nullProposalName
const char *const	singleAdaptProposalName
const char *const	singleProposalName
const char *const	orbitalPhaseJumpName
const char *const	covarianceEigenvectorJumpName
const char *const	skyLocWanderJumpName
const char *const	differentialEvolutionFullName
const char *const	differentialEvolutionIntrinsicName
const char *const	differentialEvolutionExtrinsicName
const char *const	ensembleStretchFullName
const char *const	ensembleStretchIntrinsicName
const char *const	ensembleStretchExtrinsicName
const char *const	drawApproxPriorName
const char *const	drawFlatPriorName
const char *const	skyReflectDetPlaneName
const char *const	skyRingProposalName
const char *const	PSDFitJumpName
const char *const	polarizationPhaseJumpName
const char *const	polarizationCorrPhaseJumpName
const char *const	extrinsicParamProposalName
const char *const	frequencyBinJumpName
const char *const	GlitchMorletJumpName
const char *const	GlitchMorletReverseJumpName
const char *const	ensembleWalkFullName
const char *const	ensembleWalkIntrinsicName
const char *const	ensembleWalkExtrinsicName
const char *const	clusteredKDEProposalName