OpenPHIGS

This repository is based on OpenPHIGS from

https://sourceforge.net/projects/phigs/files/

which is based on

https://www.x.org/archive/unsupported/lib/PHIGS

This distribution contains modifications and extensions which are needed for the purpose of data preservation in high energy physics. The code maturity level is pre-alpha, since it does not implement the full standard, neither for the C bindings, nor for Fortran.

Building

Run

make
make install

which will create and install the OpenPHIGS library, headers and tests in a new subdirectory called distrib. The install step will create a folder called distrib, including headers, binaries and libraries.

Switching between GLEW and Epoxy

Openphigs uses by default GLEW. Switching between GLEW and Epoxy is supported by configuring with -DUSE_GLEW=0. The Makefile checks for the environment variable NO_GLEW. If defined, it will use Epoxy, else GLEW. To switch to Epoxy, do

NO_GLEW=1 make

Switching between Xaw and Motif Widgets

By default, widgets will use Motif. To switch to Xaw, make sure that cmake is configure without the -DMotif switch. Take a look at the top level CMakeLists.txt file

Extensions

Some extensions have been implemented, specifically for the Fortran bindings, to support the DELPHI and OPAL event displays.

New Work station types 4 and 5

Work station types 4 (without double buffering) and 5 (with double buffering) take a screen shot when closed and write the screen shot as targa file to a file name.

Fortran bindings:

The second argument of popwk expects a non-zero integer which will be passed on as LUN.

• If a file name has been defined in the configuration file as %wf , the targa file will be created with this name in the current folder.
• If no file name has been defined in the configuration file as %wf fort. will be used.
• After opening the work station, the output file name can be set with a call to CALL PSFNAME(WKD, ) where filename can be the full path to the output

C bindings

• If a file name has been defined in the configuration file as %wf , the targa file will be created with this name in the current folder.
• If no file name has been defined in the configuraiton file, it defaults to "output.tga" and is created in the current directory.

Migration notes and extensions

Some notes on differences with respect to other implementations.

Workstation numbers

Workstation numbers can be in the range from 0 to 99.

Workstation types

• 0 PWST_OUTPUT_TRUE Output only on GL display
• 1 PWST_OUTIN_TRUE Input/Output on GL display
• 2 PWST_OUTPUT_TRUE_DB Output only on GL, buffered
• 3 PWST_OUTIN_TRUE_DB Input/Output on GL display, buffered
• 4 PWST_HCOPY_TRUE_TGA Hardcopy to file as TGA
• 5 PWST_HCOPY_TRUE_RGB_PNG Hardcopy to file as PNG RGB only
• 6 PWST_HCOPY_TRUE_RGBA_PNG Hardcopy to file as PNG with Alpha channel
• 7 PWST_HCOPY_TRUE_EPS Hardcopy to file as Encapsulated PostScript, no shaders
• 8 PWST_HCOPY_TRUE_PDF Hardcopy to file as PDF, no shaders
• 9 PWST_HCOPY_TRUE_SVG Hardcopy to file as SVG, no shaders
• 10 PWST_HCOPY_TRUE_OBJ Export geometry as OBJ

Notes:

• There is no support for PostScript at the moment.
• The hardcopy types are available in Fortran. C-Bindings have not been tested with them

Input devices

Openphigs behaviour on echo modes is summarized below.

String echo modes

• echo mode 1
  • opens a new window
  • echo area given in NC coordinates for the root window
• echo mode -1
  • echo area given in % relative to the main window

Valuator echo modes

• echo mode 1:
  • uses default strings for label, format low label and high label
  • opens a new window
  • echo area given in NC coordinates for the root window
• echo mode -1: As mode 1 but expects additional parameters as string, namely
  • label
  • format
  • low label
  • high label These should be encoded

Extensions:

• echo mode 2:
  • as echo mode 1 but places the window on top of the main window
  • echo area given as a fraction of the main window
• echo mode -2:
  • as echo mode -1 but places the window on top of the main window
  • echo area given as a fraction of the main window
• echo mode 3, -3:
  • as echo mode 2 but places the window on top of the main window
  • echo area given as a fraction of the main window
  • boxes the valuators up in one Window. (!) PPREC expects one integer for this echo mode which is the number of valuators to be boxed up

Choice echo modes

• echo mode 1:
  • opens a new window
  • echo area given in NC coordinates for the root window
• echo mode -1:
  • displays window on top of the root window
  • echo area is given as a fraction of the root window
• echo mode 3:
  • opens a new window
  • echo area given in NC coordinates for the root window
  • expects titels as strings
• echo mode -3:
  • as 3 but
  • echo area is given as a fraction of the root window
• echo mode 4:
  • as 3 but expects one more string
  • last string will be used as title
• echo mode -4:
  • as 4 but
  • echo area is given as a fraction of the root window

Transparency

PSALCH (DEPRECATED)

The ALPHA channel in a structure can be set with

CALL PSALCH(X)

where X is a floating point number between 0. (fully transparent) and 1. (fully opaque).

RGBA Color mode

This version supports colors with 4 components. To switch to this mode, use PMODEL_RGBA instead of PMODEL_RGB which is the default. This can be done via a call to PSCM(WKID, COLORMODE). Note that this call should be done directly after the workstation has been opened. Use

COLORMODE=0 for PINDIRECT COLORMODE=1 for PMODEL_RGB COLORMODE=2 for PMODEL_RGBA

Default colors

To pre-define some colors you can use

CALL PXSCM(WKID)

In COLORMODE=1 create 125 colors starting with index 16. Any colors with lower indices will not be touched. In COLORMODE=2 same as above. In addition, it will create 5 levels of transparent colors for all colors, with offset 200 with decreasing transparency. This is done as well for any existing colors with indices between 1 and 15.

Extensions

Fortran bindings

• PXNDEF(STRING NAME): set the configuration location and file name
• PXSHCSF(INTEGER IWK, REAL VALUE): Set hardcopy scale factor for workstation ID WKID. Must be set before the workstation is being opened.
• PXQHCSF(INTEGER IWK, REAL VALUE): Inquire the current scale factor for workstation ID WKID. The value is returned in the second argument.
• PSALCH(REAL VALUE): (deprecated) set ALPHA channel to Value. Value is between 0(fully transparent) and 1 (opaque). Added to the current structure.
• PSFNAME(INTEGER IWK, CHARACTER FNAME): set output file name for workstation ID IWK
• PXSCM(): Set color map

C-bindings

• pxset_conf_file_name(char* path): set the configuration location and file name
• pxset_conf_hcsf(int wkid, Pfloat value): Set hardcopy scale factor for workstation ID WKID. Must be set before the workstation is being opened
• Pfloat pxinq_conf_hcsf(int wkid): Inquire the current hardcopy scale factor for workstation ID WKID.
• pset_alpha_channel(float value): C-Binding for PSALCH. Added to the current structure.
• pxset_color_map(int wkid): set color map

Configuration file

By default, OpenPHIGS will look for a file named phigs.def in the current directly, and use it to apply default values. This is where you can set window names, backgrounds etc. Explanations can be found in the template shipped with the distribution.

Versions

• 0.0.1-1: Revised code from upstream
• 0.0.2-1: Implement additional extend C and Fortran bindings for CERN specific purposes
• v0.1-1: Fixes for exotic hardware
• v0.2-1: Introduce scale factor for hardcopies
• v0.2-2: Introduce additional functions to manage the scale factor programmatically
• v0.3-1: Add support for eps, svc, pdf and obj formatted hardcopies
• v0.3-2: C style fixings
• v0.3-3: test_f5 review, code improvements, clipping review
• V0.4-1: bug fixes, improve Wayland support, edge-cases on Mac and add support for a second clipping plane
• V0.5-1: Improved support for transparency