cwi_obj_spec

cwitools.scripts.obj_spec.obj_spec(cube, obj, obj_id, extend_z=False, var=None, no_covar=False, label=None, log=None, silent=None)

Generate an integrated spectrum of a 3D object.

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 creating SB map.
• extend_z (bool) – Set to TRUE to include full spectrum range from each object spaxel. By default, only the spectral range within the object mask will be summed. Default: False.
• rescale_cov (bool) – Rescale the variance estimate to account for covariance. Only works when covariance calibration has been done (see scripts.fit_covar). Default: True.
• label (str) – Custom label for output file name, which will add .<label>_spec.fits to the input file name. e.g. provide “LyA” for a Lyman-alpha object to get “.LyA_spec.fits” 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