HMI_Logo HMI Ring Diagrams
Pipeline Module Specifications

pspec3

Module Version
	0.9	18 V 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 1.0

	Never used for ring-diagram pipelines
	Not included in any JSOC release
	The source code and Makefile is in ~rick/src/pspec
	This version supersedes Version 0.8


Usage
	pspec3 [-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

	segment		The name of the segment in the input data set to be used;
			ignored if there is only one 3-dimensional segment in the
			data set. Default: not specified

	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,
	Cadence, Apode_k_min, APOD_MIN, Apode_k_max, APOD_MAX, apode_f, LOG_BASE,
	DataMin, DataMax, Module, BLD_VERS, Source, Input, Created

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

Sample output series:
	mdi.rdVpspec_dp

Significant changes from Previous Version
	Added setting of several keys and modified default keyword propagation
	list

	Added optional segment argument, removing restriction on the name

Bugs in current version
	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 26 Mar 2018, 18:08-0700