<casaxml xsi:schemaLocation="http://casa.nrao.edu/schema/casa.xsd file:///opt/casa/code/xmlcasa/xml/casa.xsd" xmlns="http://casa.nrao.edu/schema/psetTypes.html" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<task type="function" name="specflux" category="analysis" visibility="experimental">
<shortdescription>Report spectral profile and calculate spectral flux over a user specified region</shortdescription>
<param type="path" name="imagename" mustexist="true"><shortdescription>Name of the input image</shortdescription><description>Name of the input image</description>
<example>imagename='ngc5921.im'</example>
<param type="any" name="region"><shortdescription>Region selection. Default is to use the full image.</shortdescription><description>Region selection. Default is to use the full image.</description>
<example>region="my.rgn"</example>
<param type="string" name="box"><shortdescription>Rectangular region to select in direction plane. Default is to use the entire direction plane.</shortdescription><description>Rectangular region to select in direction plane. Default is to use the entire direction plane.</description>
<example>box="100,100,200,200"</example>
<param type="string" name="chans"><shortdescription>Channels to use. Default is to use all channels.</shortdescription><description>Channels to use. Default is to use all channels.</description>
<param type="string" name="stokes"><shortdescription>Stokes planes to use. Default is to use all Stokes planes.</shortdescription><description>Stokes planes to use. Default is to use all Stokes planes.</description>
<example>stokes="iq"</example>
<param type="string" name="mask"><shortdescription>Mask to use. Default is none.</shortdescription><description>Mask to use. Default is none.</description>
<param type="bool" direction="in" name="stretch" subparam="true"><shortdescription>Stretch the mask if necessary and possible? </shortdescription><description>Stretch the mask if necessary and possible? </description>
<param type="string" name="function"><shortdescription>Aggregate function to use for computing per channel values. Supported values are "flux density", "mean", "median", "sum". Minimal match supported.</shortdescription><description>Aggregate function to use for computing per channel values. Supported values are "flux density", "mean", "median", "sum". Minimal match supported.</description>
<value>flux density</value>
<param type="string" name="unit"><shortdescription>Unit to use for the spectral flux calculation. Must be conformant with a typical spectral axis unit.</shortdescription><description>Unit to use for the spectral flux calculation. Must be conformant with a typical spectral axis unit.</description>
<param type="any" name="major"><shortdescription>Major axis of overriding restoring beam. If specified, must be a valid quantity.</shortdescription><description>Major axis of overriding restoring beam. If specified, must be a valid quantity.</description>
<example>"4arcsec"</example>
<param type="any" name="minor"><shortdescription>Minor axis of overriding restoring beam. If specified, must be a valid quantity</shortdescription><description>Minor axis of overriding restoring beam. If specified, must be a valid quantity</description>
<example>"3arcsec"</example>
<param type="string" name="logfile"><shortdescription>File which to write details. Default is to not write to a file.</shortdescription><description>File which to write details. Default is to not write to a file.</description>