<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="imstat" category="information, analysis">
<shortdescription>Displays statistical information from an image or image region</shortdescription>
<input>
<param type="path" name="imagename" kind="image" mustexist="true"><shortdescription>Name of the input image</shortdescription><description>Name of the input image</description>
<value/>
<example>imagename=ngc5921_task.image</example>
</param>
<param type="any" name="axes"><shortdescription>List of axes to evaluate statistics over. Default is all axes.</shortdescription><description>List of axes to evaluate statistics over. Default is all axes.</description>
<any type="variant"/>
<value>-1</value>
<example>[0, 1]</example>
</param>
<param type="string" name="region"><shortdescription>Region selection. Default is to use the full image.</shortdescription><description>Region selection. Default is to use the full image.</description>
<type>path</type>
<type>string</type>
<type>record</type>
<value type="string"/>
</param>
<param type="string" name="box"><shortdescription>Rectangular region(s) to select in direction plane. Default is to use the entire direction plane.</shortdescription><description>Rectangular region(s) to select in direction plane. Default is to use the entire direction plane.</description>
<value/>
</param>
<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>
<value/>
</param>
<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>
<value/>
<example>stokes="IQ"</example>
<example>stokes="RR,LL"</example>
</param>
<param type="bool" name="listit"><shortdescription>Print stats and bounding box to logger?</shortdescription><description>Print stats and bounding box to logger?</description>
<value>True</value>
</param>
<param type="bool" name="verbose"><shortdescription>Print additional messages to logger?</shortdescription><description>Print additional messages to logger?</description>
<value>True</value>
</param>
<param type="string" direction="in" name="mask"><shortdescription>Mask to use. Default is none.</shortdescription><description>Mask to use. Default is none.</description>
<value/>
</param>
<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>
<value>False</value>
</param>
<param type="string" name="logfile"><shortdescription>Name of file to write fit results.</shortdescription><description>Name of file to write fit results.</description>
<value/>
<example>logfile="myimfitlog.txt"</example>
</param>
<param type="bool" name="append" subparam="true"><shortdescription>If logfile exists, append to it if True or overwrite it if False</shortdescription><description>If logfile exists, append to it if True or overwrite it if False</description>
<value>True</value>
<example>append=True</example>
</param>
<param type="string" name="algorithm"><shortdescription>Algorithm to use. Supported values are "biweight", "chauvenet", "classic", "fit-half", and "hinges-fences". Minimum match is supported.</shortdescription><description>Algorithm to use. Supported values are "biweight", "chauvenet", "classic", "fit-half", and "hinges-fences". Minimum match is supported.</description>
<value>classic</value>
</param>
<param type="double" name="fence" subparam="true"><shortdescription>Fence value for hinges-fences. A negative value means use the entire data set (ie default to the "classic" algorithm). Ignored if algorithm is not "hinges-fences".</shortdescription><description>Fence value for hinges-fences. A negative value means use the entire data set (ie default to the "classic" algorithm). Ignored if algorithm is not "hinges-fences".</description>
<value>-1</value>
</param>
<param type="string" name="center" subparam="true"><shortdescription>Center to use for fit-half. Valid choices are "mean", "median", and "zero". Ignored if algorithm is not "fit-half".</shortdescription><description>Center to use for fit-half. Valid choices are "mean", "median", and "zero". Ignored if algorithm is not "fit-half".</description>
<value>mean</value>
</param>
<param type="bool" name="lside" subparam="true"><shortdescription>For fit-half, use values <= center for real data if True? If False, use values >= center as real data. Ignored if algorithm is not "fit-half".</shortdescription><description>For fit-half, use values <= center for real data if True? If False, use values >= center as real data. Ignored if algorithm is not "fit-half".</description>
<value>True</value>
</param>
<param type="double" name="zscore" subparam="true"><shortdescription>For chauvenet, this is the target maximum number of standard deviations data may have to be included. If negative, use Chauvenet"s criterion. Ignored if algorithm is not "chauvenet".</shortdescription><description>For chauvenet, this is the target maximum number of standard deviations data may have to be included. If negative, use Chauvenet"s criterion. Ignored if algorithm is not "chauvenet".</description>
<value>-1</value>
</param>
<param type="int" name="maxiter" subparam="true"><shortdescription>For chauvenet, this is the maximum number of iterations to attempt. Iterating will stop when either this limit is reached, or the zscore criterion is met. If negative, iterate until the zscore criterion is met. Ignored if algorithm is not "chauvenet".</shortdescription><description>For chauvenet, this is the maximum number of iterations to attempt. Iterating will stop when either this limit is reached, or the zscore criterion is met. If negative, iterate until the zscore criterion is met. Ignored if algorithm is not "chauvenet".</description>
<value>-1</value>
</param>