Classes

Section Classes

class FileList

FileList (EbvListSection)

Class for handling various shape files and their layers.

Examples

# Open a figure file.
chip = pynebv.file.open('/path/to/sample.oas', opts={"mag": "2.0,4.0", "bold":"L0:0=on", "cellline":"on", "layer":"0,1,3", "rotate":"90", "color":"L0:0=red,L1:1=#ff0000"})
# Close the file.
chip.close()

Ancestors

Methods

def open(filePath, /, opts={})

Open a file.

Args

filePath : str

Specify file path.

opts : dict[str, str]

Specify additional information. The following items can be specified.

"bold" : str: [<layer|chipname>=]<on|off>[,<>…]
    Specify whether to draw the outline of the shape in bold.

"casette" : str: <file path|none>
    Specify casette pattern file to display for a jobdeck.

"cellline" : str: <on|off>
    Specify whether to show Cell Line.

"chipline" : str: <on|off>
    Specify whether to show Chip Line.

"color" : str: [<layer|chipname>=]<html color name|hex color code>[,<>…]
    Specify color.

"display" : str: <on|off>
    Specify whether to show on the screen.

"dose-index" : str: <on|off>
    Specify whether to show Dose Index.

"dose-table" : str: <file path>
    Specify Dose Table File.

"fade" : str: [<layer|chipname>=]<on|off>[,<>…]
    Specify whether to fade.

"hatch" : str: [<layer|chipname>=]<hatch>[,<>…]
    Specify hatch pattern.

"layer" : str: <layer>[,<layer>…]
    Specify layers.

"layer-title" : str: <Jobdeck 'Title' name>
    Specify Title name for display name of jobdeck layer.

"mag" : str: <x,y>
    Specify magnification.

"mirror" : str: <off|x|y|xy>
    Specify mirroring.

"move" : str: <x,y>
    Specify offset [um].

"origin" : str: <in|c|ll|lr|ul|ur>
    Specify origin point.

"paint-type" : str: [<layer|chipname>=]<both|paint|outline|none>[,<>…]
    Specify paint type.

"pellicle" : str: <file path|none>
    Specify pellicle pattern file to display for a jobdeck.

"rev-chip" : str: <chip in jobdeck name>[,<>…]
    Specify chip name in a jobdeck to reverse.

"rev-pattern" : str: <chip in jobdeck filename>[,<>…]
    Specify chip filename in a jobdeck to reverse.

"reverse" : str: <on|off>
    Specify whether to reverse.

"root" : str: <strname>
    Use specified structure and cell as the root of hierarchy.

"rotate" : str: <0|90|180|270>
    Specify rotation.

"size" : str: <sx,sy,ex,ey>
    Overwrite chip area of file to load [um].

Returns

EbvItem
Return an opened file.
def reload(onlyModified=False)

Reload files.

Args

onlyModified : bool

Specify whether to reload only changed files.

Returns

none
Always none.

Inherited members

Item Classes

class FileListItem

FileListItem (EbvItem)

Examples

# Print all the file list items.
file_list_items = pynebv.file.items()
for item in file_list_items:
  print(item.display_name + ": " + str(type(item)) + ": " + str(item.props()))

Ancestors

Subclasses

Instance variables

var bold : bool

Whether to draw the outline of the shape in bold.

var display_name : str

Display name.

var fade : bool

Whether to fade the fill color or not.

var hatch : str

str: 'Solid', 'Horizontal', 'Cliff B', 'Slant A', 'Slope B', 'Vertical', 'Slope A', 'Slant B', 'Cliff A', 'Fog', 'Horizontal Dot', 'Cliff Dot B', 'Slant Dot A', 'Slope Dot B', 'Vertical Dot', 'Slope Dot A', 'Slant Dot B', 'Cliff Dot A', 'Haze', 'Step', 'Honeycomb' or 'Blank'

Hatch pattern for filling shapes.

Methods

def reset_color()

Reset the color of figure in screen to startup color.

Returns

none
Always none.
def reset_style()

Reset the drawing style of figure in screen to startup drawing style.

Returns

none
Always none.

Inherited members

class File

File (FileListItem)

Class responding shape file.

Ancestors

Subclasses

Instance variables

var area : tuple[float, float, float, float]

Chip size or figure existence area.

var au : float

Address unit.

var cell_line_is_visible : bool

Whether to show Cell Line.

var chip_line_is_visible : bool

Whether to show Chip Line.

var dose_index_is_visible : bool

Whether to show Dose Index.

var file_path : str

Source file path.

var file_size : int

Source file size.

var mag : tuple[float, float]

Magnification factor of shape (width, height).

var mirror : str

str: 'Off', 'X', 'Y' or 'XY'

Mirroring setting of shape.

var move : tuple[float, float]

Position of the shape's origin using coordinates (e.g., 100, 100).

var origin : str

str: 'Data Inside', 'Center', 'Lower-Left', 'Lower-Right', 'Upper-Left', 'Upper-Right' or 'Other'

Position of the shape's origin using named location (e.g., Data Inside, Center).

var outline : bool

Whether to draw the outline of the shape or not.

var paint : bool

Whether to fill the shape or not.

var rotate : str

str: '0', '90', '180' or '270'

Rotation setting of shape (angle in degrees).

Methods

def apply_dose_table(on)

Specify whether to apply dose table when displaying dose index.

Args

on : bool

Specify True or False.

Returns

none
Always none.
def close()

Close a file.

Returns

none
Always none.
def load_dose_table(filePath)

Load dose table.

Args

filePath : str

Specify file path of dose table.

Returns

none
Always none.

Inherited members

class Layer

Layer (FileListItem)

Class responding layer in file.

Ancestors

Subclasses

Instance variables

var name : str

Name of item.

var outline : bool

Whether to draw the outline of the shape or not.

var paint : bool

Whether to fill the shape or not.

Inherited members

class Chip

Chip (File)

Class representing chip.

Examples

# Find out if there is a specific layer within every chip.
search_layno="8:8"
files = pynebv.file.list()
for file in files:
  if type(file) is not pynebv.Chip:
    print(file.display_name + " is not a Figure File.")
    continue
  layers = file.layers(search_layno)
  if len(layers) > 0:
    print("layno: " + search_layno + " exists at " + file.display_name + ".")
  else:
    print("layno: " + search_layno + " DOES NOT exist " + file.display_name + ".")

Ancestors

Instance variables

var reverse : bool

Reverse the negative and positive of the shape.

Methods

def layer(searchLayno='', searchName='')

Get a layer which is match with condition.

Args

searchLayno : str

Specify layer no as "layer-no[:data-type]."

searchName : str

Specify name to search. This allows matching patterns commonly seen in file names, like using '*'.

Returns

EbvItem
Return found item.
def layers(searchLayno='', searchName='')

Return all layers which are match with condition.

Args

searchLayno : str

Specify layer no as "layer-no[:data-type]."

searchName : str

Specify name to search. This allows matching patterns commonly seen in file names, like using '*'.

Returns

EbvItemList
Return found items.

Inherited members

class TopCell

TopCell (FileListItem)

Class representing topcell.

Ancestors

Instance variables

var area : tuple[float, float, float, float]

Area of item.

var cell_line_is_visible : bool

Whether to show Cell Line.

var chip_line_is_visible : bool

Whether to show Chip Line.

var dose_index_is_visible : bool

Whether to show Dose Index.

var name : str

Name of item.

var outline : bool

Whether to draw the outline of the shape or not.

var paint : bool

Whether to fill the shape or not.

Methods

def layer(searchLayno='', searchName='')

Get a layer which is match with condition.

Args

searchLayno : str

Specify layer no as "layer-no[:data-type]."

searchName : str

Specify name to search. This allows matching patterns commonly seen in file names, like using '*'.

Returns

EbvItem
Return found item.
def layers(searchLayno='', searchName='')

Return all layers which are match with condition.

Args

searchLayno : str

Specify layer no as "layer-no[:data-type]."

searchName : str

Specify name to search. This allows matching patterns commonly seen in file names, like using '*'.

Returns

EbvItemList
Return found items.

Inherited members

class ChipLayer

ChipLayer (Layer)

Class representing layer in chip.

Ancestors

Inherited members

class Jobdeck

Jobdeck (File)

Class representing jobdeck file.

Examples

# Find out if there is a specific layer within every jobdeck.
search_layno="Layer 1"
files = pynebv.file.list()
for file in files:
  if type(file) is not pynebv.Jobdeck:
    print(file.display_name + " is not a Jobdeck.")
    continue
  layers = file.layers(search_layno)
  if len(layers) > 0:
    print("layno: " + search_layno + " exists at " + file.display_name + ".")
  else:
    print("layno: " + search_layno + " DOES NOT exist " + file.display_name + ".")

Ancestors

Methods

def layer(searchName='')

Get a layer which is match with condition.

Args

searchName : str

Specify name to search. This allows matching patterns commonly seen in file names, like using '*'.

Returns

EbvItem
Return found item.
def layers(searchName='')

Return all layers which are match with condition.

Args

searchName : str

Specify name to search. This allows matching patterns commonly seen in file names, like using '*'.

Returns

EbvItemList
Return found items.

Inherited members

class JobdeckLayer

JobdeckLayer (Layer)

Class representing layer in jobdeck.

Ancestors

Inherited members

class JobdeckTitle

JobdeckTitle (FileListItem)

Class representing title in jobdeck.

Ancestors

Instance variables

var area : tuple[float, float, float, float]

Chip size or figure existence area.

var au : float

Address unit.

var file_path : str

Source file path.

var file_size : int

Source file size.

var mag : tuple[float, float]

Magnification factor of shape (width, height).

var mirror : str

str: 'Off', 'X', 'Y' or 'XY'

Mirroring setting of shape on the specified axis.

var move : tuple[float, float]

Position of the shape's origin using coordinates (e.g., 100, 100).

var outline : bool

Whether to draw the outline of the shape or not.

var paint : bool

Whether to fill the shape or not.

var placement_area : tuple[float, float, float, float]

Placement area in jobdeck.

var reverse : bool

Reverse the negative and positive of the shape.

var rotate : str

str: '0', '90', '180' or '270'

Rotation setting of shape (angle in degrees).

Inherited members

class JobdeckChip

JobdeckChip (FileListItem)

Class representing chip in jobdeck.

Ancestors

Instance variables

var area : tuple[float, float, float, float]

Chip size or figure existence area.

var au : float

Address unit.

var cell_line_is_visible : bool

Whether to show Cell Line.

var chip_line_is_visible : bool

Whether to show Chip Line.

var dose_index_is_visible : bool

Whether to show Dose Index.

var file_path : str

Source file path.

var file_size : int

Source file size.

var mag : tuple[float, float]

Magnification factor of shape (width, height).

var mirror : str

str: 'Off', 'X', 'Y' or 'XY'

Mirroring setting of shape on the specified axis.

var move : tuple[float, float]

Position of the shape's origin using coordinates (e.g., 100, 100).

var outline : bool

Whether to draw the outline of the shape or not.

var paint : bool

Whether to fill the shape or not.

var reverse : bool

Reverse the negative and positive of the shape.

var rotate : str

str: '0', '90', '180' or '270'

Rotation setting of shape (angle in degrees).

Inherited members

class OpenErrorFile

OpenErrorFile (File)

Class representing failed opening of a shape file.

Ancestors

Inherited members