Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1488

News	FAQ
Search	Home

imagepol.sigmafractotpol - Function

	Package	general
	Module	images
	Tool	imagepol

Error in fractional total polarization

Synopsis
sigmafractotpol(clip, sigma, outfile)

Arguments

clip	in	Clip level for auto-sigma determination
		Allowed:	Float
		Default:	10
sigma	in	Standard deviation of thermal noise
		Allowed:	Float
		Default:	Auto determined
outfile	in	Output image file name
		Allowed:	String
		Default:	Unset

Returns
Image tool or fail

Description

This function (short-hand name sftp) returns the error (standard deviation) of the fractional total polarization. This result comes from standard propagation of errors. The result is an Image tool as the error is signal-to-noise ratio dependent.

This function requires the standard deviation of the thermal noise. You can either supply it if you know it, or it will be worked out for you with outliers from the mean clipped at the specified level.

Example

- p := imagepol('stokes.cube')
- sigftp := p.sigmafractotpol()