RLS Inversion [Inversion Functions]

Functions
InversionData *	RLSInit1d (InputParms inputParms, char *commandLineOutputDir, bool debug)
InversionData *	RLSInit3d (InputParms inputParms, char *commandLineOutputDir, bool debug)
void	RLSNextParameter1d (InversionData *inversionData)
void	RLSNextParameter3d (InversionData *inversionData)
bool	RLSMoreParameterSteps (InversionData *inversionData)
void	RLSInvert1d (InversionData *inversionData)
void	RLSComplete1d (InversionData *inversionData)
void	RLSInvert3d (InversionData *inversionData)
void	RLSComplete3d (InversionData *inversionData)
void	RLSDestroy1d (InversionData *inversionData)
void	RLSDestroy3d (InversionData *inversionData)
int	tdSetup1d (MATRIX aM, MATRIX ad, MATRIX aR, MATRIX aCI, MATRIX aC)
int	tdSetup3d (MATRIX aM, MATRIX ad, MATRIX aR, MATRIX aCI, MATRIX aC)
void	tdinvert1dFinish (Float lambda, int nStep, Model *model, bool debug, BaseDirectory *debugFilename)
void	tdinvert3dFinish (Float lambda, TempData *tempData, bool debug, BaseDirectory *debugFilename)
void	tdCleanup ()

---

Function Documentation

void RLSComplete1d

(

InversionData *

inversionData

)

Write solution matrices to FITS files for RLS 1D inversion

Parameters:

[in,out]

inversionData

pointer to solution data.

void RLSComplete3d

(

InversionData *

inversionData

)

Write solution matrices to FITS files for RLS 3D inversion.

Parameters:

[in,out]

inversionData

pointer to solution data.

void RLSDestroy1d

(

InversionData *

inversionData

)

Free memory for RLS 1D

Parameters:

[in,out]

inversionData

pointer to data

void RLSDestroy3d

(

InversionData *

inversionData

)

Free memory for RLS 3D

Parameters:

[in,out]

inversionData

pointer to data

InversionData* RLSInit1d	(	InputParms	inputParms,
		char *	commandLineOutputDir,
		bool	debug
	)

Initialize inversion structure with data from input files and command-line arguments.

Parameters:

[in]	inputParms	Pointer to input data files and inversion parameters.
[in]	commandLineOutputDir	Output directory specified on command line (optional).
[in]	debug	If running with debug option.

Returns:

InversionData structure with matrices filled with input data.

InversionData* RLSInit3d	(	InputParms	inputParms,
		char *	commandLineOutputDir,
		bool	debug
	)

Initialize inversion structure with data from input files and command-line arguments.

Parameters:

[in]	inputParms	Pointer to input data files and inversion parameters.
[in]	commandLineOutputDir	Output directory specified on command line (optional).
[in]	debug	If running with debug option.

Returns:

InversionData structure with matrices filled with input data.

void RLSInvert1d

(

InversionData *

inversionData

)

Perform inversion for RLS 1D problems.

Parameters:

[in,out]

inversionData

Pointer to structure containing input data and solution (output) data.

void RLSInvert3d

(

InversionData *

inversionData

)

Perform inversion for RLS 3D problems.

Parameters:

[in,out]

inversionData

Pointer to structure containing input data and solution (output) data.

bool RLSMoreParameterSteps

(

InversionData *

inversionData

)

void RLSNextParameter1d

(

InversionData *

inversionData

)

void RLSNextParameter3d

(

InversionData *

inversionData

)

void tdCleanup

(

)

free memory used by static variables internal to inversion

void tdinvert1dFinish	(	Float	lambda,
		int	nStep,
		Model *	model,
		bool	debug,
		BaseDirectory *	debugFilename
	)

Completes the inversion calculation. By sending the individual lambda values the inversion calculation is finished.

Parameters:

[in]	lambda	regularization parameter
[in]	nStep	Nth step in lambda-parameter range
[in]	debug	Flag to print intermediate matrices during inversion
[in]	debugFilename	Base directory and filename for intermediate, debug values.
[in,out]	model	Model structure contains all calculated solutions including averaging kernel and error covariance.

void tdinvert3dFinish	(	Float	lambda,
		TempData *	tempData,
		bool	debug,
		BaseDirectory *	debugFilename
	)

Completes the inversion calculation. By sending the individual lambda values the inversion calculation is finished.

Parameters:

[in]	lambda	regularization parameter
[in]	debug	Flag to print intermediate matrices during inversion
[in]	debugFilename	Base directory and filename for intermediate, debug values.
[in,out]	tempData	TempData structure contains all calculated solutions including averaging kernel and error covariance for one wave number.

int tdSetup1d	(	MATRIX	aM,
		MATRIX	ad,
		MATRIX	aR,
		MATRIX	aCI,
		MATRIX	aC
	)

tdSetup calculates all the non-changing, static matrices

Parameters:

[in]	aM	Kernel matrix
[in]	ad	map data
[in]	aR	Regularization matrix; symmetric positive-definite matrix
[in]	aCI	Inverse of matrix C, a noise covariance matrix
[in]	aC	matrix C, a noise covariance matrix

int tdSetup3d	(	MATRIX	aM,
		MATRIX	ad,
		MATRIX	aR,
		MATRIX	aCI,
		MATRIX	aC
	)