9.5 correl()

Description

Converts selected values from the correlation matrix of fitting variables into named program variables.

Input Program Variables

correl_min.

Keywords/Values

Keyword	Variable	Default	Description
1x			name of first fitting variable
2y			name of second fitting variable
out		(see notes)	scalar name for result
min	correl_min	0.05	minimum correlation to report
print		F	flag to print correlation values
save		T	flag to save correlation values to scalars
no_save		F	flag to NOT save correlation values to scalars

Output Program Variables

None.

Notes

If the out argument is not given and if the save option is used, the output scalar containing the correlation will be named correl_xx_yy for variables xx and yy.

The value @all can be used for either or both of x and y to tell the command to extract all the correlations for that variables.

If the correlation value requested is smaller than the minimum reportable correlation, then nothing is printed or saved.

Examples

 
  Iff> correl(x=e0,y=delr_1,print,no_save)
     correl_e0_delr1 =  0.870124

  Iff> correl(x=e0,y=delr_1,save,min=0.2)
  Iff> print correl_e0_delr_1
     correl_e0_delr1 = 0.870124

  Iff> correl(x=e0,y=@all,print,min=0.6)
     correl_e0_delr1  = 0.870124

See also

feffit()(Section 9.11), minimize()(Section 9.23).