[Artwork] / [QisMLib]

QisMHExtract Extension

Welcome to the reference page for QisMHExtract, an extension of QisMLib, Artwork Conversion's CAD processing framework.

QisMHExtract carves a smaller layout out of a larger one. Starting from a chip or board design that has already been loaded into the framework, it takes a chosen cell, a chosen set of layers, and optionally a set of clipping regions, and produces a new GDSII or OASIS file, the two standard formats for storing chip layouts, that contains only that portion of the design. Unlike a simple flatten-and-cut, the output keeps the original cell hierarchy intact, so the extracted file stays compact and easy to work with. It has three jobs:

  1. Extract a view of the design to a new file on disk, or hand the extracted shapes to your own program piece by piece as they are produced.

  2. Clip and filter along the way. Clipping regions can be boxes, polygons, or circles, and can be inverted to keep everything outside them. Options control what happens to shapes that straddle a clipping edge, whether text labels are kept, whether hierarchy is flattened, which cell references are kept or dropped by name, and how tiny leftover slivers are discarded.

  3. Transform and rename the result, for example by shifting, scaling, rotating, or mirroring the output, renaming cells with a prefix or suffix, or offsetting layer numbers, and optionally loading the extracted file straight back into the framework as a new database.

This page is the complete reference for the extension. Here is what you will find, in the order it appears:

If you only need to cut a region out of a file, the script commands are the quickest route. If you are using the API into your own software, start with the C++ programming interface.

QisMHExtract ExtensionQisMHExtract C++ API (qismhextract.h)QisMHExtractFlags ClipModeFileFormatQisMHExtractUpdateVersion Control (QisMHExtractUpdate)On_extract_refreshQisMHExtractTargetVersion Control (QisMHExtractTarget)On_extract_beginOn_extract_begin_cellOn_extract_boundaryOn_extract_pathOn_extract_textOn_extract_srefOn_extract_arefOn_extract_end_cellOn_extract_endQisMHExtractClipper_pQisMHextractRegionsVersion Control (QisMHextractRegions)ResetConsolidateAdd_boxAdd_polygonAdd_circleComplementQisMHExtractOptsVersion Control (QisMHExtractOpts)ResetCopy_fromSet_flattenGet_flattenSet_clip_modeGet_clip_modeSet_textGet_textSet_path_to_boundaryGet_path_to_boundarySet_sliverGet_sliver_valueGet_sliver_areaSet_extracted_nameGet_extracted_nameSet_only_refsGet_only_refsSet_drop_refsGet_drop_refsGet_drop_refs_allSet_post_transformGet_post_translate_xGet_post_translate_yGet_post_scaleGet_post_angleGet_post_flipYGet_post_transformSet_cellname_modGet_cellname_prefixGet_cellname_suffixQisMHExtractOptsV2Set_layer_offsetGet_layer_offsetGet_dttp_offsetQisMHExtractorVersion Control (QisMHExtractor)Get_last_error_msg (QisMHExtractor)Get_last_error_code (QisMHExtractor)Create_clipperCreate_box_clipperCreate_poly_clipperCreate_circ_clipperDestroy_clipperCreate_file_writerDestroy_file_writerExtractQisMHExtractorV2Get_extract_reportQisMHExtractorV3File_dbQisMHExtractFileVersion Control (QisMHExtractFile)File_dbGet_last_error_msg (QisMHExtractFile)Get_last_error_code (QisMHExtractFile)Save_asQisMHExtractVersion Control (QisMHExtract)Get_last_error_msg (QisMHExtract)Get_last_error_code (QisMHExtract)New_objectDelete_objectCreate_extractorDestroy_extractorQisMHExtractDbOptsParamType Version Control (QisMHExtractDbOpts)Set_paramGet_paramResetCopyCloneQisMHExtractV2Create_dbDestroy_dbQisMHextract Commandshextract.create_extractorhextract.destroy_extractorhextract.create_optshextract.destroy_optshextract.create_regionshextractregions.addhextract.destroy_regionshextractor.extract_to_writerhextractor.extract_to_filehextract.create_dbhextractfile.save_ashextract.destroy_dbhextract.select_dbuQisMHExtract Licensing (API)QisMHExtract Licensing (SCRIPT)QisMHExtract Version Historyqismhextract dll/so v1.7.2 10-2024qismhextract dll/so v1.7.1 10-2024qismhextract dll/so v1.7 04-2023qismhextract dll/so v1.6.1 05-2020qismhextract dll/so v1.6 02-2020qismhextract dll/so v1.5 01-2020qismhextract dll/so v1.4 06-2019qismhextract dll/so v1.3 03-2019qismhextract dll/so v1.2 06-2018qismhextract dll/so v1.1 04-2018qismhextract dll/so v1.0 03-2018


QisMHExtract C++ API (qismhextract.h)

QisMHExtractFlags

Various enumerated constants relevant to QisMHExtract

ClipMode

Represents the clipping mode

FileFormat

Output file format types

QisMHExtractUpdate

Interface to a callback handler to get updates during extraction

Version Control (QisMHExtractUpdate)

Cast to a pointer of another version in the class hierarchy (base/derived)

On_extract_refresh

Opportunity for the client to refresh (update progress, handle events etc.)

QisMHExtractTarget

Interface to a client (or a file writer) that will receive the data being extracted

Version Control (QisMHExtractTarget)

Cast to a pointer of another version in the class hierarchy (base/derived)

On_extract_begin

Signals the start of the extraction where filedb is a handle to the source db

On_extract_begin_cell

Indicates the beginning of a cell definition during extraction

On_extract_boundary

Indicates that a boundary is being added (extracted) to the current cell definition

On_extract_path

Indicates that a path is being added (extracted) to the current cell definition

On_extract_text

Indicates that a text is being added (extracted) to the current cell definition

On_extract_sref

Indicates that a single cell reference is being added (extracted) to the current cell definition

On_extract_aref

Indicates that an arrayed cell reference is being added (extracted) to the current cell definition

On_extract_end_cell

Indicates the end of a cell definition during extraction

On_extract_end

Indicates the end of extraction

QisMHExtractClipper_p

Opaque handle to an internal object that is responsible for clipping vector data

QisMHextractRegions

An object to specify a set of clipping regions (boxes, polygons or circles)

Version Control (QisMHextractRegions)

Cast to a pointer of another version in the class hierarchy (base/derived)

Reset

Clear all the clipping regions

Consolidate

Clear unused memory allocated to store clipping regions

Add_box

Add a box (orthogonal rectangle) to the set of clipping regions

Add_polygon

Add a closed polygon to the set of clipping regions

Add_circle

Add a circle to the set of clipping regions (to be converted to a polygon)

Complement

Compute the complement of the clipping regions w.r.t the extents of the view cell

QisMHExtractOpts

An object to specify various extraction options

Version Control (QisMHExtractOpts)

Cast to a pointer of another version in the class hierarchy (base/derived)

Reset

Reset to default values

Copy_from

Clone settings from another object

Set_flatten

Get_flatten

Flatten the output

Set_clip_mode

Get_clip_mode

Clipping mode

Set_text

Get_text

Extract TEXT data

Set_path_to_boundary

Get_path_to_boundary

Convert all paths to boundaries

Set_sliver

Get_sliver_value

Get_sliver_area

Filter tiny boundaries

Set_extracted_name

Get_extracted_name

Name of the extracted cell

Set_only_refs

Get_only_refs

Only extract refs that match atleast one of the specified regular expressions (dos-like) and immediate child of the view cell

  • Default: Extract all refs

Set_drop_refs

Get_drop_refs

Get_drop_refs_all

Drop references to the specified cells (via regular expressions)

Set_post_transform

Get_post_translate_x

Get_post_translate_y

Get_post_scale

Get_post_angle

Get_post_flipY

Get_post_transform

Transform the final output

Set_cellname_mod

Get_cellname_prefix

Get_cellname_suffix

Add a prefix and/or suffix to every cellname in the output

QisMHExtractOptsV2

Extension to QisMHExtractOpts for offsetting the output layers

Set_layer_offset

Get_layer_offset

Get_dttp_offset

Set/Get offsets for ALL layers in the output

QisMHExtractor

Interface to a single instance of the extractor

Version Control (QisMHExtractor)

Cast to a pointer of another version in the class hierarchy (base/derived)

Get_last_error_msg (QisMHExtractor)

Get_last_error_code (QisMHExtractor)

Get error message/code for the last error condition

Create_clipper

Create an instance of the clipper object from a set of regions

Create_box_clipper

Create an instance of the clipper object from a single box

Create_poly_clipper

Create an instance of the clipper object from a single polygon

Create_circ_clipper

Create an instance of the clipper object from a single circle

Destroy_clipper

Destroy an instance of the clipper object

Create_file_writer

Destroy_file_writer

Create/Destroy a GDSII/OASIS file writer as the target for extracted data

Extract

Perform a single extraction

QisMHExtractorV2

Extension v2 for QisMHExtractor

Get_extract_report

Get a human readable summary of the last call to QisMHExtractor::Extract

QisMHExtractorV3

Extension v3 for QisMHExtractor

File_db

Get a handle to the linked file db

QisMHExtractFile

Represents a database created by loading a newly extracted file

Version Control (QisMHExtractFile)

Cast to a pointer of another version in the class hierarchy (base/derived)

File_db

Get the underlying QisMFile database

Get_last_error_msg (QisMHExtractFile)

Get_last_error_code (QisMHExtractFile)

Get information about an error condition

Save_as

Make a copy of the underlying file at the specified oas_output_path

QisMHExtract

Interface to the QisMHExtract extension API

Version Control (QisMHExtract)

Cast to a pointer of another version in the class hierarchy (base/derived)

Get_last_error_msg (QisMHExtract)

Get_last_error_code (QisMHExtract)

Get error message/code for the last error condition

New_object

Delete_object

Create an instance of a data object (MUST be eventually destroyed using Delete_object())

Create_extractor

Destroy_extractor

Create an instance of the extractor

  • Requires 1 license of QISMCODE_HEXTRACT.

QisMHExtractDbOpts

Represents a set of options for creating a database from an extracted file

ParamType

Parameter types for Set_param(..) and Get_param(..)

Version Control (QisMHExtractDbOpts)

Cast to a pointer of another version in the class hierarchy (base/derived)

Set_param

Get_param

Reset

Reset all paramters to default values

Copy

Copy settings from another object

Clone

Make a clone of the current settings object

QisMHExtractV2

Extension 2 for QisMHExtract

Create_db

Create a new database from an extract of the source database

Destroy_db

Destroy an extracted database

QisMHextract Commands

hextract.create_extractor

hextract.destroy_extractor

hextract.create_opts

hextract.destroy_opts

hextract.create_regions

hextractregions.add

hextract.destroy_regions

hextractor.extract_to_writer

hextractor.extract_to_file

hextract.create_db

hextractfile.save_as

hextract.destroy_db

hextract.select_dbu

QisMHExtract Licensing (API)

Product name: QisMHExtract License code: 11083

BEGINEND
Create_extractorDestroy_extractor
OPERATION
Create_db

QisMHExtract Licensing (SCRIPT)

Product name: QisMHExtract License code: 11083

BEGINEND
hextract.create_extractorhextract.destroy_extractor
OPERATION
hextract.create_db

QisMHExtract Version History

qismhextract dll/so v1.7.2 10-2024

qismhextract dll/so v1.7.1 10-2024

qismhextract dll/so v1.7 04-2023

qismhextract dll/so v1.6.1 05-2020

qismhextract dll/so v1.6 02-2020

qismhextract dll/so v1.5 01-2020

qismhextract dll/so v1.4 06-2019

qismhextract dll/so v1.3 03-2019

qismhextract dll/so v1.2 06-2018

qismhextract dll/so v1.1 04-2018

qismhextract dll/so v1.0 03-2018


ARTWORK CONVERSION SOFTWARE, INC.
509 N. Sepulveda Blvd. Suite 201 Manhattan Beach, CA 90266  tel: 831.426.6163  email: info@artwork.surf

Last Updated -- Thu Oct 1 17:49:39 UTC 2026