Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1556

News	FAQ
Search	Home

imageevaluator.fidelity - Function

	Package	synthesis
	Module	simulator
	Tool	imageevaluator

Calculate the median image fidelity

Synopsis
fidelity(model, modmin, mode, moment)

Description
The median image fidelity is defined as the median of the fidelity image, defined as

fidelity = model * beam/abs(model * beam - image). (1.34)

To avoid being biased by very weak emission, there is a minimum clip in the model pixel brightness.

The moment fidelity is defined as the average of the fidelity image multiplied by the model * beam image, clipped to avoid the low brightness pixels.

Currently, the model image must be the same size as the image to calculate the fidelity.

Arguments

model		Model or truth image
		Allowed:	Image
		Default:	''
modmin		Minimum pixel value in the model image to be used
		Allowed:	Float
		Default:	0.001
mode		Mode of fidelity calculation
		Allowed:	'median'|'moment'
		Default:	'median'
moment		Exponent of model image to use for moment fidelity
		Allowed:	Float
		Default:	1.0

Returns
Bool

Example

ime.fidelity(model='TRUTH.IMAGE', modmin=0.01, mode='median');