HMI_Logo HMI Ring Diagrams
Pipeline Module Specifications

gentargs

Module Version
	1.3	21 IX 2015

General Description
	gentargs generates the lists of target latitude and longitude centers
	and/or tracking ranges for a selected time for the synoptic pipeline.
	Various options generate lists needed for other pipelines, in particular
	the MDI "dense-pack" and "structure-pack" grids. The module output is in
	the form of lines of text sent to stdout, and expected to be parsed
	by a pipeline script.

Status
	Included in JSOC release 8.12
	In use for ring-diagram and time-distance pipelines from about 2015.09.21
	This version supersedes Version 1.2

	The source code and Makefile are in the JSOC CVS repository

	Note that as this program is not a true DRMS module, it can run in any
	environment.

Usage
	gentargs [-flags time= TargetTime grid= option]
	
Flags
	-B	center the timed* grid locations about the latitude of disc
		center at midpoint of tracking interval, rather than equator
	-M	use SOHO ephemeris for B0 calculation or conversion of time parameter
		in calendar-clock format to Carrington time
	-c	report Stonyhurst rather than Carrington longitudes, i.e. relative to
		central meridian. This only works for certain grids: rd+*, rdx*, and
		rdeq*
	-r	report distances and position angles relative to disc center for each
		location as third and fourth lines (only implemented for a few target grids)
	-v	run verbose

Parameters
	time	The target time for the grid-point calculation. The time
		can be specified in either calendar-clock (YYYY.MM.DD_hh:mm:ss)
		notation or in CR:CL (Carrington rotation plus central meridian
		of epoch) form; the latter is recommended. The time will be rounded
		to the nearest one appropriate for the grid spacings requested,
		2.5 deg for the HMI synoptic set, 15 deg for the MDI packs.
		Default: current time minus 120 deg of Carrington rotation.
	
	grid	Option for selection of the target list of values to be reported.
		Default: discross
		The following options are recognized (though not all are supported):

		discross — limits for disc crossings needed for the three ring diagrams
			synoptic sets
		rdsyn05 — ~2°.5 centers for the target analysis time
		rdsyn15 — ~7°.5 centers "
		rdsyn30 — ~15° centers "
		timed20 — 20° centers in a plate carrée grid "
		timed24 — 24° centers in a plate carrée grid "
		timed24+ — 24° centers in a plate carrée grid " plus
			four additional grids at extremal compass points
		mdidp — 7°.5 centers in a plate carrée grid "
		mdisp — 7°.5 centers in a plate carrée grid "
		rd+05 — central meridian and equatorial centers from rdsyn05 
		rd+15 — central meridian and equatorial centers from rdsyn15
		rd+30 — central meridian and equatorial centers from rdsyn30
		rdx05not supported
		rdx15not supported
		rdx30 — diagonal pattern of centers 45° rhumb lines through
			0° latitude and Stonyhurst longitude from rdsyn30
		rdcm05 — central meridian latitudes from rdsyn05
		rdcm15 — central meridian latitudes from rdsyn15
		rdcm30 — central meridian latitudes from rdsyn30
		rdeq05 — longitudes on equator from rdsyn05
		rdeq15 — longitudes on equator from rdsyn15
		rdeq30 — longitudes on equator from rdsyn30

	ar	A list of Active Region numbers (not implemented)

Notes:
	For the option rdsyn05 multiple pairs of lines are generated, each
	corresponding to the target latitudes and longitudes in a restricted
	range of latitudes. That is because it is not possible for mtrack to
	process more than 300 regions at a time. For this case, thirteen sets
	of targets are generated.

	For all options other than timed*, the longitudes of the target grid are
	rounded to the closest value appropriate for that grid.

	Because the normal output of the module is to stdout, extra information
	generated by selection of the verbose flag is directed to stderr.

Sample output:

=> gentargs -v grid= mdisp
finding time corresponding to 120 deg in past: 2096:344.6
 -45.0 -37.5 -30.0 -22.5 -15.0 -07.5 +00.0 +07.5 +15.0 +22.5 +30.0 +37.5 +45.0 -45.0 -37.5 -30.0 -22.5 -15.0 -07.5 +00.0 +07.5 +15.0 +22.5 +30.0 +37.5 +45.0 -45.0 -37.5 -30.0 -22.5 -15.0 -07.5 +00.0 +07.5 +15.0 +22.5 +30.0 +37.5 +45.0
 210.0 210.0 210.0 210.0 210.0 210.0 210.0 210.0 210.0 210.0 210.0 210.0 210.0 225.0 225.0 225.0 225.0 225.0 225.0 225.0 225.0 225.0 225.0 225.0 225.0 225.0 240.0 240.0 240.0 240.0 240.0 240.0 240.0 240.0 240.0 240.0 240.0 240.0 240.0

=> gentargs grid= timed20
 -40.0 -40.0 -40.0 -40.0 -40.0 -20.0 -20.0 -20.0 -20.0 -20.0 +00.0 +00.0 +00.0 +00.0 +00.0 +20.0 +20.0 +20.0 +20.0 +20.0 +40.0 +40.0 +40.0 +40.0 +40.0
 184.6 204.6 224.6 244.6 264.6 184.6 204.6 224.6 244.6 264.6 184.6 204.6 224.6 244.6 264.6 184.6 204.6 224.6 244.6 264.6 184.6 204.6 224.6 244.6 264.6

=> gentargs grid= timed20 time= 2010.05.02_16:00
 -40.0 -40.0 -40.0 -40.0 -40.0 -20.0 -20.0 -20.0 -20.0 -20.0 +00.0 +00.0 +00.0 +00.0 +00.0 +20.0 +20.0 +20.0 +20.0 +20.0 +40.0 +40.0 +40.0 +40.0 +40.0
 189.2 209.2 229.2 249.2 269.2 189.2 209.2 229.2 249.2 269.2 189.2 209.2 229.2 249.2 269.2 189.2 209.2 229.2 249.2 269.2 189.2 209.2 229.2 249.2 269.2

=> gentargs grid= rdsyn30
 -60.0 -60.0 -60.0 -60.0 -60.0 -45.0 -45.0 -45.0 -45.0 -45.0 -45.0 -45.0 -45.0 -45.0 -30.0 -30.0 -30.0 -30.0 -30.0 -30.0 -30.0 -30.0 -30.0 -15.0 -15.0 -15.0 -15.0 -15.0 -15.0 -15.0 -15.0 -15.0 +00.0 +00.0 +00.0 +00.0 +00.0 +00.0 +00.0 +00.0 +00.0 +15.0 +15.0 +15.0 +15.0 +15.0 +15.0 +15.0 +15.0 +15.0 +30.0 +30.0 +30.0 +30.0 +30.0 +30.0 +30.0 +30.0 +30.0 +45.0 +45.0 +45.0 +45.0 +45.0 +45.0 +45.0 +60.0 +60.0 +60.0
 150.0 180.0 210.0 240.0 270.0 150.0 165.0 180.0 195.0 210.0 225.0 240.0 255.0 270.0 150.0 165.0 180.0 195.0 210.0 225.0 240.0 255.0 270.0 150.0 165.0 180.0 195.0 210.0 225.0 240.0 255.0 270.0 150.0 165.0 180.0 195.0 210.0 225.0 240.0 255.0 270.0 150.0 165.0 180.0 195.0 210.0 225.0 240.0 255.0 270.0 150.0 165.0 180.0 195.0 210.0 225.0 240.0 255.0 270.0 165.0 180.0 195.0 210.0 225.0 240.0 255.0 180.0 210.0 240.0

=> gentargs grid= rdsyn15
 -75.0 -67.5 -67.5 -67.5 -67.5 -67.5 -67.5 -67.5 -60.0 -60.0 -60.0 -60.0 -60.0 -60.0 -60.0 -60.0 -60.0 -60.0 -60.0 -52.5 -52.5 -52.5 -52.5 -52.5 -52.5 -52.5 -52.5 -52.5 -52.5 -52.5 -52.5 -52.5 -45.0 -45.0 -45.0 -45.0 -45.0 -45.0 -45.0 -45.0 -45.0 -45.0 -45.0 -45.0 -45.0 -45.0 -45.0 -37.5 -37.5 -37.5 -37.5 -37.5 -37.5 -37.5 -37.5 -37.5 -37.5 -37.5 -37.5 -37.5 -37.5 -37.5 -30.0 -30.0 -30.0 -30.0 -30.0 -30.0 -30.0 -30.0 -30.0 -30.0 -30.0 -30.0 -30.0 -30.0 -30.0 -30.0 -30.0 -30.0 -30.0 -30.0 -30.0 -22.5 -22.5 -22.5 -22.5 -22.5 -22.5 -22.5 -22.5 -22.5 -22.5 -22.5 -22.5 -22.5 -22.5 -22.5 -22.5 -22.5 -22.5 -22.5 -22.5 -22.5 -15.0 -15.0 -15.0 -15.0 -15.0 -15.0 -15.0 -15.0 -15.0 -15.0 -15.0 -15.0 -15.0 -15.0 -15.0 -15.0 -15.0 -15.0 -15.0 -15.0 -15.0 -07.5 -07.5 -07.5 -07.5 -07.5 -07.5 -07.5 -07.5 -07.5 -07.5 -07.5 -07.5 -07.5 -07.5 -07.5 -07.5 -07.5 -07.5 -07.5 +00.0 +00.0 +00.0 +00.0 +00.0 +00.0 +00.0 +00.0 +00.0 +00.0 +00.0 +00.0 +00.0 +00.0 +00.0 +00.0 +00.0 +00.0 +00.0 +07.5 +07.5 +07.5 +07.5 +07.5 +07.5 +07.5 +07.5 +07.5 +07.5 +07.5 +07.5 +07.5 +07.5 +07.5 +07.5 +07.5 +07.5 +07.5 +15.0 +15.0 +15.0 +15.0 +15.0 +15.0 +15.0 +15.0 +15.0 +15.0 +15.0 +15.0 +15.0 +15.0 +15.0 +15.0 +15.0 +15.0 +15.0 +22.5 +22.5 +22.5 +22.5 +22.5 +22.5 +22.5 +22.5 +22.5 +22.5 +22.5 +22.5 +22.5 +22.5 +22.5 +22.5 +22.5 +22.5 +22.5 +30.0 +30.0 +30.0 +30.0 +30.0 +30.0 +30.0 +30.0 +30.0 +30.0 +30.0 +30.0 +30.0 +30.0 +30.0 +30.0 +30.0 +30.0 +30.0 +37.5 +37.5 +37.5 +37.5 +37.5 +37.5 +37.5 +37.5 +37.5 +37.5 +37.5 +37.5 +37.5 +45.0 +45.0 +45.0 +45.0 +45.0 +45.0 +45.0 +45.0 +45.0 +45.0 +45.0 +45.0 +45.0 +52.5 +52.5 +52.5 +52.5 +52.5 +52.5 +52.5 +52.5 +52.5 +60.0 +60.0 +60.0 +60.0 +60.0 +60.0 +60.0 +67.5 +67.5 +67.5
 015.0 315.0 335.0 355.0 015.0 035.0 055.0 075.0 300.0 315.0 330.0 345.0 000.0 015.0 030.0 045.0 060.0 075.0 090.0 300.0 312.5 325.0 337.5 350.0 002.5 015.0 027.5 040.0 052.5 065.0 077.5 090.0 305.0 315.0 325.0 335.0 345.0 355.0 005.0 015.0 025.0 035.0 045.0 055.0 065.0 075.0 085.0 305.0 315.0 325.0 335.0 345.0 355.0 005.0 015.0 025.0 035.0 045.0 055.0 065.0 075.0 085.0 300.0 307.5 315.0 322.5 330.0 337.5 345.0 352.5 000.0 007.5 015.0 022.5 030.0 037.5 045.0 052.5 060.0 067.5 075.0 082.5 090.0 300.0 307.5 315.0 322.5 330.0 337.5 345.0 352.5 000.0 007.5 015.0 022.5 030.0 037.5 045.0 052.5 060.0 067.5 075.0 082.5 090.0 300.0 307.5 315.0 322.5 330.0 337.5 345.0 352.5 000.0 007.5 015.0 022.5 030.0 037.5 045.0 052.5 060.0 067.5 075.0 082.5 090.0 307.5 315.0 322.5 330.0 337.5 345.0 352.5 000.0 007.5 015.0 022.5 030.0 037.5 045.0 052.5 060.0 067.5 075.0 082.5 307.5 315.0 322.5 330.0 337.5 345.0 352.5 000.0 007.5 015.0 022.5 030.0 037.5 045.0 052.5 060.0 067.5 075.0 082.5 307.5 315.0 322.5 330.0 337.5 345.0 352.5 000.0 007.5 015.0 022.5 030.0 037.5 045.0 052.5 060.0 067.5 075.0 082.5 307.5 315.0 322.5 330.0 337.5 345.0 352.5 000.0 007.5 015.0 022.5 030.0 037.5 045.0 052.5 060.0 067.5 075.0 082.5 307.5 315.0 322.5 330.0 337.5 345.0 352.5 000.0 007.5 015.0 022.5 030.0 037.5 045.0 052.5 060.0 067.5 075.0 082.5 307.5 315.0 322.5 330.0 337.5 345.0 352.5 000.0 007.5 015.0 022.5 030.0 037.5 045.0 052.5 060.0 067.5 075.0 082.5 315.0 325.0 335.0 345.0 355.0 005.0 015.0 025.0 035.0 045.0 055.0 065.0 075.0 315.0 325.0 335.0 345.0 355.0 005.0 015.0 025.0 035.0 045.0 055.0 065.0 075.0 325.0 337.5 350.0 002.5 015.0 027.5 040.0 052.5 065.0 330.0 345.0 000.0 015.0 030.0 045.0 060.0 355.0 015.0 035.0

=> gentargs grid= rdeq30
 120.0 135.0 150.0 165.0 180.0 195.0 210.0 225.0 240.0

=> gentargs grid= rdcm15 time= 2100:360
 -67.5 -60.0 -52.5 -45.0 -37.5 -30.0 -22.5 -15.0 -07.5 +00.0 +07.5 +15.0 +22.5 +30.0 +37.5 +45.0 +52.5 +60.0 +67.5 +75.0

=> gentargs grid= rd+30
 -60.0 -45.0 -30.0 -15.0 +00.0 +00.0 +00.0 +00.0 +00.0 +00.0 +00.0 +00.0 +00.0 +15.0 +30.0 +45.0 +60.0
 170.0 170.0 170.0 170.0 110.0 125.0 140.0 155.0 170.0 185.0 200.0 215.0 230.0 170.0 170.0 170.0 170.0

=> gentargs -c grid= rdx30
 -60.0 -60.0 -45.0 -45.0 -30.0 -30.0 -15.0 -15.0 +00.0 +15.0 +15.0 +30.0 +30.0 +45.0 +45.0 +60.0 +60.0
 -60.0 +60.0 -45.0 +45.0 -30.0 +30.0 -15.0 +15.0 +00.0 +15.0 -15.0 +30.0 -30.0 +45.0 -45.0 +60.0 -60.0

=> gentargs time= 1988:180
30 222.50 137.50 1
30 230.00 130.00 1
30 235.00 125.00 1
30 240.00 120.00 1 -67.5
30 242.50 117.50 1
30 245.00 115.00 3
15 215.00 145.00 1 +60.0
15 225.00 135.00 1 -75.0
15 227.50 132.50 1 +52.5
15 235.00 125.00 1 +45.0
15 240.00 120.00 2 -67.5 +37.5
15 245.00 115.00 1 +30.0
15 247.50 112.50 2 -60.0 +22.5
15 250.00 110.00 3 -52.5 +07.5 +15.0
15 252.50 107.50 6 -45.0 -37.5 -30.0 -15.0 -07.5 +00.0
15 255.00 105.00 1 -22.5
5 190.00 170.00 1 +70.0
5 207.50 152.50 1 +67.5
5 217.50 142.50 1 +65.0
5 225.00 135.00 2 -82.5 +62.5
5 227.50 132.50 1 +60.0
5 232.50 127.50 1 +57.5
5 235.00 125.00 1 +55.0
5 237.50 122.50 2 -80.0 +52.5
5 240.00 120.00 1 +50.0
5 242.50 117.50 1 +47.5
5 245.00 115.00 3 -77.5 +42.5 +45.0
5 247.50 112.50 3 -75.0 +37.5 +40.0
5 250.00 110.00 4 -72.5 +30.0 +32.5 +35.0
5 252.50 107.50 5 -70.0 +20.0 +22.5 +25.0 +27.5
5 255.00 105.00 7 -67.5 -65.0 +07.5 +10.0 +12.5 +15.0 +17.5
5 257.50 102.50 12 -62.5 -60.0 -57.5 -15.0 -12.5 -10.0 -07.5 -05.0 -02.5 +00.0 +02.5 +05.0
5 260.00 100.00 16 -55.0 -52.5 -50.0 -47.5 -45.0 -42.5 -40.0 -37.5 -35.0 -32.5 -30.0 -27.5 -25.0 -22.5 -20.0 -17.5

Significant changes from Previous Version
	— Added option for providing polar coordinates relative to disc center

Bugs in current version
	Invocation of the -M flag to use SOHO ephemerides requires the presence of
	appropriate ephemeris tables at a fixed system disc location; if they are
	not present, the earth ephemeris will be used. However, the ephemeris
	information is only used for converting time parameter values in calendar-
	clock format to CR:CL format, and for calculation of B0. The value of B0
	only matters for the definition of the HMI synoptic pipeline set, not the
	dense-pack and structure-pack sets appropriate for MDI. As long as queries
	to the database for the input to mtrack are based on central meridian
	longitude rather than time, this should be of no concern.

	There may be problems parsing regular calendar-clock time strings; use of
	the CR:CL format for the time value is recommended.

	The 60° latitude list for the rdsyn 30-deg tileset with high B0 in the
	discross option appears to be incomplete.

	The -r option is only implemented for the rdsyn15, rdsyn30, rd+15, rd+30,
	and rdx30 grid options. Its use with any other grid option except discross
	will result in no output at all. It has no effect on the output with the
	discross grid option.

Valid HTML 4.01 Transitional HMI Ring Diagrams 25 Aug 2023, 17:05-0700