cwi_get_rprof¶
-
cwitools.scripts.get_rprof.
get_rprof
(sb_map, pos, pos_type='image', r_min=None, r_max=None, n_bins=10, scale='lin', r_unit='px', redshift=None, var=None, mask=None, out=None, log=None, silent=None)¶ Generate a surface brightness map of a 3D object.
Parameters: - fits_in (str) – Path to FITS file containing SB map.
- pos (float tuple) – The center of the profile in units determined by the ‘pos_type’ argument. Default is image coordinates, (x, y).
- pos_type (str) – The type of coordinate given for the ‘pos’ argument. ‘radec’ - (RA, DEC) tuple in decimal degrees ‘image’ - (x, y) tuple in image coordinates (default)
- r_min (float) – The minimum radius, in units determined by runit.
- r_max (float) – The maximum radius, in units determined by runit.
- nbins (int) – The number of radial bins between r_min and r_max to use.
- scale (str) – The scale for the radial bins. ‘lin’ makes bins equal size in linear space. ‘log’ makes bins equal size in log space.
- runit (str) – The unit of r_min and r_max. Can be ‘pkpc’ or ‘px’ ‘pkpc’ Proper kiloparsec, redshift must also be provided. ‘px’ pixels (i.e. distance in image coordinates)
- redshift (float) – The redshift of the emission, needed to calculate physical distances.
- var (str) – Path to FITS file containing SB map variance.
- mask (str) – Path to FITS file containing 2D binary mask of regions to exclude.
- out (str) – The output file name for the radial profile. Default is to add “.rprof.fits”
- log (str) – Path to log file to save output to.
- silent (bool) – Set to TRUE to suppress standard output.
Returns: None