Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1556

News	FAQ
Search	Home

datafilter.medianclip - Function

	Package	utility
	Module	mathematics
	Tool	datafilter

Median clip a data array

Synopsis
medianclip(data, width, clip, progress)

Arguments

data	in	Input numeric data array
		Allowed:	Numeric Glish vector
width	in	Width of running median filter
		Allowed:	Positive integer
		Default:	5 points
clip	in	The clipping amount
		Allowed:	Positive numeric value
		Default:	5
progress	in	See reports on median filter computation every progress points
		Allowed:	Positive integer
		Default:	No reports

Returns
Boolean mask or fail

Description

This function generates a median clipped mask from a data array. It does this by computing the median filtered array (d1). Then it finds the absolute differences from this (d2). Then it computes the median filter of d2 forming d3. The absolute differences (d2) are then compared point by point with d3. Any value d2 > clip*d3 is flagged as bad (mask==F).

The function returns a Boolean mask vector. Values of T are good and values of F are the ones detected as outliers (bad).

As yet, input masks are not handled.

Example

- include 'datafilter.g'
- df := datafilter()
- m := df.medianclip(d, width=10, clip=5)     # Data array 'd' assumed pre-made