Classes
class CalculationList-
CalculationList (EbvListSection)
Class for handling Calculations.
Examples
# Open a figure file. figure = pynebv.file.open('/path/to/sample.oas') # Calculate the density of a region. density = pynebv.calculation.density((0,0,100,100))Ancestors
Methods
def clear()-
Delete all calculation results.
Returns
none- Always none.
def density(area, /, name='', keepArea=True)-
Calculate density.
Args
area:tuple[float, float, float, float]-
Specify calculation area.
name:str-
Specify name of result item.
keepArea:bool-
Specify whether not to shrink to boundary box.
Returns
EbvItem- Return an item of density result.
def density_by_areafile(filePath)-
Calculate density from Area File.
Args
filePath:str-
Specify file path of Area File.
Returns
none- Always none.
def density_map(area, /, name='', mesh={'size': [100.0, 100.0], 'overlap': 0.0, 'originType': 'Selected Area Lower-Left', 'clipType': 'Overhang'})-
Calculate density map.
Args
area:tuple[float, float, float, float]-
Specify calculation area.
name:str-
Specify name of result item.
mesh:dict-
Specify mesh settings.
"size" : tuple[float, float]
Specify the size of the mesh."overlap" : float
Specify the overlap of the mesh."originType" : str: 'Selected Area Lower-Left' or '(0, 0)'
Specify the origin type of the mesh."clipType" : str: 'Overhang', 'Clip' or 'Overlap'
Specify the clip type of the mesh.
Returns
EbvItem- Return an item of density map result.
def density_map_by_areafile(filePath)-
Calculate density map from Area File.
Args
filePath:str-
Specify file path of Area File.
Returns
none- Always none.
def figure_count(area, /, name='')-
Calculate figure count.
Args
area:tuple[float, float, float, float]-
Specify calculation area.
name:str-
Specify name of result item.
Returns
EbvItem- Return an item of figure count result.
def figure_count_by_areafile(filePath)-
Calculate figure count from Area File.
Args
filePath:str-
Specify file path of Area File.
Returns
none- Always none.
def figure_count_map(area, /, name='', mesh={'size': [100.0, 100.0], 'overlap': 0.0, 'originType': 'Selected Area Lower-Left', 'clipType': 'Overhang'})-
Calculate figure count map.
Args
area:tuple[float, float, float, float]-
Specify calculation area.
name:str-
Specify name of result item.
mesh:dict-
Specify mesh settings.
"size" : tuple[float, float]
Specify the size of the mesh."overlap" : float
Specify the overlap of the mesh."originType" : str: 'Selected Area Lower-Left' or '(0, 0)'
Specify the origin type of the mesh."clipType" : str: 'Overhang', 'Clip' or 'Overlap'
Specify the clip type of the mesh.
Returns
EbvItem- Return an item of figure count map result.
def figure_count_map_by_areafile(filePath)-
Calculate Figure Count Map from Area File.
Args
filePath:str-
Specify file path of Area File.
Returns
none- Always none.
def save(filePath, /, type='All Calculations', format='Text')-
Save calculation results.
Args
filePath:str-
Specify file path.
type:str-
type detail: str: 'Density', 'Sliver Count', 'Shot Count', 'Figure Count', 'Vertex Count', 'Density Map', 'Figure Count Map', 'Vertex Count Map' or 'All Calculations'
Specify calculation type to save.
format:str-
type detail: str: 'Text' or 'Csv'
Specify output file format.
Returns
none- Always none.
def shot_count(area, /, name='', size=[0.35, 0.35])-
Calculate shot count.
Args
area:tuple[float, float, float, float]-
Specify calculation area.
name:str-
Specify name of result item.
size:tuple[float, float]-
Specify shot size.
Returns
EbvItem- Return an item of shot count result.
def shot_count_by_areafile(filePath)-
Calculate shot count from Area File.
Args
filePath:str-
Specify file path of Area File.
Returns
none- Always none.
def sliver_count(area, /, name='', rowRange={'min': 0.0, 'max': 0.2}, rowStep=0.01, colRange={'min': 0.0, 'max': 0.2}, colStep=0.04, printType='Short Edge')-
Calculate sliver count.
Args
area:tuple[float, float, float, float]-
Specify calculation area.
name:str-
Specify name of result item.
rowRange:dict-
Specify range of figure height or short edge when displaying as histogram.
"min" : float
Specify the minimum value."max" : float
Specify the maximum value. rowStep:float-
Specify bin size of figure height or short edge when displaying as histogram.
colRange:dict-
Specify range of figure width or long edge when displaying as histogram.
"min" : float
Specify the minimum value."max" : float
Specify the maximum value. colStep:float-
Specify bin size of figure width or long edge when displaying as histogram.
printType:str-
type detail: str: 'Short Edge', 'Short Edge (Cumulative)', 'Long Edge', 'Long Edge (Cumulative)', 'Matrix Short / Long', 'Matrix Short / Long (Cumulative)', 'Matrix Y / X' or 'Matrix Y / X (Cumulative)'
Specify print type of histogram.
Returns
EbvItem- Return an item of sliver count result.
def sliver_count_by_areafile(filePath)-
Calculate sliver count from Area File.
Args
filePath:str-
Specify file path of Area File.
Returns
none- Always none.
def sort_by_column(column, sortAscending)-
Sort by column.
Args
column:int-
Specify an index number of column.
sortAscending:bool-
Specify whether to sort in ascending order.
Returns
none- Always none.
def vertex_count(area, /, name='')-
Calculate vertex count.
Args
area:tuple[float, float, float, float]-
Specify calculation area.
name:str-
Specify name of result item.
Returns
EbvItemList- Return an item of vertex count result.
def vertex_count_by_areafile(filePath)-
Calculate vertex count from Area File.
Args
filePath:str-
Specify file path of Area File.
Returns
none- Always none.
def vertex_count_map(area, /, name='', mesh={'size': [100.0, 100.0], 'overlap': 0.0, 'originType': 'Selected Area Lower-Left', 'clipType': 'Overhang'})-
Calculate vertex count map.
Args
area:tuple[float, float, float, float]-
Specify calculation area.
name:str-
Specify name of result item.
mesh:dict-
Specify mesh settings.
"size" : tuple[float, float]
Specify the size of the mesh."overlap" : float
Specify the overlap of the mesh."originType" : str: 'Selected Area Lower-Left' or '(0, 0)'
Specify the origin type of the mesh."clipType" : str: 'Overhang', 'Clip' or 'Overlap'
Specify the clip type of the mesh.
Returns
EbvItemList- Return an item of vertex count map result.
def vertex_count_map_by_areafile(filePath)-
Calculate vertex count from Area File.
Args
filePath:str-
Specify file path of Area File.
Returns
none- Always none.
Inherited members
class CalculationListItem-
CalculationListItem (EbvItem)
Ancestors
Subclasses
Inherited members
class Calculation-
Calculation (CalculationListItem)
Class representing calculation result.
Ancestors
Subclasses
Instance variables
var area : tuple[float, float, float, float]-
Area of item.
var name : str-
Name of item.
Methods
def delete()-
Delete an item.
Returns
none- Always none.
Inherited members
class Density-
Density (Calculation)
Class representing Density.
Ancestors
Inherited members
class SliverCount-
SliverCount (Calculation)
Class representing Sliver Count.
Ancestors
Inherited members
class ShotCount-
ShotCount (Calculation)
Class representing Shot Count.
Ancestors
Inherited members
class FigureCount-
FigureCount (Calculation)
Class representing Figure Count.
Ancestors
Inherited members
class VertexCount-
VertexCount (Calculation)
Class representing Vertex Count.
Ancestors
Inherited members
class DensityMap-
DensityMap (Calculation)
Class representing Density Map.
Ancestors
Inherited members
class FigureCountMap-
FigureCountMap (Calculation)
Class representing Figure Count Map.
Ancestors
Inherited members
class VertexCountMap-
VertexCountMap (Calculation)
Class representing Vertex Count Map.
Ancestors
Inherited members