imstat – Displays statistical information from an image or image region – analysis, information task

Description

Parameters

Title

Parameter	Default	Description
imagename	''
axes	[ ]
region	''
box	''
chans	''
stokes	''
listit	True
verbose	True
mask	''
stretch	False
logfile	''
append	True
algorithm	'classic'
fence	float(-1)
center	'mean'
lside	True
zscore	float(-1)
maxiter	int(-1)
clmethod	'auto'

Parameter Explanations

imagename

''

Name of the input image

axes

[ ]

List of axes to evaluate statistics over. Default is all axes.

region

''

Region selection. See “help par.region” for details. Default is to use the full image.

box

''

Rectangular region(s) to select in direction plane. See “help par.box” for details. Default is to use the entire direction plane.

chans

''

Channels to use. See “help par.chans” for details. Default is to use all channels.

stokes

''

Stokes planes to use. See “help par.stokes” for details. Default is to use all Stokes planes.

listit

True

Print stats and bounding box to logger?

verbose

True

Print additional messages to logger?

mask

''

Mask to use. See help par.mask. Default is none.

stretch

False

Stretch the mask if necessary and possible? See help par.stretch

logfile

''

Name of file to write fit results.

append

True

If logfile exists, append to it if True or overwrite it if False

algorithm

'classic'

Algorithm to use. Supported values are “chauvenet”, “classic”, “fit-half”, and “hinges-fences”. Minimum match is supported.

fence

float(-1)

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”.

center

'mean'

Center to use for fit-half. Valid choices are “mean”, “median”, and “zero”. Ignored if algorithm is not “fit-half”.

lside

True

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”.

zscore

float(-1)

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”.

maxiter

int(-1)

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”.

clmethod

'auto'

Method to use for calculating classical statistics. Supported methods are “auto”, “tiled”, and “framework”. Ignored if algorithm is not “classic”.