cwi_obj_zmoments

cwitools.scripts.obj_zmoments.obj_zmoments(cube, obj, obj_id=1, var=None, r_smooth=None, w_smooth=None, unit='wav', label=None, log=None, silent=None)

Create 2D maps of velocity and dispersion.

Parameters:

• cube (str) – Path to input data cube
• obj (str) – Path to FITS containing 3D object masks.
• obj_id (int or list) – ID (or list of IDs) of object(s) to include when calculating z-moments.
• var (str) – Path to input variance cube.
• r_smooth (float) – Spatial smoothing scale to use before moments calculation, given as FWHM of a Gaussian kernel.
• w_smooth (float) – Wavelength smoothing scale to use before moments calculation, given as FWHM of a Gaussian kernel.
• unit (str) – Output units for moments maps, either ‘wav’ for Angstroms or ‘kms’ for kilometers per second.
• label (str) – Custom label for output file name, which will add .<label>_m1.fits to the input file name for the first moment map. e.g. provide “LyA” to get “.LyA_m1.fits”, “.LyA_m2.fits” and so on. By default, the label will “objXX” where XX is the objID for a single ID, or the first ID followed by a ‘+’ for a list of IDs.
• log (str) – Path to log file to save output to.
• silent (bool) – Set to TRUE to suppress standard output.

Returns:

None