HMI_Logo HMI Ring Diagrams
Pipeline Module Specifications


Module Version
	0.92	13 IV 2018

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.


	To be included in JSOC release 9.2
	In use for ring-diagram pipelines from 2018.05.02 – (CR 2203–)

	The source code and Makefile are to be in the JSOC CVS repository
	This version supersedes Version 0.91

	rdvinv_v092 is a compiled standalone DRMS binary built with NetDRMS 9.1
	to run in the JSOC configuration. Versions are in:
	The source code and Makefile is in ~rick/src/rdvinv

	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
	kernel		Kernel filename; No Default
	ave		Output filename for averaging kernels; if unspecified,
			kernels are not written. Default: Not Specified
	coef		Output filename for inversion coefficients;  if unspecified,
			coefficients are not written. Default: Not Specified

Input Data series class:
	ring diagram mode fits

Sample input series:

Output Data series class:
	ring diagram mode fits

Sample output series:

Changes from Previous Version
	Introduced version control for included C code (but not linked Fortran code)

	Removed unused code from ola_xy.c

	Makefile altered to use updated Fortran code ola_xy_v13.f; this code version
	fixes bugs involving failure to reinitialize between processing of multiple
	input fit records 

	Addded setting of Source key, optionally verbose reporting of source record
	(or file) name at each step

Bugs in current version:
	When writing output to a file, rather than a drms record set, only one
	set of files can be specified — if the input data set contains more
	than one record, each inversion will overwrite the last.

Valid HTML 4.01 Transitional HMI Ring Diagrams 3 May 2018, 11:15-0700