CNGI Requirements Traceability

	A	B	C	D	E	F	G	H	I	J	K	L
1	CASA NEXT GENERATION INFRASTRUCTURE (CNGI) FUNCTIONAL REQUIREMENTS								PRIORITY	SCHEDULED RELEASE
2	Req ID	Source	Section	Function	Requirement Text	Current Implementation	Future Implementation	Notes	Low to High	0.1	1.0	Other

3	M1	CASAdocs	Conversion	Visibilities Import Export	Support ASDM format data via conversion or direct access	importasdm, exportasdm	convert_asdm, save_asdm		Low		x
4	M2	CASAdocs	Conversion	Visibilities Import Export	Support FITS format MS data via conversion or direct access	importuvfits, exportuvfits	convert_ms, save_ms	Support FITS conversion with same functions as MS conversion	Low		x
5	M3	NEW	Conversion	Visibilities Import Export	Support legacy MS format data via conversion or direct access	N/A	convert_ms, save_ms	new xarray Dataset zarr format for MS data	High	x
6	N/A	CASAdocs	Conversion	Visibilities Import Export	Support legacy other formats via conversion or direct access	importfitsidi, importvla, importmiriad, importatca, importgmrt, importasap, importnro	N/A					x
7	M4	NEW	Data IO	Visibilities Import Export	Open Dataframe object from MS data on disk, write Dataframe object contents back to disk	N/A	read_vis, write_vis	DF is DDI based, so a single MS may have many DF's that need to be read/written individually	High	x
8	M5	CASAdocs	MS Examination	Visibility Data Selection	Allow selection of MS data by field, spw, timerange, uvrange, antenna, scan, and custom (user defined)			Standard across all MS functions	High	x
9	M6	CASAdocs	MS Examination	Data Examination	Summarize the contents of an SDM	listsdm			Low		x
10	M7	CASAdocs	MS Examination	Data Examination	Summarize the contents of an MS	listobs	dio.describe_vis	A method of scanning directory structure for DDI's is needed prior to opending an MS, after that built in functions are sufficient	High	x
11	M8	CASAdocs	MS Examination	Data Examination	list and change the metadata contents of a MS	vishead	direct on DF		High	x
12	N/A	CASAdocs	MS Examination	Data Examination	list the partition structure of a Multi-MS, statistics on data in a MS, plotting antenna locations, plotting uv-coverages, VLA weather statistics, calculation of opacities, examining an MS	listpartition, visstat, plotants, plotms, plotweather, browsetable	N/A					x
13	M9	CASAdocs	MS Examination	Manipulate Spectral Windows	combine, separate, and Hanning smooth spectral windows	mstransform, cvel2	vis.joinspw		High	x
14	M10	CASAdocs	MS Examination	Select / Reindex UV-data	Create a new MS with a specific data selection, for instance splitting a science target. The new MS contains only the selected data and also the subtables are re-generated to contain only the metadata matching the data selection	mstransform, split	direct on DF		High	x
15	N/A	CASAdocs	MS Manipulation	On-the-fly calibration	Create a corrected data column from specified cal library	mstransform	N/A					x
16	M11	CASAdocs	MS Examination	Time average	Weighted or baseline dependent time averaging of data	mstransform, split	vis.timeaverage		High	x
17	M12	CASAdocs	MS Examination	Channel average	Average data by frequency channel	mstransform, split	vis.chanaverage		High	x
18	M13	CASAdocs	MS Examination	Recalculate UVW Values	Select a subset of data from a MeasurementSet and create a new MS with only those selected data	fixvis	vis.recalculateUVW		Med		x
19	M14	CASAdocs	MS Examination	Hanning Smooth UV-data	Perform a running mean across the spectral axis with a triangle as a smoothing kernel	hanningsmooth	vis.chansmooth		Med		x
20	M15	CASAdocs	MS Examination	Regrid Frequency / Velocity	Transform channel labels and visibilities to a spectral reference frame appropriate for analysis, e.g. from TOPO to LSRK or to correct for Doppler shifts throughout the time of the observation.	cvel	vis.regridSPW		Med		x
21	N/A	CASAdocs	MS Manipulation	Combine MeasurementSets	Combine multiple MeasurementSets in to one	concat	N/A	DF is SPW/Pol based, multiple DF's can be written to same output file, this is functionaly equivalent to a concat				x
22	M16	CASAdocs	MS Examination	UV Continuum Subraction	Estimate continuum emission and subtract it from visibilities	uvcontsub, uvcontsub3, mstransform	vis.uvcontsub		High	x
23	M17	CASAdocs	MS Examination	Subtract/Add Model Visibilities	subtract or add the MODEL_DATA column to the CORRECTED_DATA column of a given MeasurementSet	uvsub	direct on DF		Med	x
24	M18	CASAdocs	MS Examination	Fit Gaussians to Visibilities	fit simple analytic source component models directly to visibility data	uvmodelfit	vis.uvmodelfit		Med		x
25	I1	CASAdocs	Conversion	Image Import/Export	Support FITS format image data via conversion or direct access	importfits, exportfits	convert_image, save_image		High	x
26	I2	NEW	Conversion	Image Import/Export	Support legacy Image format data via conversion or direct access	N/A	convert_image, save_image		High	x
27	I3	CASAdocs	Images	Image Import/Export	extract the values of the data and mask from a specified region of an image	imval	direct on DS		High	x
28	I4	NEW	Data IO	Image Import/Export	Open Image object from data on disk, write Image object contents back to disk	N/A	read_image, write_image
29	I5	CASAdocs	Images	Image Headers	View image header metadata	listfits, imhead	direct on DS
30	N/A	CASAdocs	Images	Image Headers	Store image operation history in metadata, view list of previous operations performed on image	imhistory	N/A	Not a standard practice
31	I6	CASAdocs	Images	Reformat Images	extract a smaller data cube from a bigger one	imsubimage	direct on DS
32	I7	CASAdocs	Images	Reformat Images	reorder the axes of an Image Cube	imtrans	direct on DS
33	I8	CASAdocs	Images	Reformat Images	regrid one image onto the coordinate system of another	imregrid	image.regrid
34	I9	CASAdocs	Images	Reformat Images	change the velocity system of an image	imreframe	image.reframe
35	I10	CASAdocs	Images	Reformat Images	rebin an image in any spatial or spectral direction	imrebin	image.rebin
36	I11	CASAdocs	Images	Reformat Images	apply an aggregation function along one or more axes of an image, must include 'max', 'mean', 'median', 'min', 'rms', 'stdev', 'sum', 'variance'	imcollapse	direct on image	TBD: what about 'flux'?
37	I12	CASAdocs	Images	Spectral Analysis	continuum subtraction on an image cube. Perform a polynomial baseline fit to the specified channels from an image cube and subtract it from all channels.	imcontsub	image.contsub
38	I13	CASAdocs	Images	Spectral Analysis	collapse the cube into a moment image by taking a linear combination of the individual planes	immoments	image.moment	scikit-image has functions for this
39	I14	CASAdocs	Images	Spectral Analysis	smooth data along n-dimensions of image cube	specsmooth, imsmooth	image.smooth
40	I15	CASAdocs	Images	Spectral Analysis	perform spectral line fits in data cubes, including polynomials, Gaussians, and Lorentzians. fit a power logarithmic polynomial or a logarithmic transformed polynomial to pixel values along a specified axis	specfit, spxfit	image.specfit, image.spxfit
41	I16	CASAdocs	Images	Spectral Analysis	calculate the flux as a function of frequency and velocity over a selected spatial region	specflux	image.specflux
42	I17	CASAdocs	Images	Spectral Analysis	generate the rotation measure by performing a least square fit with Stokes Q and U axes	rmfit	image.rmfit
43	I18	CASAdocs	Images	Spectral Analysis	find spectral lines in subset of the Splatalogue spectral line catalog. Support additional lines not in catalog	slsearch, splattotable		Need to investigate options here
44	I19	CASAdocs	Images	Image Plane Analysis	Fit one or more elliptical Gaussian components on an image region	imfit	image.ellipsefit
45	I20	CASAdocs	Images	Math Operations / Statistics	perform mathematical operations on images and on specific channels within images, including e.g. addition or subtraction of two cubes, squaring an image, computing a spectral index, and determining polarization angles and intensities	immath	direct on DS
46	I21	CASAdocs	Images	Math Operations / Statistics	calculate statistics on a region of an image produce an output image whose value in each pixel represents the "error" or "deviation" in the input image at the corresponding pixel	imstat, imdev	direct on DS
47	I22	CASAdocs	Images	Regions	allow the slicing of images by n-dim regions, where region are may be specified by raw pixel locations or spatial/stokes/freq units	selection parameters	direct on DS
48	I23	CASAdocs	Images	Regions	support reading/writing region files to disk for persistance	CASA region file	direct on DS	stored in zarr file with DS contents
49	I24	CASAdocs	Images	Masks	allow the masking of images by n-dim regions, where region are may be specified by raw pixel locations or spatial/stokes/freq units. Math/statistical calculations ignore pixels within masks	makemask	image.mask, image.region
50	N/A	CASAdocs	Images	Spectral Analysis	generate position-velocity diagrams, plot spectra according to their pointing directions	impv, plotprofilemap	N/A
51
52		casacore	measures	listcodes
53		casacore	measures	measure
54		casacore	measures	observatory
55		casacore	measures	obslist
56		casacore	measures	posangle
57		casacore	measures	position
58		casacore	measures	radialvelocity
59		casacore	measures	rise
60		casacore	measures	riseset
61		casacore	measures	separation
62		casacore	measures	shift
63		casacore	measures	showframe
64		casacore	measures	source
65		casacore	measures	sourcelist
66		casacore	measures	spectralline
67		casacore	measures	todoppler
68		casacore	measures	tofrequency
69		casacore	measures	toradialvelocity
70		casacore	measures	torestfrequency
71		casacore	measures	touvw
72		casacore	measures	type
73		casacore	measures	uvw
74		casacore	measures	epoch	an instant in time	mepoch		astropy.time
75		casacore	measures	direction	a direction towards an astronomical object	mdirection
76		casacore	measures	position	a position on Earth	mposition		astropy.coordinates
77		casacore	measures	frequency	wave characteristics	mfrequency
78		casacore	measures	radialvelocity	radial velocity of astronomical object	mradialvelocity
79		casacore	measures	doppler	doppler shift (i.e. radial velocity in non-velocity units like Optical, Radio	mdoppler
80		casacore	measures	baseline	interferometer baseline	mbaseline
81		casacore	measures	uvw	UVW coordinates	muvw
82		casacore	measures	earthmagnetic	Earth’ magnetic field	mearthmagnetic
83		casacore	functionals		ability to create math functions	Functionals_module	N/A
84		casacore	fitting		provides least squares fitting	Fitting_module	N/A	use something like scipy.optimize or scikit-learn
85		casacore	quantities	constants, convert, convertdop, convertfreq, define, quantity, isquantity	Create and transform structured scalar and vector values and string metadata corresponding to physical constants, with comprehension of standard units and prefixes and ability to extend with custom-defined unit types and definitions	casatools.quanta.quanta	astropy.units, scipy.constants, pint.UnitRegistry	units not covered by external packages are: currency; percent and permille; dimensionless units for ADC and beam area; square arcsecond, square arcminute, and square degree (covered by conversion from astropy.units.sr); flux unit and Westerbork flux unit (aliases for Jansky, covered by astropy.units.Jy); Ampere hours; a definition of the mile in terms of Ampere-seconds per kilogram; vacuum permeability and permittivity; HI line frequency in MHz; vacuum permeability constant; and IAU gravitational constant squared				x
86		casacore	quantities	check, checkfreq, formxxx, getformat, getunit, getvalue, setformat, isangle, isquantity, map, maprec, unit	consistently classify quantities and units with both value and unit accessible independently, in formats representing one of: [prec, aprec, tprec, long, lat, len, dtime, elev, auto, vel, freq, dop, unit]	casatools.quanta.quanta
87		casacore	quantities	norm, splitdate, time, toangle, totime	allow for conversion between angles and times, normalizing angles in units of interval of 2pi radians	casatools.quanta.quanta
88		casacore	quantities	canon, canonical, tos	output string representing scalar and canonical interpretation of units	casatools.quanta.quanta
89		casacore	quantities	cos, sin, tan	calculate trigonometric functions	casatools.quanta.quanta
90		casacore	quantities	acos, asin, atan	calculate inverse trigonometric functions	casatools.quanta.quanta
91		casacore	quantities	eq, compare, ge, gt, le, lt, ne	test for numerical, dimensional, logical equality	casatools.quanta.quanta
92		casacore	quantities	ceil, floor	calculate floor and ceiling functions	Quanta_module
93		casacore	quantities	add, div, exp, log, log10, neg, mul, pow, sqrt, sub	calculate arithmetic operations	Quanta_module
94		casacore	quantities	fits	output in format compatible with FITS storage convention	Quanta_module
95		casacore	quantities	type	self-identify instantiations of class objects	Quanta_module
96
97
98
99
100