[Artwork] / [QisMLib] / [Programmer's Corner]

RTCRClient (QisM)

RTCRClient (QisM)Command-line and usage{JOB} (atleast ONE required) :=+job:{input_gdsii_file_path},{output_dir_path}[-dpi:{dpix}[,{dpiy}] | -pixelsize:{sizex}[,{sizey}]][-correction:{correction_file_path}[,{tolerance}][-annotation:{annotation_file_path}][-invertimage][-shift:INS_WHITE | -shift:INS_BLACK | -shift:REMOVE][-colshift:{col_px},...{col_px}]*[-rowshift:{row_px},...{row_px}]*[-graylayers:{grey_level},{layer_list}][-tiff:packbits | -tiff:packbits64 | -tiff:bmp | -tiff:raw | -tiff:none][-right-to-left][-mask:{minx},{miny},{maxx},{maxy}][-thrnum:{n_threads}][-tile:{minx},{miny},maxpt:{maxx},{maxy}]*[-tile:{minx},{miny},tilesz:{width},{height}]*[-tile:{minx},{miny},tilebuf:{size_mb}]*[-autotiles:{roi_minx},{roi_miny},{roi_maxx},{roi_maxy},ntiles:{nx},{ny}][-autotiles:{roi_minx},{roi_miny},{roi_maxx},{roi_maxy},tilesz:{width},{height}][-origin:LL | -origin:LR | -origin:UL | -origin:UR][-direction:up | -direction:down | -direction:left | -direction:right][-only:{tile_num}[,{tile_num}]*[-subsample | -subsample:{recipe}][-dbg]@{cmd_file_path}{Misc.} (OPTIONAL) :=[-log:{log_path}] | [-log+:{log_path}][-silent]CORRECTION FILE SYNTAXANNOTATION FILE SYNTAXDependenciesWIN64

Command-line and usage


xxxxxxxxxx
qmrtcrclient64.exe {JOB}+ [{MISC}]
  -- OR --
qmrtcrclient64.exe @{cmd_file_path} [{MISC}]

`{JOB}` (atleast ONE required) :=

`+job:{input_gdsii_file_path},{output_dir_path}`

MANDATORY argument. Indicates the start of a new job
{input_gdsii_file_path} is the path to a valid GDSII file with units = um (microns) and grid = 0.001 (1 nm resolution)
{output_dir_path} is the path to a valid and writable directory. The directory MUST exist

`[-dpi:{dpix}[,{dpiy}] | -pixelsize:{sizex}[,{sizey}]]`

Specify the image resolution in dots-per-inch OR pixel-size in file units (um).
The second parameter is optional. If specified, the image can have non-square pixels (different resolution along X and Y)
Default: resolution is set to pixel-size of 1.0 file unit (um) along X and Y

`[-correction:{correction_file_path}[,{tolerance}]`

Apply corrections to the source data before rasterization
{correction_file_path} is the path of a valid correction file
{tolerance} is the margin of error when applying corrections
See CORRECTION FILE SYNTAX below for file syntax
Default: The source data is used as is

`[-annotation:{annotation_file_path}]`

Add alpha-numeric annotations to the source data in form of text-like boundaries before rasterization
{annotation_file_path} is the path of a valid annotation file
See ANNOTATION FILE SYNTAX below for file syntax
Default: The source data is used as is

`[-invertimage]`

Invert the image polarity (image background is black (set), data is white (reset))
Default: image background is white (reset), data is black (set)

`[-shift:INS_WHITE | -shift:INS_BLACK | -shift:REMOVE]`

Add/remove 1-px row/column lines to the raster image at specific pixel locations
INS_WHITE : insert white line(s) at specific pixel rows/columns
INS_BLACK : insert black line(s) at specific pixel rows/columns
REMOVE : remove lines at specific pixel rows/columns
Default : No lines added/removed
INS_WHITE, INS_BLACK are not affected by image polarity (-invertimage) or gray level (-graylayers)
See -colshift, -rowshift

`[-colshift:{col_px},...{col_px}]*`

Specify a list of comma-separated column numbers to add/remove 1-px lines
The column numbers are in pixel space (post rasterization)
See -shift:

`[-rowshift:{row_px},...{row_px}]*`

Specify a list of comma-separated row numbers to add/remove 1-px lines
The row numbers are in pixel space (post rasterization)
See -shift:

`[-graylayers:{grey_level},{layer_list}]`

Specify a list of layers to be rasterized with dithering using a 8x8 bayer matrix
{grey_level} is the dithering value (0.0 - 1.0). 0.0 = all scratched, 1.0 = all paint
{layer_list} is a comma-separated list of layer(s) or layer:datatype(s) e.g 1,2:0,3:1,3:3. If datattype is missing, all datatypes for the specified layer are used
The remaining layers will be rasterized with dither value of 1.0
Gray layers will be rasterized BEFORE the other layers and therefore get overwritten in areas of overlap
Appearance of the dithered areas is subject to image polarity (-invertimage)
Default: All layers are rasterized at dither = 1.0

`[-tiff:packbits | -tiff:packbits64 | -tiff:bmp | -tiff:raw | -tiff:none]`

Specify output file format
packbits = compressed TIFF. packbits64 generates BigTIFF format for files larger than 4GB
bmp = uncompressed BMP
raw = uncompressed dump of the image buffer with a small header. The format of the raw file is as follows: 7 bytes [0..6] (identifier): 'L''G''R''A''W''0''0' 4 bytes [7..10] (width in pixels) 4 bytes [11..14] (height in pixels) 8 bytes [15..22] (pixel data size in bytes) (pixel data)
Default: -tiff:packbits

`[-right-to-left]`

Reverse the direction of rasterization along rows. min-x point (leftmost) in data space would correspond to max-x point in image space (rightmost)
Default: left-to-right. min-x point (leftmost) in data space would correspond to min-x point in image space (leftmost)

`[-mask:{minx},{miny},{maxx},{maxy}]`

Specify the region of the data (in file units) to be preserved while the rest of it is scratched off
{minx}..{maxy} are the extents of the data to be preserved in the image
masking is applied against the extents of the view cell. Therefore any data within the view cell NOT inside {minx}..{maxy} will be scratched
scratched pixel = background pixel (depending on image polarity)
Images whose data extents lie completely within the masked area are NOT affected
Default: No masking. The image contains all the data within it's extents

`[-thrnum:{n_threads}]`

Specify the number of threads to be used for various operations such as corrections, rasterization, shifting, formatting etc.
Default: 0 = no. of cpu(s) in the system

`[-tile:{minx},{miny},maxpt:{maxx},{maxy}]*`

Specify the extents of a 'tile' (window of data) to be rasterized
{minx}..{maxy} are in file units (um)
-tile:, -autotile: can be specified multiple times

`[-tile:{minx},{miny},tilesz:{width},{height}]*`

Specify the extents of a 'tile' (window of data) to be rasterized
{minx},{miny} represents the lower-left point of the tile while {width} {height} are the dimensions (>0.0)
{minx},{miny},{width},{height} are in file units (um)
-tile:, -autotile: can be specified multiple times

`[-tile:{minx},{miny},tilebuf:{size_mb}]*`

Specify the extents of a 'tile' (window of data) to be rasterized
{minx},{miny} represents the lower-left point of the tile (in file units) while {size_mb} is the estimated buffer size in mb (1024*1024 bytes) to hold the raster image
The computed tile is a square (width == height)
-tile:, -autotile: can be specified multiple times

`[-autotiles:{roi_minx},{roi_miny},{roi_maxx},{roi_maxy},ntiles:{nx},{ny}]`

Generate a set of equal sized tiles from a region of interest {roi_minx}..{roi_maxy} based on the number of tiles along x,y
{nx} >= 1, {ny} >= 1. {roi_minx}..{roi_maxy} are in file units (um)
The generated tiles can be ordered in a certain way. See -origin, -direction
-tile:, -autotile: can be specified multiple times

`[-autotiles:{roi_minx},{roi_miny},{roi_maxx},{roi_maxy},tilesz:{width},{height}]`

Generate a set of equal sized tiles from a region of interest {roi_minx}..{roi_maxy} based on the tile size {width},{height} (all in file units)
The generated tiles can be ordered in a certain way. See -origin, -direction
-tile:, -autotile: can be specified multiple times

`[-origin:LL | -origin:LR | -origin:UL | -origin:UR]`

Control the order in which auto-tiles are rasterized by specifying the location of the first tile. LL = lower-left, LR = lower-right, UL = upper-left, UR = upper right
Default: LL
See -direction

`[-direction:up | -direction:down | -direction:left | -direction:right]`

Control the order in which auto-tiles are rasterized by specifying the direction in which to progress after the first tile
LL (left = up, right = down), LR (right = up, left = down), UL (left = down, right = up), UR (right = down, left = up)
Default: left
See -origin

`[-only:{tile_num}[,{tile_num}]*`

Select which of the specified tiles will be rasterized. The rest will be ignored
1 <= {tile_num} <= (total no. tiles)
Default: All the specified tiles will be rasterized [-keep:{tile_num}[,{tile_num}]*
Select which of the specified tiles will be formatted and written to disk. The rest will be rasterized but not written
1 <= {tile_num} <= (total no. tiles)
Default: All the specified tiles will be formatted and written to disk
See -tiff:

`[-subsample | -subsample:{recipe}]`

Down-size the raster image 2x before writing to disk
{recipe} if specified, is a string of exactly 16 1's and 0's constituting the sub-sampling recipe. See here for details

`[-dbg]`

Keep temporary files and logs for diagnosis and troubleshooting
Default: temporary files are deleted once the job is complete

`@{cmd_file_path}`

Another way of specifying one or more jobs by simply specifying the same command-line arguments for {JOB}+ in a text file, one argument per line

{Misc.} (OPTIONAL) :=

`[-log:{log_path}] | [-log+:{log_path}]`

Enable logging by specifying the path where the log file will be created
-log: will create a new file while -log+: will append to an existing file
Default: No log file is created

`[-silent]`

DO NOT write messages to stdout/stderr (run silently)
Default: Write progress and updates to stdout and error/warnings to stderr

CORRECTION FILE SYNTAX

A correction file consists of multiple correction-sets
Each correction-set is represented by FOUR correction-points
Each correction-point consists of a reference point (from the original file) and X and Y deltas to be applied to this reference point to compute the corresponding corrected point in the corrected file
The X, Y and delta values are in the user units (file units), separated by comma (and space)
Empty lines are not allowed

Correction definition syntax:=


xxxxxxxxxx
${REF_X}, ${REF_Y}, ${DELTA_X}, ${DELTA_Y}
${REF_X}, ${REF_Y}, ${DELTA_X}, ${DELTA_Y}
${REF_X}, ${REF_Y}, ${DELTA_X}, ${DELTA_Y}
${REF_X}, ${REF_Y}, ${DELTA_X}, ${DELTA_Y}

where REF_X and REF_Y represent one anchor point in the un-corrected source data and DELTA_X and DELTA_Y represents the corrected position of the anchor point
four anchor points form a single domain
more than one domain can be specified
the domains CANNOT overlap
all values specified in file units

Sample correction file with SIX domains


xxxxxxxxxx
13549.987, 14300, 1000, 1000
159250.012, 14300, 1000, 1000
159250.012, 250700.012, 1000, 1000
13549.987, 250700.012, 1000, 1000
172249.987, 14300, 0, 0
242750.012, 14300, 0, 0
242750.012, 250700.012, 0, 0
172249.987, 250700.012, 0, 0
255749.987, 14300, 0, 0
401450.012, 14300, 0, 0
401450.012, 250700.012, 0, 0
255749.987, 250700.012, 0, 0
9500, 264750, 0, 0
162499.999, 264749.999, 0, 0
162500, 495250, 0, 0
9500, 495250, 0, 0
162499.999, 264749.999, 0, 0
252500, 264750, 0, 0
252499.999, 495249.999, 0, 0
162500, 495250, 0, 0
255749.987, 495700.012, 0, 0
401450.012, 495700.012, 0, 0
401450.012, 259300, 0, 0
255749.987, 259300, 0, 0

ANNOTATION FILE SYNTAX

A text annotation file can define multiple text annotations
Each text annotation definition starts with a B_TEXT_ANNOTATION keyword, followed by a set of properties and ends with a E_TEXT_ANNOTATION keyword
Every keyword or property must be separated from another keyword/property by a new-line
Lines that start with a # are treated as a comment and therefore ignored
Empty lines can occur anywhere and are ignored
Individual items on a single line (property fields) can be separated by tabs or spaces or even a mix of tabs and spaces
Order in which the properties are defined is irrelevant
All measurements of length are in millimeters (MM)
Following properties are mandatory:
- BOX : Extents of box that encloses the text. The width and height of the text are adjusted so that it fits inside the box after the transformations (rotation, inverse) and margin have been applied. If specified, BOX overrides HEIGHT and XY
- HEIGHT : Height of the text annotation (in MM) including all the lines of
  text in it. This along with XY can be used instead of BOX. If HEIGHT is used, XY must also be specified
- XY : Co-ordinates of the anchor point in MM. This along with HEIGHT can be used instead of BOX. If XY is used, HEIGHT must also be specified
- B_TEXT ... E_TEXT : Text string. Can be multi-line
Following properties are optional :
- ROTATION : Orientation of the text box. Defaults to 0 degrees
- INVERSE : If YES, text is scratched out of a solid box. If NO, text is painted inside an empty box. Defaults to NO
- MARGIN : Amount of separation between the text and the enclosing box. Defaults to 0 MM
- SCALE : Uniform scaling to be applied to the text box. Defaults to 1.0
- FRAME : Add a frame around the text. Defaults to NO
- READING : If BACKWARDS, mirror the text about X. If NORMAL, no mirroring is applied. Defaults to NORMAL

Text annotation definition


xxxxxxxxxx
B_TEXT_ANNOTATION
# Use a BOX to specify text position :
BOX ${MINX_MM} ${MINY_MM} ${MAXX_MM} ${MAXY_MM}
# Or, use HEIGHT and XY to specify text position :
XY ${X_MM} ${Y_MM}
HEIGHT ${HEIGHT_MM}
ROTATION ${DEGREES}
SCALE ${SCALE}
INVERSE ${'YES' | 'NO'}
FRAME ${'YES' | 'NO'}
MARGIN ${MARGIN_MM}
READING ${'NORMAL' | 'BACKWARDS'}
B_TEXT
${LINE1}
${LINE2}
...
${LINEN}
E_TEXT
E_TEXT_ANNOTATION

Sample text annotation file with THREE annotations


xxxxxxxxxx
B_TEXT_ANNOTATION
BOX 497.246 22.6962 511.977 28.6294
ROTATION 0
INVERSE NO
MARGIN 0.2
FRAME YES
B_TEXT
TEXT_1
E_TEXT
E_TEXT_ANNOTATION
B_TEXT_ANNOTATION
XY 33.5472 581.419
HEIGHT 15
B_TEXT
TEXT_2
E_TEXT
E_TEXT_ANNOTATION
B_TEXT_ANNOTATION
BOX 548.973 313.895 597.668 326.325
ROTATION 90
INVERSE YES
MARGIN 0.01
READING BACKWARDS
B_TEXT
TEXT_3 IS
MULTI -
LINE
E_TEXT
E_TEXT_ANNOTATION

Dependencies

WIN64

qismlib64.dll
acsbool64.dll
zlibwapi.dll
qismraster64.dll
anncorr64.dll
acs_txt_annot64.dll
gdxout64.dll
gdxin64.dll
gunzip_mt.dll
gscan.exe
sffcorrection64.exe
colfill.pat
gdsfont.shx
annotation.shx
barcode39.shx
qmrtcr.cfg
acs.key

ARTWORK CONVERSION SOFTWARE, INC.

417 Ingalls St. Unit C, Santa Cruz, CA 95060 831.426.6163 email: info@artwork.com

RTCRClient (QisM)

Command-line and usage

{JOB} (atleast ONE required) :=

+job:{input_gdsii_file_path},{output_dir_path}

[-dpi:{dpix}[,{dpiy}] | -pixelsize:{sizex}[,{sizey}]]

[-correction:{correction_file_path}[,{tolerance}]

[-annotation:{annotation_file_path}]

[-invertimage]

[-shift:INS_WHITE | -shift:INS_BLACK | -shift:REMOVE]

[-colshift:{col_px},...{col_px}]*

[-rowshift:{row_px},...{row_px}]*

[-graylayers:{grey_level},{layer_list}]

[-tiff:packbits | -tiff:packbits64 | -tiff:bmp | -tiff:raw | -tiff:none]

[-right-to-left]

[-mask:{minx},{miny},{maxx},{maxy}]

[-thrnum:{n_threads}]

[-tile:{minx},{miny},maxpt:{maxx},{maxy}]*

[-tile:{minx},{miny},tilesz:{width},{height}]*

[-tile:{minx},{miny},tilebuf:{size_mb}]*

[-autotiles:{roi_minx},{roi_miny},{roi_maxx},{roi_maxy},ntiles:{nx},{ny}]

[-autotiles:{roi_minx},{roi_miny},{roi_maxx},{roi_maxy},tilesz:{width},{height}]

[-origin:LL | -origin:LR | -origin:UL | -origin:UR]

[-direction:up | -direction:down | -direction:left | -direction:right]

[-only:{tile_num}[,{tile_num}]*

[-subsample | -subsample:{recipe}]

[-dbg]

@{cmd_file_path}