prior_gaussian Module Reference

Defines the base class of the type prior_gaussian_class. This class implements priors of the type. More...

Data Types
interface	prior_gaussian_class
	Base class representing a prior_guassian signal. More...

Functions/Subroutines
class(prior_gaussian_class) function, pointer	prior_gaussian_construct (a_model, param_name, indices)
	Construct a prior_gaussian_class object. More...
subroutine	prior_gaussian_destruct (this)
	Deconstruct a prior_gaussian_class object. More...
real(rprec) function, dimension(4)	prior_gaussian_get_modeled_signal (this, a_model, sigma, last_value)
	Calculates the modeled signal. More...
character(len=data_name_length) function	prior_gaussian_get_type (this)
	Gets a discription of the prior type. More...
real(rprec) function	prior_gaussian_get_gp_i (this, a_model, i, flags)
	Gets the guassian process kernel for a prior signal and a position. More...
real(rprec) function	prior_gaussian_get_gp_s (this, a_model, signal, flags)
	Gets the guassian process kernel for a prior signal and a signal. More...
real(rprec) function	prior_gaussian_get_gp_x (this, a_model, x_cart, flags)
	Gets the guassian process kernel for a prior signal and a cartesian position. More...
subroutine	prior_gaussian_write_auxiliary (this, iou, index, a_model)
	Write out auxiliary signal information to an output file. More...

Detailed Description

Defines the base class of the type prior_gaussian_class. This class implements priors of the type.

P(B) = Exp(-((B - mu)/sigma)^2)

Super Class:

prior

Function/Subroutine Documentation

prior_gaussian_construct()

class (prior_gaussian_class) function, pointer prior_gaussian::prior_gaussian_construct	(	type (model_class), intent(in)	a_model,
		character (len=*), intent(in)	param_name,
		integer, dimension(2), intent(in)	indices
	)

Construct a prior_gaussian_class object.

Allocates memory and initializes a prior_gaussian_class object.

Parameters

[in]	a_model	An instance of a model object.
[in]	param_name	The name the parameter.
[in]	indices	Indicies of the parameter.

Returns

A pointer to a constructed prior_gaussian_class object.

Definition at line 81 of file prior_gaussian.f.

prior_gaussian_destruct()

subroutine prior_gaussian::prior_gaussian_destruct

(

type (prior_gaussian_class), intent(inout)

this

)

Deconstruct a prior_gaussian_class object.

Deallocates memory and uninitializes a prior_gaussian_class object.

Parameters

[in,out]

this

A prior_gaussian_class instance.

Definition at line 119 of file prior_gaussian.f.

prior_gaussian_get_gp_i()

real (rprec) function prior_gaussian::prior_gaussian_get_gp_i	(	class (prior_gaussian_class), intent(in)	this,
		type (model_class), pointer	a_model,
		integer, intent(in)	i,
		integer, intent(in)	flags
	)

Gets the guassian process kernel for a prior signal and a position.

Calculates the guassian process kernel between the signal and the position. Temperature kernels are provided by model::model_get_gp_te. Denisty kernels are provided by model::model_get_gp_ne. Soft X-ray Emission kernels are provided by model::model_get_gp_sxrem.

Parameters

[in]	this	A prior_gaussian_class instance.
[in]	a_model	A model instance.
[in]	i	Index of the position for the kernel.
[in]	flags	State flags to send to the kernel.

Returns

Kernel value for the position and the signal.

Definition at line 219 of file prior_gaussian.f.

prior_gaussian_get_gp_s()

real (rprec) function prior_gaussian::prior_gaussian_get_gp_s	(	class (prior_gaussian_class), intent(in)	this,
		type (model_class), pointer	a_model,
		class (signal_class), pointer	signal,
		integer, intent(in)	flags
	)

Gets the guassian process kernel for a prior signal and a signal.

Calculates the guassian process kernel between the signal and a signal. Calls back to the signal module to call the other signal. This does not support pressure measurements.

Parameters

[in]	this	A prior_gaussian_class instance.
[in]	a_model	A model_class instance.
[in]	signal	A signal_class instance for the second signal.
[in]	flags	State flags to send to the kernel.

Returns

Kernel value for the signal and the signal.

Definition at line 273 of file prior_gaussian.f.

prior_gaussian_get_gp_x()

real (rprec) function prior_gaussian::prior_gaussian_get_gp_x	(	class (prior_gaussian_class), intent(in)	this,
		type (model_class), pointer	a_model,
		real (rprec), dimension(3), intent(in)	x_cart,
		integer, intent(in)	flags
	)

Gets the guassian process kernel for a prior signal and a cartesian position.

Calculates the guassian process kernel between the signal and the position. Temperature kernels are provided by model::model_get_gp_te. Denisty kernels are provided by model::model_get_gp_ne. Soft X-ray Emission kernels are provided by model::model_get_gp_sxrem. This is the second signal.

Parameters

[in]	this	A prior_gaussian_class instance.
[in]	a_model	A model instance.
[in]	x_cart	The cartesian position of to get the kernel at.
[in]	flags	State flags to send to the kernel.

Returns

Kernel value for the signal and the signal.

Definition at line 325 of file prior_gaussian.f.

prior_gaussian_get_modeled_signal()

real (rprec) function, dimension(4) prior_gaussian::prior_gaussian_get_modeled_signal	(	class (prior_gaussian_class), intent(inout)	this,
		type (model_class), pointer	a_model,
		real (rprec), dimension(4), intent(out)	sigma,
		real (rprec), dimension(4), intent(in)	last_value
	)

Calculates the modeled signal.

The modeled signal is just the value of the parameter.

Parameters

[in]	this	A prior_gaussian_class instance.
[in]	a_model	A model instance.
[out]	sigma	The modeled sigma.
[in]	last_value	Last good value in case the signal did not change.

Returns

The model value.

Definition at line 147 of file prior_gaussian.f.

prior_gaussian_get_type()

character (len=data_name_length) function prior_gaussian::prior_gaussian_get_type

(

class (prior_gaussian_class), intent(in)

this

)

Gets a discription of the prior type.

Parameters

[in]

this

A prior_gaussian_class instance.

Returns

A string describing the prior type.

Definition at line 184 of file prior_gaussian.f.

prior_gaussian_write_auxiliary()

subroutine prior_gaussian::prior_gaussian_write_auxiliary	(	class (prior_gaussian_class), intent(in)	this,
		integer, intent(in)	iou,
		integer, intent(in)	index,
		type (model_class), intent(in)	a_model
	)

Write out auxiliary signal information to an output file.

Writes out the s_name and coefficient of the combined signals.

Parameters

[in]	this	A prior_gaussian_class instance.
[in]	iou	A input/output representing the file to write to.
[in]	index	A index of a signal.
[in]	a_model	The equilibrium model.

Definition at line 380 of file prior_gaussian.f.