HMI_Logo HMI Ring Diagrams
Pipeline Module Specifications


Module Version
	0.93	31 I 2019

General Description
	rdvinv performs an OLA inversion on a set of ring-fit parameters Ux and Uy
	for transverse velocity functions of depth.

	If output is to a named DRMS series, the module combines the output files
	corresponding to the input records selected into a single SUMS directory
	or a pair of directories, depending whether the output data series has
	one or two segments defined. If the output series has a single segment,
	all output files will be placed in its SUMS directory; otherwise, separate
	subdirectories for the uxseg and uyseg parameters will be created.
	In either case, the ouput inversion files will be named with extensions
	.Ux and .Uy. The filenames are constructed from the Carrington time,
	latitude and (Stonyhurst) longitude information for the records, e.g.

	If values are provided for any combination of parameters cr, clon, lon, and
	lat, the module will select all records from the input record set or series
	matching the selected values.


	Included in JSOC release 9.3
	In use for ring-diagram pipelines from 2019.01.31 – (CR 2213–)

	The source code and Makefile are in the JSOC CVS repository
	This version supersedes Version 0.92

	rdvinv [-v] [param= val ...]
	-v	run verbose

	in		Name of an input data series or dataset (record selection);
			No Default
	seg		Name of the input segment; Default: fit.out
	out		Output data series name or directory; No Default:
	uxseg		Output data segment name for Ux inversions; Default: Ux
	uyseg		Output data segment name for Uy inversions; Default: Uy
	cr		Carrington rotation number common to all regions;
			Default: Not Specified
	clon		Central meridian longitude common to all regions;
			Default: Not Specified
	lon		Carrington longitude common to all regions;
			Default: Not Specified
	lat		Heliographic latitude common to all regions;
			Default: Not Specified
	amu		Error trade-off parameter; Default: 0.005
	ob		Lower frequency limit (mHz); Default: 1.0
	oe		Upper frequency limit (mHz); Default: 5.2
	rb		Lower radius limit; Default: 0.97
	re		Upper radius limit; Default: 1.00
	num		Number of target inversion points; Default: 40
	nmax		Maximum mode order to be used; Default: 14; but see note
			under Bugs
	lmax		Maximum mode degree to be used; Default: 2000
	kernel		DRMS record specification or filename for the kernel to be
			used; No Default
	ave		Output directory for averaging kernel files; if not specified,
			kernels are not written. Default: Not Specified
	coef		Output directory for inversion coefficients files; if not
			specified, coefficients are not written. Default: Not Specified

Input Data series class:
	ring diagram mode fits

Sample input series:

Output Data series class:
	ring diagram flow inversions

Sample output series:

Changes from Previous Version
	Much internal reorganization, including elimination of Fortran functions,
	moving processing of kernel file to separate function only called once.

	Modified options for optional writing of averaging kernel and inversion
	coefficient files so that files corresponding to each output records are
	written into the named directories; changed meaning of the corresponding
	parameters kernel and ave; modified the format of the files.

	Slightly modified the format of the output files (just the header lines).

	Added parameters nmax and lmax.

	kernel parameter can be specified as a DRMS record as well as by a filename.

Bugs in current version:
	The mode weeding for abnormal values of Ui is only applied to modes of order
	n <= 8; all higher-order modes are rejected. The rejection criteria in the mode
	weeding algorithm are hard-coded. Because of this, specification of a value
	greater than 8 for parameter nmax is not permitted, the value will be reduced
	to 8, and a warning message issued. Note that this will always occur if the
	default value of 14 is used!

	If any of the parameters cr, clon, lon, and lat are specified, the input data
	must be in a DRMS series with the appropriate keywords CarrRot, CMLon, LonHG,
	and LatHG.

	It is not possible to restrict the DRMS input record set based on Stonyhurst
	longitude via a calling parameter, only via the recordset descriptor.

	When writing output to a DRMS series, there is no verification that the
	requested output segments have the correct protocol (generic); but it probably
	doesn't matter in any case.

Valid HTML 4.01 Transitional HMI Ring Diagrams 3 May 2019, 10:37-0700