Ox Graphics Function Reference

CloseDrawWindow

Draw

DrawCorrelogram

DrawDensity

DrawMatrix

DrawQQ

DrawSpectrum

DrawT

DrawTMatrix

DrawX

DrawXMatrix

SaveDrawWindow

SetDrawWindow

SetTextWindow

ShowDrawWindow

Default line attributes

CloseDrawWindow

CloseDrawWindow();

No return value.

Closes the draw window. On many platforms nothing will happen, e.g. when the graphs appear in GiveWin, the graph will remain active there. Under MS-DOS, however, the screen will switch back from graphics mode to text mode.

Draw

Draw(const iArea, const mYt, const dXfirst,const dXstep);

iArea

in: int, area index

mYt

in: int, m x T matrix with m rows of data

dXfirst

in: double, X-value of first observation, x

dXstep

in: double, gap between X-values, d_x

No return value.

This function draws m variables against an X variable, where the X variable consists of evenly spaced observations x, x+d_x, x+2d_x, x+3d_x, .... Each variable is drawn by linking up the points. The first line index is 2.

DrawCorrelogram

DrawCorrelogram(const iArea, const vY, const sY, const cLag);

iArea

in: int, area index

vY

in: int, 1 x T matrix, only one row will be used

sY

in: string, variable name

cLag

in: int, highest lag to be used in correlogram

No return value.

Draws a correlogram (the ACF is computed slightly differently from acf).

DrawDensity

DrawDensity(const iArea, const vY, const sY, const fDens, const fHist, const fNormal);

iArea

in: int, area index

vY

in: int, 1 x T matrix, only one row will be used

sY

in: string, variable name

fDens

in: int, TRUE: draw estimated density

fHist

in: int, TRUE: draw histogram

fNormal

in: int, TRUE: add normal density for reference

No return value.

Draws the histogram and/or density of the data in the specified area. When fNormal is TRUE, a normal density with the same mean and variance as the data will be drawn.

DrawMatrix

DrawMatrix(const iArea, const mYt, const asY, const dXfirst, const dXstep); DrawMatrix(const iArea, const mYt, const asY, const dXfirst, const dXstep, iSymbol); DrawMatrix(const iArea, const mYt, const asY, const dXfirst, const dXstep, iSymbol, iFirstIndex);

iArea

in: int, area index

mYt

in: int, m x T matrix with m rows of data

asY

in: array of strings (holds variable names), or 0 (no names)

dXfirst

in: double, X-value of first observation, x

dXstep

in: double, gap between X-values, d_x

iSymbol

in: int, 0: draw line, 1: draw symbols, 2: draw both (optional argument, default is 0).

iFirstIndex

n: int, line index for first row (see below), (optional argument, default is 2). Each subsequent row will have the next index.

No return value.

This is a more flexible version of the Draw() function. DrawMatrix draws the m variables in the rows of mYt. The X variable consists of evenly spaced observations x, x+d_x, x+2d_x, x+3d_x, .... The following table gives the default settings for each line index. Note that index 0 is the background colour, and 1 the foreground colour.

---

Table draw.1: Default line attributes

index color line type width symbol size 0 white solid 10 plus 80 1 black solid 6 plus 80 2 red solid 10 plus 80 3 blue solid 10 box 80 4 blue/green solid 10 circle 80 5 purple dotted 10 plus 80 6 green dotted 10 plus 80 7 brown/yellow long dash 10 plus 80 8 dark purple long dash 10 plus 80 9 pastel yellow dotted 10 plus 80 10 pastel green dotted 10 plus 80 11 pastel blue solid 10 plus 80 12 solid 10 plus 80 13 light grey solid 10 plus 80 14 grey solid 10 plus 80 15 light grey solid 10 plus 80

---

DrawQQ

DrawQQ(const iArea, const vY, const sY, const iDens, const df1, const df2);

iArea

in: int, area index

vY

in: int, 1 x T matrix, only one row will be used

sY

in: string, variable name

iDens

in: int, one of: QQ_CHI, QQ_F, QQ_N, QQ_T, QQ_U

df1

in: int, first parameter for distribution

df2

in: int, second parameter for distribution

No return value.

Draws a QQ plot. The following distributions are supported:

• QQ_CHI : chi ^2(df1),
• QQ_F : F(df1, df2),
• QQ_N : N(0, 1),
• QQ_T : t(df1),
• QQ_U : Uniform(0,1), resulting in a Quantile plot.

DrawSpectrum

DrawSpectrum(const iArea, const vY, const sY, const iOrder);

iArea

in: int, area index

vY

in: int, 1 x T matrix, only one row will be used

sY

in: string, variable name

iOrder

in: int, lag truncation parameter m

No return value.

Draws the estimated spectral density.

DrawT

DrawT(const iArea, const mYt, const mnYear, const mnPeriod, const iFreq);

iArea

in: int, area index

mYt

in: int, m x T matrix with m y variables

mnYear

in: int, year of first observation

mnPeriod

in: int, period of first observation

iFreq

in: int, frequency of observations

No return value.

Draws m variables in the specified area against time. Each variable is drawn by linking up the points. The first line index is 2.

DrawTMatrix

DrawTMatrix(const iArea, const mYt, const asY, const mnYear, const mnPeriod, const iFreq); DrawTMatrix(const iArea, const mYt, const asY, const mnYear, const mnPeriod, const iFreq, iSymbol); DrawTMatrix(const iArea, const mYt, const asY, const mnYear, const mnPeriod, const iFreq, iSymbol, iFirstIndex);

iArea

in: int, area index

mYt

in: int, m x T matrix with m y variables

asY

in: array of strings (holds variable names), or 0 (no names)

mnYear

in: int, year of first observation

mnPeriod

in: int, period of first observation

iFreq

in: int, frequency of observations

iSymbol

in: int, 0: draw line, 1: draw symbols, 2: draw both (optional argument, default is 0).

iFirstIndex

n: int, line index for first row (see below), (optional argument, default is 2). Each subsequent row will have the next index.

No return value.

This is a more flexible version of the DrawT() function. Draws m variables in the specified area against time. See under DrawMatrix for the default settings for each line index.

DrawX

DrawX(const iArea, const mYt, const vX);

iArea

in: int, area index

mYt

in: int, m x T matrix with m y variables

vX

in: int, 1 x T matrix with x variable

No return value.

Draws m y variables in the specified area against an x variable. Each point is marked, but the points are not linked, resulting in a cross plot. The first line index is 2.

DrawXMatrix

DrawXMatrix(const iArea, const mYt, const asY, const vX, const sX); DrawXMatrix(const iArea, const mYt, const asY, const vX, const sX, iSymbol); DrawXMatrix(const iArea, const mYt, const asY, const vX, const sX, iSymbol, iFirstIndex);

iArea

in: int, area index

vX

in: int, 1 x T matrix with x variable

iSymbol

in: int, 0: draw line, 1: draw symbols, 2: draw both (optional argument, default is 0).

iFirstIndex

n: int, line index for first row (see below), (optional argument, default is 2). Each subsequent row will have the next index.

No return value.

This is a more flexible version of the DrawX() function. Draws m variables in the specified area against an x variable See under DrawMatrix for the default settings for each line index.

SaveDrawWindow

SaveDrawWindow(const sFilename);

sFilename

in: valid file name

No return value.

Saves the current graph to the specified file. The file format for saving is derived from the extension. The following formats are supported:

• .eps : Encapsulated PostScript
• .gwg : GiveWin graphics file
• .ps : PostScript

See the GiveWin book for a description of these formats.

SetDrawWindow

SetDrawWindow(const sTitle);

sTitle

in: string, name of window

No return value.

This function is only relevant when interacting with GiveWin otherwise it does nothing. It sets the name of the GiveWin window in which the graphs of the Ox program appear to sTitle.

SetTextWindow

SetTextWindow(const sTitle);

sTitle

in: string, name of window

No return value.

This function is only relevant when interacting with GiveWin otherwise it does nothing. It sets the name of the GiveWin window in which the output (from the print() function) of the Ox program appears to sTitle.

ShowDrawWindow

ShowDrawWindow();

No return value.

Shows the drawing. Note that in some implementations the graphs cannot be displayed. Then a message is printed (SaveDrawWindow() will still work in that case!). A call to ShowDrawWindow also clears the drawing buffer, so that subsequent graphing starts from an empty sheet.