Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1556

News	FAQ
Search	Home

imagerpositiontest.get_rms - Function

	Package	synthesis
	Module	synthesistester
	Tool	imagerpositiontest

Get the rms from the restored map in an "intelligent" fashion.

Synopsis
get_rms(im)

Description
Get the rms from the restored map in an "intelligent" fashion. The way this algorithm works is to first get the rms using the entire image and then create a mask, using pixels in the image within -3 to 3 times the rms just calculated. The algorithm then iterates in this fashion until the fractional difference between the previously calculated rms and the currently calculated rms is below some threshhold, currently hard wired to be 0.001.

Arguments

im		A valid image tool from which to get the rms
		Allowed:	Any valid image tool
		Default:	None

Returns
Float

Example

- include 'imagerpositiontest.g';
- ipt := imagerpositiontest();
- include 'image.g';
- myim := image('some.image');
- rms := ipt.get_rms(myim);
# numerous messages from image.stats() here
# and finally
- rms;
0.00384885306