Chapter 9: Utility Routines

9.1 Transforming Coordinates

The calls are:	IXP = NXPOSN (X)	level 2, 3
	IYP = NYPOSN (Y)	level 2, 3

or:	int nxposn (float x);
	int nyposn (float y);

Plot coordinates can also be returned as real numbers.

The calls are:	XP = XPOSN (X)	level 2, 3
	YP = YPOSN (Y)	level 2, 3

or:	float xposn (float x);
	float yposn (float y);

The following two functions convert plot coordinates to user coordinates.

The calls are:	XW = XINVRS (NXP)	level 2, 3
	YW = YINVRS (NYP)	level 2, 3

or:	float xinvrs (int nxp);
	float yinvrs (int nyp);

The functions NXPIXL and NYPIXL convert plot coordinates to pixel.

The calls are:	IXP = NXPIXL (IX, IY)	level 1, 2, 3
	IYP = NYPIXL (IX, IY)	level 1, 2, 3

or:	int nxpixl (int ix, int iy);
	int nypixl (int ix, int iy);

G E T R C O

GETRCO converts a complex impedance value to a reflection factor by the formula r = (z - 1) / (z + 1).

The call is:	CALL GETRCO (ZRE, ZIMG, RRE, RIMG)	level 0, 1, 2, 3
or:	void getrco (float zre, float zimg, float *rre, float *rimg);

ZRE, ZIMG	are the real and imaginary parts of z.
RRE, RIMG	are the returned real and imaginary parts of r.

G E T I C O

GETICO converts a complex reflection factor to an impedance by the formula z = (1 + r) / (1 - r).

The call is:	CALL GETICO (RRE, RIMG, ZRE, ZIMG)	level 0, 1, 2, 3
or:	void getico (float rre, float rimg, float *zre, float *zimg);

RRE, RIMG	are the real and imaginary parts of r.
ZRE, ZIMG	are the returned real and imaginary parts of z.

T R F R E L

TRFREL converts user coordinates to plot coordinates.

The call is:	CALL TRFREL (XRAY, YRAY, N)	level 2, 3
or:	void trfrel (float *xray, float *yray, int n);

XRAY, YRAY	are arrays containing the user coordinates. After the call, they contain the calculated plot coordinates.
N	is the number of points.

Additional note:

• The routines above can be used for linear and logarithmic scaling. For polar scaling, TRFREL and POS2PT can be used for getting plot coordinates.

T R F C O 1

The routine TRFCO1 converts one-dimensional coordinates.

The call is:	CALL TRFCO1 (XRAY, N, CFROM, CTO)	level 0, 1, 2, 3
or:	void trfco1 (float *xray, int n, const char *cfrom, const char *cto);

XRAY	is an array containing angles expressed in radians or degrees. After a call to TRFCO1, XRAY contains the converted coordinates.
N	is the number of coordinates.
CFROM, CTO	are character strings that can have the values 'DEGREES' and 'RADIANS'.

T R F C O 2

The routine TRFCO2 converts two-dimensional coordinates.

The call is:	CALL TRFCO2 (XRAY, YRAY, N, CFROM, CTO)	level 0, 1, 2, 3
or:	void trfco2 (float *xray, float *yray, int n, const char *cfrom, const char *cto);

XRAY, YRAY	are arrays containing rectangular or polar coordinates. For polar coordinates, XRAY contains the angles measured in degrees and YRAY the radii.
N	is the number of coordinates.
CFROM, CTO	are character strings that can have the values 'RECT' and 'POLAR'.

T R F C O 3

The routine TRFCO3 converts three-dimensional coordinates.

The call is:	CALL TRFCO3 (XRAY, YRAY, ZRAY, N, CFROM, CTO)	level 0, 1, 2, 3
or:	void trfco3 (float *xray, float *yray, float *zray, int n, const char *cfrom, const char *cto);

XRAY, YRAY, ZRAY	are arrays containing rectangular, spherical or cylindrical coordinates. Spherical coordinates must be in the form (longitude,latitude, radius) where 0 <= longitude <= 360 and -90 <= latitude <= 90. Cylindrical coordinates must be in the form (angle, radius, z).
N	is the number of coordinates.
CFROM, CTO	are character strings that can have the values 'RECT','SPHER' and 'CYLI'.

T R F M A T

The routine TRFMAT converts a matrix to another matrix by bilinear interpolation.

The call is:	CALL TRFMAT (ZMAT, NX, NY, ZMAT2, NX2, NY2) -	level 0, 1, 2, 3
or:	void trfmat (const float *zmat, int nx, int ny, float *zmat2, int nx2, int ny2);

ZMAT	is the input matrix of the dimension (NX, NY).
NX, NY	are the dimensions of the matrix ZMAT.
ZMAT2	is the output matrix of the dimension (NX2, NY2).
NX2, NY2	are the dimensions of the matrix ZMAT2.

9.2 String Arithmetic

The function NLMESS returns the length of text in plot coordinates.

The call is:	NL = NLMESS (CSTR)	level 1, 2, 3
or:	int nlmess (const char *cstr);

CSTR	is a character string (<= 132 characters).
NL	is the length in plot coordinates.

T R M L E N

The function TRMLEN returns the number of characters in a character string.

The call is:	NL = TRMLEN (CSTR)	level 0, 1, 2, 3
or:	int trmlen (const char *cstr);

CSTR	is a character string.
NL	is the number of characters.

U P S T R

UPSTR converts a character string to uppercase letters.

The call is:	CALL UPSTR (CSTR)	level 0, 1, 2, 3
or:	void upstr (char *cstr);

CSTR	is a character string to be converted.

U T F I N T

UTFINT converts a UTF8 character string to Unicode numbers.

The call is:	CALL UTFINT (CSTR, IRAY, NRAY, N)	level 0, 1, 2, 3
or:	int utfint (const char *cstr, int *iray, int nray);

CSTR	is a character string in UTF8 format.
IRAY	is the returned array of Unicode numbers.
NRAY	is the dimension of IRAY.
N	is the returned number of calculated Unicode numbers. If an error occurred, a negative number is returned.

I N T U T F

INTUTF converts an array of Unicode number to a UTF8 character string.

The call is:	CALL INTUTF (IRAY, NRAY, CSTR, NMAX, N)	level 0, 1, 2, 3
or:	int intutf (const int *iray, int nray, char *cstr, int nmax);

IRAY	is an integer array of Unicode numbers.
NRAY	is the number of elements in IRAY.
CSTR	is the returned character string in UTF8 format.
NMAX	is the maximal number of characters that CSTR can contain.
N	is the returned length of CSTR. If an error occurred, a negative number is returned.

9.3 Number Arithmetic

NLNUMB calculates the length of numbers in plot coordinates.

The call is:	NL = NLNUMB (X, NDIG)	level 1, 2, 3
or:	int nlnumb (float x, int ndig);

X	is a real number.
NDIG	is the number of decimal places (>= -1).
NL	is the length in plot coordinates.

I N T L E N

INTLEN calculates the number of digits in integers.

The call is:	CALL INTLEN (NX, NL)	level 0, 1, 2, 3
or:	int intlen (int nx);

NX	is an integer.
NL	is the number of digits.

F L E N

FLEN calculates the number of digits in real numbers.

The call is:	CALL FLEN (X, NDIG, NL)	level 0, 1, 2, 3
or:	int flen (float x, int ndig);

X	is a real number.
NDIG	is the number of decimal places (>= -1).
NL	is the number of digits including the decimal point. For negative numbers, it includes the minus sign.

I N T C H A

INTCHA converts integers to character strings.

The call is:	CALL INTCHA (NX, NL, CSTR)	level 0, 1, 2, 3
or:	int intcha (int nx, char *cstr);

NX	is the integer to be converted.
NL>/td>	is the number of digits in NX returned by INTCHA.
CSTR	is the character string containing the integer.

F C H A

FCHA converts real numbers to character strings.

The call is:	CALL FCHA (X, NDIG, NL, CSTR)	level 0, 1, 2, 3
or:	int fcha (float x, ind ndig, char *cstr);

X	is the real number to be converted.
NDIG	is the number of decimal places to be considered (>= -1). The last digit will be rounded up.
NL	is the number of digits returned by FCHA.
CSTR	is the character string containing the real number.

S O R T R 1

SORTR1 sorts real numbers.

The call is:	CALL SORTR1 (XRAY, N, COPT)	level 0, 1, 2, 3
or:	void sortr1 (float *xray, int n, const char *copt);

XRAY	is an array containing real numbers.
N	is the dimension of XRAY.
COPT	defines the sorting direction. IF COPT = 'A', the numbers will be sorted in ascending order; if COPT = 'D', they will be sorted in descending order.

S O R T R 2

SORTR2 sorts two-dimensional points in the X-direction.

The call is:	CALL SORTR2 (XRAY, YRAY, N, COPT)	level 0, 1, 2, 3
or:	void sortr2 (float *xray, float *yray, int n, const char *copt);

XRAY, YRAY	are arrays containing the coordinates.
N	is the number of points.
COPT	defines the sorting direction. IF COPT = 'A', the points will be sorted in ascending order; if COPT = 'D', they will be sorted in descending order.

Additional note:

• The Shell-algorithm is used for sorting.

S P L I N E

SPLINE calculates splined points used in CURVE to plot a spline.

The call is:	CALL SPLINE (XRAY, YRAY, N, XSRAY, YSRAY, NSPL)	level 1, 2, 3
or:	void spline (const float *xray, const float *yray, int n, float *xsray, float *ysray, int *nspl);

XRAY, YRAY	are arrays containing points of the curve.
N	is the dimension of XRAY and YRAY.
XSRAY, YSRAY	are the splined points returned by SPLINE.
NSPL	is the number of calculated splined points returned by SPLINE. By default, NSPL has the value 200.

Additional note:

• The number of interpolated points and the order of the polynomials can be modified with SPLMOD.

B E Z I E R

The routine BEZIER calculates a Bezier interpolation.

The call is:	CALL BEZIER (XRAY, YRAY, N, XPRAY, YPRAY, NP)	level 0, 1, 2, 3
or:	void bezier (const float *xray, const float *yray, int n, float *xpray, float *ypray, int np);

XRAY, YRAY	are arrays containing points of the curve.
N	is the dimension of XRAY and YRAY (1 < N < 21).
XPRAY, YPRAY	are the Bezier points returned by BEZIER.
NP	is the number of calculated points defined by the user.

H I S T O G

The routine HISTOG calculates a histogram.

The call is:	CALL HISTOG (XRAY, N, XHRAY, YHRAY, NH)	level 0, 1, 2, 3
or:	void histog (const float *xray, int n, float *xhray, float *yhray, int nh);

XRAY	is an array containing floating point numbers.
N	is the dimension of XRAY.
XHRAY, YHRAY	are arrays containing the calculated histogram. XHRAY contains distinct values from XRAY sorted in ascending order. YHRAY contains the frequency of points.
NH	is the number of points in XHRAY und YHRAY returned by HISTOG.

T R I A N G

The routine TRIANG calculates the Delaunay triangulation of an arbitrary collection of points in the plane. The Delaunay triangulation can directly be used to display surfaces and contour lines of irregularly distributed data points.

The call is:	The call is: CALL TRIANG (XRAY, YRAY, N, I1RAY, I2RAY, I3RAY, NMAX, NTRI)	level 0, 1, 2, 3
or:	int triang (float *xray, float *yray, int n, int *i1ray, int *i2ray, int *i3ray, int nmax);

XRAY, YRAY	are arrays containing floating point numbers. The dimension of XRAY and YRAY must be greater or equal N + 3.
N	is the number of points in XRAY and YRAY.
I1RAY, I2RAY, I3RAY	are the returned vertices for each triangle in a counter-clockwise order.
NMAX	is the dimension of I1RAY, I2RAY and I3RAY. NMAX must be greater or equal 2 * N + 1.
NTRI	is the returned number of triangles.

Additional notes:

• The Watson algorithm is used for calculating the Delaunay triangulation. The algorithm increases with the number of points as approximately O(N^{1.5}).
  Reference: S.W. Sloan and G.T. Houlsby, An Implementation of Watson's algorithm for computing 2-dimensional Delaunay triangulations, Advanced Engineering Software, 1984, Vol. 6, No. 4.
• Surfaces and contours can be directly plotted from the triangulation with the routines CRVTRI, SURTRI and CONTRI.

The routine CIRC3P calculates a circle specified by three points.

The call is:	CALL CIRC3P (X1, Y1, X2, Y2, X3, Y3, XM, YM, R)		level 0, 1, 2, 3
or:	void circ3p (float x1, float y1, float x2, float y2, float x3, float y3, float *xm, float *ym , float *r)

X1, Y1	are the X- and Y-coordinates of the first point.
X2, Y2	are the X- and Y-coordinates of the second point.
X3, Y3	are the X- and Y-coordinates of the third point.
XM, YM	are the calculated coordinates of the centre point.
R	is the calculated radius of the circle.

P O L C L P

The routine POLCLP clips a polygon against a rectangle. The Sutherland-Hodman algorithm is used by POLCLP. This routine must be called four times to clip against all edges of the rectangle.

The call is:	CALL POLCLP (XRAY, YRAY, N, XRAY2, YRAY2, NMAX, NOUT, XV, CEDGE)	level 0, 1, 2, 3
or:	int polclp (const float *xray, const float *yray, int n, float *xray2, float *yray2, int nmax, float xv, const char *cedge);

XRAY, YRAY	are arrays containing the polygon vertices.
N	is the number of the polygon vertices.
XRAY2, YRAY2	are the returned clipped polygon vertices.
NMAX	is the maximal number of allowed edges in XRAY2 and YRAY2.
NOUT	is the number of vertices in the clipped polygon.
XV	is the value of the current edge.
CEDGE	is a character string that defines the edge. CEDGE can have the values 'TOP', 'LEFT', 'BOTTOM' and 'RIGHT'.

9.4 Date Routines

The routine BASDAT defines the base date. This routine is necessary for plotting date labels and data containing date coordinates.

The call is:	CALL BASDAT (IDAY, IMONTH, IYEAR)	level 0, 1, 2, 3
or:	void basdat (int iday, int imonth, int iyear);

IDAY	is the day number of the date between 1 and 31.
IMONTH	is the month number of the date between 1 and 12.
IYEAR	is the four digit year number of the date.

I N C D A T

The function INCDAT returns the number of days between a specified date and the base date. These calculated days can be passed as parameters to the routine GRAF and as coordinates to data plotting routines such as CURVE.

The call is:	N = INCDAT (IDAY, IMONTH, IYEAR)	level 0, 1, 2, 3
or:	int incdat (int iday, int imonth, int iyear);

N	is the returned number of calculated days.
IDAY	is the day number of the date between 1 and 31.
IMONTH	is the month number of the date between 1 and 12.
IYEAR	is the four digit year number of the date.

T R F D A T

The routine TRFDAT calculates for a number of days the corresponding date.

The call is:	CALL TRFDAT (N, IDAY, IMONTH, IYEAR)	level 0, 1, 2, 3
or:	void trfdat (int n, int *iday, int *imonth, int *iyear);

N	is the number of days.
IDAY	is the returned day number.
IMONTH	is the returned month number.
IYEAR	is the returned four digit year number.

N W K D A Y

The function NWKDAY returns the weekday for a given date.

The call is:	N = NWKDAY (IDAY, IMONTH, IYEAR)	level 0, 1, 2, 3
or:	int nwkday (int iday, int imonth, int iyear);

N	is the returned weekday between 1 and 7 (1 = Monday, 2 = Tuesday, ...).
IDAY	is the day number of the date between 1 and 31.
IMONTH	is the month number of the date between 1 and 12.
IYEAR	is the four digit year number of the date.

9.5 Bit Manipulation

The routine BITSI2 allows bit manipulation on 16 bit variables.

The call is:	CALL BITSI2 (NBITS, NINP, IINP, NOUT, IOUT, IOPT)	level 0, 1, 2, 3
or:	short bitsi2 (int nbits, short ninp, int iinp, short nout, int iout);

NBITS	is the number of bits to be shifted.
NINP	is a 16 bit variable from which to extract the bit field.
IINP	is the bit position of the leftmost bit of the bit field. The bits are numbered 0 - 15 where 0 is the most significant bit.
NOUT	is a 16 bit variable into which the bit field is placed.
IOUT	is the bit position where to put the bit field.
IOPT	controls whether the bits outside of the field are set to zero or not. If IOPT equal 0, the bits are set to zero. If IOPT not equal 0, the bits are left as they are. For this case, NOUT is also used as input parameter. In the C function, IOPT is missing in the parameter list and internally used with the value 1.

B I T S I 4

The routine BITSI4 allows bit manipulation on 32 bit variables.

The call is:	CALL BITSI4 (NBITS, NINP, IINP, NOUT, IOUT, IOPT)	level 0, 1, 2, 3
or:	int bitsi4 (int nbits, int ninp, int iinp, int nout, int iout);

NBITS	is the number of bits to be shifted.
NINP	is a 32 bit variable from which to extract the bit field.
IINP	is the bit position of the leftmost bit of the bit field. The bits are numbered 0 - 31 where 0 is the most significant bit.
NOUT	is a 32 bit variable into which the bit field is placed.
IOUT	is the bit position where to put the bit field.
IOPT	controls whether the bits outside of the field are set to zero or not. If IOPT equal 0, the bits are set to zero. If IOPT not equal 0, the bits are left as they are. For this case, NOUT is also used as input parameter. In the C function, IOPT is missing in the parameter list and internally used with the value 1.

9.6 Byte Swapping

The routine SWAPI2 swaps the bytes of 16 bit integer variables.

The call is:	CALL SWAPI2 (IRAY, N)	level 0, 1, 2, 3
or:	void swapi2 (short *iray, int n);

IRAY	is an array containing the 16 bit variables.
N	is the number of variables.

S W A P I 4

The routine SWAPI4 swaps the bytes of 32 bit integer variables.

The call is:	CALL SWAPI4 (IRAY, N)	level 0, 1, 2, 3
or:	void swapi4 (int *iray, int n);

IRAY	is an array containing the 32 bit variables.
N	is the number of variables.

9.7 Binary I/O

O P E N F L

The routine OPENFL opens a file for binary I/O.

The call is:	CALL OPENFL (CFILE, NLU, IRW, ISTAT)	level 0, 1, 2, 3
or:	int openfl (const char *cfile, int nlu, int irw);

CFILE	is a character string containing the file name.
NLU	is the logical unit for the I/O (0 <= NLU <= 99). The units 15 and 16 are reserved for DISLIN.
IRW	defines the file access mode (0: READ, 1: WRITE, 2: APPEND).
ISTAT	is the returned status (0: no errors).

C L O S F L

The routine CLOSFL closes a file.

The call is:	CALL CLOSFL (NLU)	level 0, 1, 2, 3
or:	int close (int nlu);

NLU	is the logical unit.

R E A D F L

The routine READFL reads a given number of bytes.

The call is:	CALL READFL (NLU, IBUF, NBYT, ISTAT)	level 0, 1, 2, 3
or:	int readfl (int nlu, unsigned char *ibuf, int nbyt);

NLU	is the logical unit.
IBUF	is an array where to read the bytes.
NBYT	is the number of bytes.
ISTAT	is the number of bytes read (0 means end of file).

W R I T F L

The routine WRITFL writes a number of bytes.

The call is:	CALL WRITFL (NLU, IBUF, NBYT, ISTAT)	level 0, 1, 2, 3
or:	int writfl (int nlu, const unsigned char *ibuf, int nbyt);

NLU	is the logical unit.
IBUF	is an array containing the bytes.
NBYT	is the number of bytes.
ISTAT	is the number of bytes written (0 means an error).

S K I P F L

The routine SKIPFL skips a number of bytes from the current position.

The call is:	CALL SKIPFL (NLU, NBYT, ISTAT)	level 0, 1, 2, 3
or:	int skipfl (int nlu, int nbyt);

NLU	is the logical unit.
NBYT	is the number of bytes.
ISTAT	is the returned status (0: OK).

T E L L F L

The routine TELLFL returns the current position in bytes.

The call is:	CALL TELLFL (NLU, NBYT)	level 0, 1, 2, 3
or:	int tellfl (int nlu);

NLU	is the logical unit.
NBYT	is the returned position in bytes where byte numbering begins with zero. NBYT = -1, if an error occurs.

P O S I F L

The routine POSIFL skips to a certain position relative to the start.

The call is:	CALL POSIFL (NLU, NBYT, ISTAT)	level 0, 1, 2, 3
or:	int posifl (int nlu, int nbyt);

NLU	is the logical unit.
NBYT	defines the position. Byte numbering begins with zero.
ISTAT	is the returned status (0: OK).

9.8 Window Terminals

9.8.1 Clearing the Screen

The routine ERASE clears the screen, a graphics window or the page of a raster format such as TIFF, PNG, PPM and BMP. In general, this is done by DISINI at the beginning of a plot.

The call is:	CALL ERASE	level 1, 2, 3
or:	void erase (void);

Additional note:

• If backing store is enabled in DISLIN with the routine X11Mod, the routine ERASE clears just the pixmap and not directly the graphics window. Clearing just the pixmap has the advantage that a new plot can be created on the pixmap while the graphics window remains unchanged. The pixmap can then be copied to the graphics window with the routine SENDBF. This double frame buffer effect avoids flickering.

9.8.2 Clearing the Output Buffer

Normally, the graphical output to the screen is buffered. To send the buffer to the screen, the routine SENDBF can be used.

The call is:	CALL SENDBF	level 1, 2, 3
or:	void sendbf (void);

Additional note:

• SENDBF updates also a graphics window with the current pixmap if backing store is enabled in the routine X11MOD. SENDBF can be used after DISFIN if there is still a graphics window (i.e. after WINMOD ('NONE')).

The routine BUFMOD changes the behaviour of SENDBF.

The call is:	CALL BUFMOD (CMOD, CKEY)	level 1, 2, 3
or:	void bufmod (const char *cmod, const char *ckey);

CMOD	is a character string that can have the values 'ON' and 'OFF'.
CKEY	is a character string that can have the value 'SENDBF'. This keyword enables or disables the internal calls of SENDBF in DISLIN routines such as ENDGRF. Default: ('ON', 'SENDBF').

9.8.3 Multiple Windows

O P N W I N

The routine OPNWIN creates a new window for graphics output on the screen.

The call is:	CALL OPNWIN (ID)	level 1, 2, 3
or:	void opnwin (int id);

ID	is the window number between 2 and 8. The window with the ID 1 is created by DISINI.

Additional notes:

• The file format must be set to X Window emulation in the routine METAFL (i.e. with the keyword 'XWIN').
• The size and position of windows can be changed with the routines WINDOW and WINSIZ.
• An individual page size can be defined for the window with the routine PAGWIN.
• Windows can be closed and selected with the routines CLSWIN and SELWIN.
• A created window with OPNWIN is selected automatically for graphics output.
• External windows can also be used with OPNWIN if the routine SETXID is called before.
• The routine WINMOD affects the handling of windows in the termination routine DISFIN.

The routine CLSWIN closes a window created with OPNWIN.

The call is:	CALL CLSWIN (ID)	level 1, 2, 3
or:	void clswin (int id);

ID	is the window number between 2 and 8. The main window with the ID 1 cannot be closed by CLSWIN.

H I D W I N

The routine HIDWIN defines whether a window is visible or not.

The call is:	CALL HIDWIN (ID, CMOD)	level 1, 2, 3
or:	void hidwin (int id, const char *cmod);

ID	is the window number between 1 and 8.
CMOD	is a character string that can have the values
= 'YES'	the window is hided and not visible.
= 'NO'	the windows is showed and visible. Default: CMOD = 'NO'.

S E L W I N

The routine SELWIN selects a window on the screen where the following graphics output will be sent to.

The call is:	CALL SELWIN (ID)	level 1, 2, 3
or:	void selwin (int id);

ID	is the window number between 1 and 8.

P A G W I N

PAGWIN defines the page size for multiple windows. If PAGWIN is not called, the current page size defined by PAGE or SETPAG is used.

The call is:	CALL PAGWIN (NXP, NYP)	level 1, 2, 3
or:	void pagwin (int nxp, int nyp);

NXP, NYP

are the length and height of the page in plot coordinates. The lower right corner of the page is the point (NXP-1, NYP-1).

W I N I D

The routine WINID returns the ID of the currently selected window.

The call is:	CALL WINID (ID)	level 1, 2, 3
or:	int winid (void);

ID	is the returned window number.

W I N T I T

The routine WINTIT changes the window title of the currently selected window.

The call is:	CALL WINTIT (CSTR)	level 1, 2, 3
or:	void wintit (const char *cstr);

CSTR	is a character string containing the new window title.

9.8.4 Cursor Routines

C S R P O S

The routine CSRPOS sets the position of the mouse pointer and returns the position if a character key or a mouse button is pressed. This routine can be used for cursor navigation.

The call is:	CALL CSRPOS (NX, NY, IKEY)	level 1, 2, 3
or:	int csrpos (int *nx, int *ny);

NX, NY	are integer coordinates. On entry, the mouse pointer is set to the position (NX, NY). If a character key is pressed, the position of the mouse is returned in NX and NY.
IKEY	is the returned ASCII code for the pressed key. The cursor keys can also be used where the following values are returned: 1 for cursor left, 2 for cursor up, 3 for cursor right, 4 for cursor down. The value 5 is returned if the left mouse button is clicked, and the value 6 for the right mouse button. The value -1 is returned if an error occurred and the value 0 if no key is pressed.

Additional note:

• The behaviour of CSRPOS can be modified with the routine CSRMOD.

C S R K E Y

The routine CSRKEY returns a character key. If no character key is pressed, the value 0 is returned.

The call is:	CALL CSRKEY (IKEY)	level 1, 2, 3
or:	int csrkey (void);

IKEY	is the returned ASCII code for the pressed key. The cursor keys can also be used where the following values are returned: 1 for cursor left, 2 for cursor up, 3 for cursor right, 4 for cursor down. The value 0 is returned if no key is pressed.

C S R P T 1

The routine CSRPT1 returns the position of the mouse pointer if the mouse button 1 is pressed. The mouse pointer is changed to a cross hair pointer in the graphics window if CSRPT1 is active.

The call is:	CALL CSRPT1 (NX, NY)	level 1, 2, 3
or:	void csrpt1 (int *nx, int *ny);

NX, NY

are the returned coordinates of the pressed mouse pointer.

C S R P T S

The routine CSRPTS returns an array of mouse positions. The routine is waiting for mouse button 1 clicks and terminates if mouse button 2 is pressed. The mouse pointer is changed to a cross hair pointer in the graphics window.

The call is:	CALL CSRPTS (NXRAY, NYRAY, NMAX, N, IRET)	level 1, 2, 3
or:	void csrpts (int *nxray, int *nyray, int nmax, int *n, int *iret);

NXRAY, NYRAY	are the returned coordinates of the collected mouse positions.
NMAX	is the dimension of NXRAY and NYRAY and defines the maximal number of points that will be stored in NXRAY and NYRAY.
N	is the number of points that are returned in NXRAY and NYRAY.
IRET	is a returned status. IRET not equal 0 means that not all mouse movements could be stored in NXRAY and NYRAY.

C S R P O L

CSRPOL is a similar routine to CSRPTS. It returns an array of mouse positions, where help lines are plotted between the points. CSRPOL is waiting for mouse button 1 clicks and terminates if mouse button 2 is pressed.

The call is:	CALL CSRPOL (NXRAY, NYRAY, NMAX, N, IRET)	level 1, 2, 3
or:	void csrpol (int *nxray, int *nyray, int nmax, int *n, int *iret);

NXRAY, NYRAY	are the returned coordinates of the collected mouse positions.
NMAX	is the dimension of NXRAY and NYRAY and defines the maximal number of points that will be stored in NXRAY and NYRAY.
N	is the number of points that are returned in NXRAY and NYRAY.
IRET	is a returned status. IRET not equal 0 means that not all mouse movements could be stored in NXRAY and NYRAY.

C S R M O V

The routine CSRMOV returns an array of mouse movements. The routine collects the mouse movements of mouse button 1 and terminates if mouse button 1 is released. The mouse pointer is changed to a cross hair pointer in the graphics window.

The call is:	CALL CSRMOV (NXRAY, NYRAY, NMAX, N, IRET)	level 1, 2, 3
or:	void csrmov (int *nxray, int *nyray, int nmax, int *n, int *iret);

NXRAY, NYRAY	are the returned coordinates of the collected mouse movements.
NMAX	is the dimension of NXRAY and NYRAY and defines the maximal number of points that will be stored in NXRAY and NYRAY.
N	is the number of points that are returned in NXRAY and NYRAY.
IRET	is a returned status. IRET not equal 0 means that not all mouse positions could be stored in NXRAY and NYRAY.

C S R R E C

The routine CSRREC returns two opposite corners of a rectangle created with mouse button 1. A rubber band is plotted around the rectangle.

The call is:	CALL CSRREC (NX1, NY1, NX2, NY2)	level 1, 2, 3
or:	void csrrec (int *nx1, int *ny1, int *nx2, int *ny1);

NX1, NY1, NX2, NY2

are the returned coordinates of two opposide rectangle corners.

C S R L I N

The routine CSRLIN is similar to CSRREC and returns the end points of a line created with mouse button 1.

The call is:	CALL CSRLIN (NX1, NY1, NX2, NY2)	level 1, 2, 3
or:	void csrlin (int *nx1, int *ny1, int *nx2, int *ny1);

NX1, NY1, NX2, NY2

are the returned coordinates of the line end points.

C S R M O D

The routine CSRMOD modifies the behaviour of CSRPOS.

The call is:	CALL CSRMOD (CMOD, CKEY)	level 1, 2, 3
or:	void csrmod (const char *cmod, const char *ckey);

CMOD	is a character string that can have the values 'STANDARD', 'SET', 'GET' and 'READ'. With the keywords 'SET' and 'GET' the cursor position can be defined or requested without waiting for a user event. The value 'READ' means that the cursor position is not set at the entry of CSRPOS. The value 'STANDARD' means the default behaviour of CSRPOS.
CKEY	is a character string that can have the value 'POS'. Default: ('STANDARD', 'POS').

C S R U N I

The routine CSRUNI defines if pixels or plot coordinates are returned by the cursor routines.

The call is:	CALL CSRUNI (COPT)	level 1, 2, 3
or:	void clruni (const char *copt);

COPT	is a character string that can have the values 'PIXEL' and 'PLOT'. Default: COPT = 'PLOT'.

Additional note:

• Plot coordinates can be converted to user coordinates with the routines XINVRS and YINVRS.

C S R T Y P

The routine CSRTYP defines the cursor used by the cursor routine.

The call is:	CALL CSRTYP (COPT)	level 1, 2, 3
or:	void csrtyp (const char *copt);

COPT	is a character string that can have the values 'NONE', 'CROSS', 'ARROW' and 'VARROW'. 'NONE' means that the current cursor is not changed. Default: COPT = 'CROSS'.

S E T C S R

The routine SETCSR defines the cursor that is used by the DISLIN graphics window.

The call is:	CALL SETCSR (COPT)	level 1, 2, 3
or:	void setcsr (const char *copt);

COPT	is a character string that can have the values 'ARROW', 'CROSS' and 'VARROW'. Default: COPT = 'ARROW'.

9.9 Elementary Image Routines

I M G I N I

The routine IMGINI initializes transferring of image data with the routines RPIXEL, RPIXLS, RPXROW, WPIXEL, WPIXLS and WPXROW. If the output format is PostScript or PDF, IMGINI creates a virtual image where image data can be written to.

The call is:	CALL IMGINI	level 1, 2, 3
or:	void imgini (void);

I M G F I N

The routine IMGFIN terminates transferring of image data with the routines RPIXEL, RPIXLS, RPXROW, WPIXEL, WPIXLS and WPXROW. If the output format is PostScript or PDF, the virtual image created in IMGINI is copied to the PostScript or PDF file.

The call is:	CALL IMGFIN	level 1, 2, 3
or:	void imgfin (void);

R P I X E L

The routine RPIXEL reads one pixel from memory.

The call is:	CALL RPIXEL (IX, IY, ICLR)	level 1, 2, 3
or:	void rpixel (int ix, int iy, int *iclr);

IX, IY	is the position of the pixel in screen coordinates.
ICLR	is the returned colour value of the pixel.

W P I X E L

The routine WPIXEL writes one pixel into memory.

The call is:	CALL WPIXEL (IX, IY, ICLR)	level 1, 2, 3
or:	void wpixel (int ix, int iy, int iclr);

IX, IY	is the position of the pixel in screen coordinates.
ICLR	is the new colour value of the pixel.

R P I X L S

The routine RPIXLS copies colour values from a rectangle in memory to an array.

The call is:	CALL RPIXLS (IRAY, IX, IY, NW, NH)	level 1, 2, 3
or:	void rpixls (unsigned char *iray, int ix, int iy, int nw, int nh);

IRAY	is a byte array containing the returned colour values.
IX, IY	contain the starting point in screen coordinates.
NW, NH	are the width and height of the rectangle in screen coordinates.

W P I X L S

The routine WPIXLS copies colour values from an array to a rectangle in memory.

The call is:	CALL WPIXLS (IRAY, IX, IY, NW, NH)	level 1, 2, 3
or:	void wpixls (const unsigned char *iray, int ix, int iy, int nw, int nh);

IRAY	is a byte array containing the colour values.
IX, IY	contain the starting point in screen coordinates.
NW, NH	are the width and height of the rectangle in screen coordinates.

R P X R O W

The routine RPXROW copies one line of colour values from memory to an array.

The call is:	CALL RPXROW (IRAY, IX, IY, N)	level 1, 2, 3
or:	void rpxrow (unsigned char *iray, int ix, int iy, int n);

IRAY	is a byte array containing the returned colour values.
IX, IY	contain the starting point in screen coordinates.
N	is the number of pixels.

W P X R O W

The routine WPXROW copies colour values from an array to a line in memory.

The call is:	CALL WPXROW (IRAY, IX, IY, N)	level 1, 2, 3
or:	void wpxrow (const unsigned char *iray, int ix, int iy, int n);

IRAY	is a byte array containing the colour values.
IX, IY	contain the starting point in screen coordinates.
N	is the number of pixels.

Additional note:

• IMGINI and IMGFIN must be used with the routines RPIXEL, WPIXEL, RPIXLS, WPIXLS, RPXROW and WPXROW.

I M G M O D

The routine IMGMOD defines palette or true colour mode for the routines RPIXLS, WPIXLS, RPXROW and WPXROW. For palette mode, the byte arrays in the routines above must contain colour indices between 0 and 255. For true colour mode, the byte arrays must contain RGB values (8 bit for each value).

The call is:	CALL IMGMOD (CMOD)	level 1, 2, 3
or:	void imgmod (const char *cmod);

CMOD	is a character string that can contain the values 'INDEX' and 'RGB'. Default: CMOD = 'INDEX'.

I M G S I Z

If the output format is PostScript or PDF, the size of images can be defined with the routine IMGSIZ. The routine must be called before IMGINI.

The call is:	CALL IMGSIZ (NW, NH)	level 1, 2, 3
or:	void imgsiz (int nw, int nh);

NW, NH

are the image width and height in pixels. Default: (853, 603).

I M G B O X

If the output format is PostScript or PDF, a rectangle on the output page can be specified where the image is copied to. The routine IMGBOX must be called before IMGINI.

The call is:	CALL IMGBOX (NX, NY, NW, NH)	level 1, 2, 3
or:	void imgbox (int nx, int ny, int nw, int nh);

NX, NY	is the upper left corner of the rectangle on the page in plot coordinates.
NW, NH	are the width and height of the rectangle in plot coordinates. NW and NH should have the same ratio as the image that is copied to the rectangle. The default rectangle is the full page.

I M G T P R

The routine IMGTPR defines a transparency colour for copying image pixels to memory. Pixels that have the same colour as the colour defined by IMGTPR are not copied to memory.

The call is:	CALL IMGTPR (NCLR)	level 1, 2, 3
or:	void imgtpr (int nclr);

NCLR	is a colour value. If NCLR = -1, the transparency colour will be ignored. Default: NCLR = -1

R I M A G E

The routine RIMAGE copies an image from memory to a file.

The call is:	CALL RIMAGE (CFIL)	level 1, 2, 3
or:	void rimage (const char *cfil);

CFIL	is the name of the output file. A new file version will be created for existing files (see FILMOD).

Additional notes:

• Images are stored with an ASCII header of 80 bytes length followed by the binary image data.
• A single image file can be displayed with the routine WIMAGE or with the utility program DISIMG. A sequence of image files can be displayed with the utility program DISMOV.

The routine WIMAGE copies an image from a file to memory.

The call is:	CALL WIMAGE (CFIL)	level 1, 2, 3
or:	void wimage (const char *cfil);

CFIL	is the name of the input file.

R T I F F

The routine RTIFF copies an image from memory to a file. The image is stored in the device-independent TIFF format.

The call is:	CALL RTIFF (CFIL)	level 1, 2, 3
or:	void rtiff (const char *cfil);

CFIL	is the name of the output file. A new file version will be created for existing files (see FILMOD).

Additional notes:

• This image format can be used to export images created with DISLIN into other software packages or to transfer them to other computer systems.
• A TIFF file created by DISLIN can be displayed with the routine WTIFF or with the utility program DISTIF.

The routine WTIFF copies a TIFF file created by DISLIN from a file to memory.

The call is:	CALL WTIFF (CFIL)	level 1, 2, 3
or:	void wtiff (const char *cfil);

CFIL	is the name of the input file.

Additional note:

• The position of the TIFF file and a clipping window can be defined with the routines TIFORG and TIFWIN.

The routine TIFORG defines the upper left corner of the screen where the TIFF file is copied to.

The call is:	CALL TIFORG (NX, NY)	level 1, 2, 3
or:	void tiforg (int nx, int ny);

NX, NY

is the upper left corner in screen coordinates.

T I F W I N

The routine TIFWIN defines a clipping window of the TIFF file that can be copied with the routine WTIFF to the screen.

The call is:	CALL TIFWIN (NX, NY, NW, NH)	level 1, 2, 3
or:	void tifwin (int nx, int ny, int nw, int nh);

NX, NY	is the upper left corner of the clipping window in pixels.
NW, NH	are the width and height of the clipping window in pixels.

R G I F

The routine RGIF copies an image from memory to a GIF file.

The call is:	CALL RGIF (CFIL)	level 1, 2, 3
or:	void rgif (const char *cfil);

CFIL	is the name of the output file. A new file version will be created for existing files (see FILMOD).

R P N G

The routine RPNG copies an image from memory to a PNG file.

The call is:	CALL RPNG (CFIL)	level 1, 2, 3
or:	void rpng (const char *cfil);

CFIL	is the name of the output file. A new file version will be created for existing files (see FILMOD).

R B F P N G

The routine RBFPNG copies an image from memory as a PNG file to a buffer.

The call is:	CALL RBFPNG (CBUF, NMAX, N)	level 1, 2, 3
or:	int rbfpng (char *cbuf, int nmax);

CBUF	is a character buffer where the image is copied to in PNG format.
NMAX	defines how many bytes can be copied to CBUF. If NMAX = 0, the size of the PNG file is returned in N without copying the PNG file to CBUF.
N	is the returned length of the buffer. N <= 0, if an error occurs.

R P P M

The routine RPPM copies an image from memory to a PPM file.

The call is:	CALL RPPM (CFIL)	level 1, 2, 3
or:	void rppm (const char *cfil);

CFIL	is the name of the output file. A new file version will be created for existing files (see FILMOD).

R B M P

The routine RBMP copies an image from memory to a BMP file.

The call is:	CALL RBMP (CFIL)	level 1, 2, 3
or:	void rbmp (const char *cfil);

CFIL	is the name of the output file. A new file version will be created for existing files (see FILMOD).

E X P I M G

The routine EXPIMG copies an image from memory to a file.

The call is:	CALL EXPIMG (CFIL, COPT)	level 1, 2, 3
or:	void expimg (const char *cfil, const char *copt);

CFIL	is the name of the output file. A new file version will be created for existing files (see FILMOD).
COPT	defines the file format and can have the values 'PS', 'PDF', 'PNG', 'GIF', 'TIFF', 'PPM' and 'BMP'.

Additional note:

• For the options 'PNG', 'GIF', 'TIFF', 'PPM' and 'BMP', EXPIMG has the same meaning as the routines RPNG, RGIF, RTIFF, RPPM, and RBMP.

I M G C L P

The routine IMGCLP defines a clipping region for the routines RTIFF, RGIF, RPNG, RPPM and RBMP for copying the graphics window to an output file.

The call is:	CALL IMGCLP (NX, NY, NW, NH)	level 1, 2, 3
or:	void imgclp (int nx, int ny, int nw, int nh);

NX, NY	is the upper left corner of the rectangle in pixels.
NW, NH	are the width and height of the rectangle in pixels.

P D F B U F

The routine PDFBUF copies a PDF file from memory to a user buffer. The routine must be called after DISFIN and PDF buffer output must be enabled with the statement CALL PDFMOD ('ON', 'BUFFER') before DISINI.

The call is:	CALL PDFBUF (CBUF, NMAX, N)	level 1, 2, 3
or:	int pdfbuf (char *cbuf, int nmax);

CBUF	is a character buffer where the PDF file is copied to.
NMAX	defines how many bytes can be copied to CBUF. If NMAX = 0, the size of the PDF file is returned in N without copying the PDF file to CBUF.
N	is the returned length of the buffer. N <= 0, if an error occurs.

L D I M G

The routine LDIMG loads an PNG, BMP, GIF or TIFF image from a file into an array. RapidEye satellite TIFF images are also supported by LDIMG.

The call is:	CALL LDIMG (CFIL, IRAY, NMAX, NC, N)	level 0, 1, 2, 3
or:	int ldimg (const char *cfil, unsigned short *iray, int nmax, int nc);

CFIL	is a character string that contains the filename.
IRAY	is an INTEGER*2 array containing the image data after the call to LDIMG.
NMAX	is the number of elements in IRAY. If NMAX = 0, just the needed number of elements is returned in the variable N.
NC	is the channel number. Normally, the red components are returned for NC = 1, the green values for NC = 2 and the blue values for NC = 3. RapidEye TIFF images contain 5 channels. If NC = 0, all channels are returned, stored after each other in IRAY. For NC = -1, the image is packed as byte values in IRAY. Three bytes contain the RGB values of a pixel.
N	is the returned number of elements used in IRAY.

9.10 Transparency

T P R I N I

The routine TPRINI initializes transparency. All following plotting output until TPRFIN is going to a separate frame buffer.

The call is:	CALL TPRINI	level 1, 2, 3
or:	void tprini (void);

T P R F I N

The routine TPRFIN terminates transparency. The separate frame buffer is mixed with the real frame buffer by using alpha blending.

The call is:	CALL TPRFIN	level 1, 2, 3
or:	void tprfin (void);

T P R V A L

The routine TPRVAL defines the alpha value.

The call is:	CALL TPRVAL (X)	level 1, 2, 3
or:	void tprval (float x);

X	is a floating point value in the range from 0.0 to 1.0, where 0.0 means a fully transparent colour and 1.0 means a fully opaque colour. Default: 1.0

The following program code plots three circles with alpha blending:

      CALL TPRVAL(0.5)
      CALL COLOR('RED')
      CALL TPRINI 
      CALL CIRCLE(500,500,500)
      CALL TPRFIN

      CALL COLOR('GREEN')
      CALL TPRINI 
      CALL CIRCLE(750,750,500)
      CALL TPRFIN

      CALL COLOR('BLUE')
      CALL TPRINI 
      CALL CIRCLE(1000,500,500)
      CALL TPRFIN

The routine TPRMOD defines additional options for transparency.

The call is:	CALL TPRMOD (CMOD, CKEY)	level 1, 2, 3
or:	void tprmod (const char *cmod, const char *ckey);

CMOD

is a character string defining an option.

CKEY

is a character string that can have the values 'BACK' and 'FIGURE'. For CKEY = 'BACK', the parameter CMOD can have the values 'OPAQUE' and 'NOOPAQUE'. 'OPAQUE' means that a transparent figure maybe mixed with the background colour black or white. 'NOOPAQUE' means that the background colour is defined as fully transparent. The elementary figures in DISLIN such as circles, rectangles and polygons contain already a TPRINI/TPRFIN environment that can be enabled with the key 'FIGURES' and the mode 'AUTO'. Default: ('OPAQUE', 'BACK'), ('NOAUTO', 'FIGURES').

The example above can also be written as:

     
      CALL TPRVAL(0.5)
      CALL TPRMOD('AUTO','FIGURES')
      CALL COLOR('RED')
      CALL CIRCLE(500,500,500)

      CALL COLOR('GREEN')
      CALL CIRCLE(750,750,500)

      CALL COLOR('BLUE')
      CALL CIRCLE(1000,500,500)

9.11 Using Threads

The routine THRINI initializes threads. THRINI must be called before any other DISLIN routine.

The call is:	CALL THRINI (N)	level 0
or:	void thrini (int n);

N	is the number of threads that are used by the program.

T H R F I N

The routine THRFIN terminates threads. THRFIN should be called after any other DISLIN routine.

The call is:	CALL THRFIN	level 0
or:	void thrfin (void);

9.12 Reading FITS Files

F I T S O P N

The routine FITSOPN opens a FITS file for reading.

The call is:	CALL FITSOPN (CFILE, ISTAT)	level 0, 1, 2, 3
or:	int fitsopn (const char *cfile);

CFILE	is a character string containing the file name.
ISTAT	is the returned status (0: no errors).

F I T S C L S

This routine closes a FITS file that was opened before with FITSOPN.

The call is:	CALL FITSCLS	level 0, 1, 2, 3
or:	void fitscls (void);

F I T S H D U

The routine FITSHDU selects the FITS Header/Data Unit for the following FITS operations.

The call is:	CALL FITSHDU (NHDU, IRET)	level 0, 1, 2, 3
or:	int fitshdu (int nhdu);

NHDU	defines the current FITS HDU (≥ 1).
IRET	is the returned type of the HDU: 0: Primary HDU 1: Image Extension 2: ASCII Table Extension 3: Binary Table Extension IRET = -1 means that the HDU does not exist.

F I T S T Y P

FITSTYP returns the type of a key.

The call is:	CALL FITSTYP (CKEY, ITYP)	level 0, 1, 2, 3
or:	int fitstyp (const char *ckey);

CKEY	is a character string containing the key.
ITYP	is the returned type. The possible types are: 0: Integer number 1: Float number 2: Null string 3: String 4: Logical True 5: Logical False 6: Complex Integer 7: Complex Float 8: Undefined ITYP = -1 means that the key could not be found in the FITS file.

F I T S V A L

The routine FITSVAL returns the integer value of a key. Some of the required keys in FITS files are:

NAXIS    the number of data axes
NAXISi   the length of axis i, where 1 <= i <= n
BITPIX   the number of  bits per data pixel.

The call is:	CALL FITSVAL (CKEY, IVAL)	level 0, 1, 2, 3
or:	int fitsval (const char *ckey);

CKEY	is a character string containing the key.
IVAL	is the returned integer value.

F I T S F L T

FITSFLT returns the floatingpoint value of a key.

The call is:	CALL FITSFLT (CKEY, XVAL)	level 0, 1, 2, 3
or:	float fitsflt (const char *ckey);

CKEY	is a character string containing the key.
XVAL	is the returned floatingpoint value.

F I T S S T R

FITSSTR returns the string value of a key.

The call is:	CALL FITSSTR (CKEY, CVAL, NMAX)	level 0, 1, 2, 3
or:	void fitsstr (const char *ckey, char *cval, int nmax);

CKEY	is a character string containing the key.
CVAL	is the returned string value.
NMAX	is the maximal number of bytes that can be copied to CVAL.

F I T S I M G

The routine FITSIMG copies the image data of a FITS file to a byte array.

The call is:	CALL FITSIMG (IRAY, NMAX, N)	level 0, 1, 2, 3
or:	int fitsimg (unsigned char *iray, int nmax);

IRAY	is a byte array containing the returned image pixels.
NMAX	defines how many bytes can be copied to IRAY. If NMAX = 0, the necessary number of bytes is returned in N without copying the image data.
N	is the returned number of images bytes.

9.13 Plotting the new MPS Logo

M P S L O G O

The routine MPSLOGO plots the new MPS logo.

The call is:	CALL MPSLOGO (NX, NY, NSIZE, COPT)	level 1, 2, 3
or:	void mpslogo (int nx, int ny, int nsize, const char *copt);

NX, NY	defines the position of the MPSLOGO (upper left corner, plot coordinates).
NSIZE	defines the size of the MPSLOGO. NSIZE cam have the pixel values 100, 125, 150, 175, 200 and 300.
COPT	is a character option that can have the values 'NOTEXT' and 'TEXT'.

Additional note:

• The MPS logo is included as a bitmap file into a DISLIN graphics where the corresponding bitmap files are not included in a DISLIN distribution. They must be copied separately to the subdirectory mps in the DISLIN directory.