This page applies to Harlequin v13.1r0 and later; both Harlequin Core and Harlequin MultiRIP
This procset provides image file support procedures for rendering from native BMP, JPEG, JFIF, JPEG2000, PNG, and TIFF files.
The HqnImage procset contains several functions that can be used, in sequence, to process certain formats of image directly in the RIP without the need to convert them into another PDL.
The functions and the sequence of calling are as follows:
HqnImageSetImageDefaults
| Amends the default options set for future calls to HqnImage
. Takes a dictionary of configuration options as an argument. This means that the defaults may be set at RIP boot time, or in a TestConfig
or Page Feature
; they will then be applied to TIFF files submitted as jobs in their own right rather than needing a PostScript control file to be constructed for each one.
|
analyseimage
| Checks that the file stream is valid and that it is possible to open the image context. It takes three arguments:
- The image file to process which can be either the file name or a file object.
- A dictionary of configuration items (Optional).
- An array of file types to process, as names, or null (Required). Supported file types are currently
/BMP
, /PNG
, /JPEG
, /JPEG2000
, /TIFF
and /WMPHOTO
. If the file submitted is not one of those listed in the array, analyseimage
will return false
. It returns true
if the file exists and the image context can be opened; otherwise, it will return false
. A value of null
means to accept all image file types.
|
analyzeimage
| From Harlequin 13, analyzeimage
is available as a synonym of analyseimage
.
|
getimagedetails
| Returns a dictionary of image parameters. It takes no arguments but assumes analyseimage
has been called immediately before to setup the name of the image file to be processed. It returns a dictionary of image data and true
if it succeeds or false
if it fails.
Note:
After getimagedetails
and before runimage
, it is possible to setup and adjust images as required for media size, orientation and so on, but the new configuration options in Harlequin 13 mean that this will not normally be necessary.
|
runimage
| Process the image. Takes one argument, a dictionary of configuration items, and assumes analyseimage
and getimagedetails
have been run.
|
onepassrunimage
| Available from Harlequin 13. Combines analyseimage
, getimagedetails
and runimage
into a single call. It takes the same three arguments as analyseimage
.
|