HMI_Logo HMI Ring Diagrams
Pipeline Module Specifications

pspec3

Module Version
	0.8	18 I 2010

General Description
	pspec3 is designed to calculate the full 3-dimensional power spectra of
	a set of time series of 2-dimensional images. The input data are optionally
	apodized by a (1-x^2)^2 taper operating between specified inner and
	outer radii of the images and a similar taper operating on the time axis
	(image number). The input data series must consist of 3-dimensional
	data cubes (such as those produced by mtrack), each treated as a
	separate data record. 

Status
	This version has been superseded by Version 0.9

	Included in JSOC release 5.7
	Never used for ring-diagram pipelines
	This version supersedes Version 0.7

	The source code and Makefile are in the JSOC CVS repository

Usage
	pspec3_v08 [-lvx] in= InputDescriptor pspec= OutputDescriptor
	    [param= val ...]
	
Flags
	-l	output direct power spectrum rather than scaled log
	-n	do not save output record (diagnostics only)
	-v	run verbose
	-x	use double-precision calculation internally

Parameters
	in		The name of an input dataset (record selection); No default

	pspec		The name of the output data series, which must already
			exist; record specification is based on the input data record(s)
			and the series prime keywords. No default.

	mask_in		Inner radial edge of spatial taper; Default: 0.9375

	mask_ex		Outer radial edge of spatial taper; Default: 1.0

	apodize		Inner edge of temporal taper; Default: 0.96875

	fbin		Output frequency binning; 0 -> no binning; Default: 0

Input Data series class:
	tracked mapped data cubes from solar image data

Input keys used or inspected:
	MapScale, T_STOP, T_START, CDELT3

Sample input series:
	mdi.rdVtrack_dp

Output Data series class:
	power spectra of data cubes

Output keys set (if possible):
	CRPIX1, CRPIX2, CRPIX3, CRVAL1, CRVAL2, CRVAL3, CTYPE1, CTYPE2, CTYPE3,
	CDELT1, CDELT2, Delta_k, Delta_kx, Delta_ky, CDELT3, Delta_nu, D_OMEGA,
	apode_k_min, apode_k_max, apode_f, LOG_BASE, DataMin, DataMax, Module,
	Source, Input

Input keys propagated to output (if possible):
	CarrTime, CarrRot, CMLon, LonHG, LatHG, LonCM, MidTime, Duration, LonSpan,
	T_START, T_STOP, Coverage, Cadence, ZonalTrk, ZonalVel, MeridTrk, MeridVel,
	MapScale, Size, MapProj, Map_PA, PosAng, RSunRef, MAI

Sample output series:
	mdi.rdVpspec_dp

Changes from Previous Version
	Added looping over multiple input and output records

 	Fixed bug in setting of CDELT3 and associated keywords
	
	Removed CGI output and special processing for exports
	
	Added setting of Cadence keywords from input CDELT3

	Put in (approximately) correct normalization; generalized scaling of logs
	(and direct values) for output precision

	Added no_save option for diagnostics

Bugs in current version
	Requires that the input data segment be named V

	There is no checking that the input data series corresponds with a link
	in the output series (if present)

	The value of CDELT3 in the input set overrides the value of Cadence if
	propagated, but is not checked for units

Valid HTML 4.01 Transitional HMI Ring Diagrams 7 Mar 2018, 12:35-0800