WINCUT

Purpose:

Extracts a series based on the displayed contents of a Window.

Syntax:

WINCUT(srcwin, series, cutxy, zeropad)

srcwin

-

A window, the source window to determine the extraction range.

series

-

A series, the target series to extract from.

cutxy

-

Optional. An integer, the cut mode.

0

:

cut using X displayed range only (default)

1

:

cut using X and Y displayed range

zeropad

-

Optional. An integer, the zero pad mode.

0

:

limit cut range to series extent (default)

1

:

pad beginning and/or end points with zeros if cut range extends beyond the series extent.

Returns:

A series or array.

Example:

W1: gnorm(1000, 1/1000);setx(.2, .5)

W2: cumsum(w1)

W3: wincut(W1, W2)

 

W3 contains the data in W2 that is in the display range of W1.

Example:

W1: gnorm(1000, 1/1000);sety(-0.5, 1.5)

W2: gnorm(1000, 1/1000)

W3: wincut(W1, W2)

W4: wincut(W1, W2, 1)

 

W3 contains the same data as W2, but W4 contains the Y extracted portion of the data displayed in W1. The Y values of W4 range from -0.5 to 1.5.

Example:

W1: gnorm(1000, 1/1000);setx(-0.5, 1.5)

W2: cumsum(w1)

W3: wincut(W1, W2, 0, 0)

W4: wincut(W1, W2, 0, 1)

 

W3 contains the same data as W2 because the display range of W1 is longer than the data extent of W2. However, W4 pads the starting and ending values of W2 with zeros to produce a series that extends from -0.5 to 1.5.

Remarks:

WINCUT works on series, arrays and images.

 

See CUT to extract the displayed portion of a window.

 

See XEXTRACT to extract a segment of a series based on X values.

See Also:

CUT

EXTRACT

SETVPORT

XEXTRACT