script – CREST

Uses

- analyses
- crest_param
- gnufor
- pikaia_oop
- sort_arrays
- func_acf
- files
- data_arch
- skku_profiles
- filter
- surfile
- anisotropy
- stat_mom
- fftw3
- miscellaneous
Help

Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.
Where possible, edges connecting nodes are given different colours to make them easier to distinguish in large graphs.

Used by

Help

Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.
Where possible, edges connecting nodes are given different colours to make them easier to distinguish in large graphs.

Subroutines

private subroutine acf_theo()

Function that returns the theoretical acf PARAM%imp_acf.

Arguments

None

private subroutine add_nois()

Function that returns the starting surface of random heights

Arguments

None

private subroutine alloc_tabs()

Function that allocates arrays in global variable PARAM

Arguments

None

private subroutine apod_acf()

Function that apodize the acf to prevent spectral leakage

Arguments

None

private subroutine apod_sur()

Function that apodize the reference surface for acf calculus purposes

Arguments

None

private subroutine calc_acf()

Function that returns the autocorrelation function of a surface in PARAM%acf_surf

Arguments

None

private subroutine calc_ffh()

Function that returns …

Arguments

None

private subroutine calc_ord()

Function that returns the vector PARAM%order that contains the heights order.

Arguments

None

private subroutine calc_res_acf(acf_surf, imp_acf, crit_acf, acf__z, w, h)

Function that returns crit_acf the mean absolute difference between theoretical and calculated acfs, above z (usually 0.2 as recommended by iso 25178)

Arguments

Type	Intent	Attributes		Name
real(kind=R8),	intent(in),	dimension(1:w, 1:h)	::	acf_surf	calculated surface acf
real(kind=R8),	intent(in),	dimension(1:w, 1:h)	::	imp_acf	required surface acf
real(kind=R8),	intent(out)		::	crit_acf	mean absolute difference between theoretical and calculated acfs
real(kind=R8),	intent(in)		::	acf__z	plane elevation z where correlation lengths are calculated
integer(kind=I4),	intent(in)		::	w	surface acf width (points)
integer(kind=I4),	intent(in)		::	h	surface acf height (points)

private subroutine calc_z_f()

Function that returns PARAM%surf, the surface made of heights with the required statistical moments, in the right order.

Arguments

None

private subroutine calc_z_i()

Function that returns the starting surface of random heights

Arguments

None

private subroutine def_size()

Geometrical characteristics of the numerical surface

Arguments

None

private subroutine digi_fil()

Function that applies the digital filter to the random heights

Arguments

None

private subroutine end_loop()

The loop ends here

Arguments

None

private subroutine end_scri()

End of script

Arguments

None

private subroutine make_msk()

Function that reads a digital surf file and turns it into a mask

Arguments

None

private subroutine make_scratches()

This subroutine initializes a real matrix tab of dimensions nx by ny with ones

Arguments

None

private subroutine make_tex()

Function that creates a periodic macro-texture: knowing the FFT of an analytical texture

Arguments

None

private subroutine nb_procs()

Number of concurrent threads

Arguments

None

private subroutine plt__acf()

Function that calculates the mean absolute difference between the desired Acf and the one obtained. However, the important zone where both should match is above the cut - where the correlation lengths are determined.

Arguments

None

private subroutine read_img()

Function that reads a digital surf file and returns the surface in PARAM%surf

Arguments

None

public subroutine read_job(job_file)

Function that reads a script file. Keywords are identified and corresponding actions are triggered.

Arguments

Type	Intent	Optional	Attributes		Name
character(len=512),	intent(in)			::	job_file	job file with macros to execute

private subroutine repr_img()

Function that set parameters for image reproduction

Arguments

None

private subroutine save_img(tab)

Function that save an array tab as a digital surf file.

Arguments

Type	Intent	Optional	Attributes		Name
real(kind=R8),	intent(in),		dimension(:,:)	::	tab	a surface to save as a .sur file

private subroutine smooth__()

Function that applies a low-pass filter to the surface PARAM%surf

Arguments

None

private subroutine spct_sur(file_spct, apod)

Returns the default surface spectrum

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in),	optional		::	file_spct	txt file containing the surface FFT module
logical(kind=I4),	intent(in),	optional		::	apod	window applied to surface?

private subroutine sta_loop()

Starting the loop

Arguments

None

private subroutine sta_scri()

Start the script reading

Arguments

None

private subroutine sta_theo()

Required statistical moments

Arguments

None

private subroutine stat_sur()

Define surface statistical moments as reference

Arguments

None

private subroutine sub_surf()

Function that returns the best subsurface from the final surface.

Arguments

None

script Module

Contents

Subroutines

Uses

Used by

Subroutines

private subroutine acf_theo()

Arguments

private subroutine add_nois()

Arguments

private subroutine alloc_tabs()

Arguments

private subroutine apod_acf()

Arguments

private subroutine apod_sur()

Arguments

private subroutine calc_acf()

Arguments

private subroutine calc_ffh()

Arguments

private subroutine calc_ord()

Arguments

private subroutine calc_res_acf(acf_surf, imp_acf, crit_acf, acf__z, w, h)

Arguments

private subroutine calc_z_f()

Arguments

private subroutine calc_z_i()

Arguments

private subroutine def_size()

Arguments

private subroutine digi_fil()

Arguments

private subroutine end_loop()

Arguments

private subroutine end_scri()

Arguments

private subroutine make_msk()

Arguments

private subroutine make_scratches()

Arguments

private subroutine make_tex()

Arguments

private subroutine nb_procs()

Arguments

private subroutine plt__acf()

Arguments

private subroutine read_img()

Arguments

public subroutine read_job(job_file)

Arguments

private subroutine repr_img()

Arguments

private subroutine save_img(tab)

Arguments

private subroutine smooth__()

Arguments

private subroutine spct_sur(file_spct, apod)

Arguments

private subroutine sta_loop()

Arguments

private subroutine sta_scri()

Arguments

private subroutine sta_theo()

Arguments

private subroutine stat_sur()

Arguments

private subroutine sub_surf()

Arguments