Classes

Section Classes

class RegistrationList

RegistrationList (EbvListSection)

Class for handling Registrations.

Examples

# Load Registration File
pynebv.registration.load("/path/to/input_file", "Registration")
# Add Measurement
measurement_1 = pynebv.registration.add_measurement("Threshold")
# Add ROI
measurement_1.add_roi((342.8,314.68), 0.0, '0 degree')
measurement_1.add_roi((338.72,314.68), 0.0, '0 degree')
# Save Registration File
pynebv.registration.save("/path/to/output_file", "Registration")
# Clear
pynebv.registration.clear()

Ancestors

Methods

def add_measurement(mode='Threshold')

Add measurement point.

Args

mode : str

type detail: str: 'Threshold', 'Correlation', 'Symmetry' or 'CD'

Specify mode.

Returns

EbvItem
Return new measurement point.
def clear()

Delete all registration results.

Returns

none
Always none.
def load(filePath, /, format='Unknown')

Create registrations from file.

Args

filePath : str

Specify file path.

format : str

type detail: str: 'Unknown', 'Registration' or 'PROVE XML'

Specify format. 'Unknown' indicates the format will be automatically detected.

Returns

none
Always none.
def save(filePath, format, /, itemList=[])

Save registrations.

Args

filePath : str

Specify file path.

format : str

type detail: str: 'Registration', 'PROVE XML' or 'Matching Template'

Specify format.

itemList : list[EbvItem]

type detail: list[EbvItem]: list of EbvItem or EbvItemList

Specify target items.

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.

Inherited members

Item Classes

class RegistrationListItem

RegistrationListItem (EbvItem)

Ancestors

Subclasses

Inherited members

class RegistrationMeasurement

RegistrationMeasurement (RegistrationListItem)

Class representing Measure Point of Registration.

Ancestors

Methods

def add_roi(point, angle, /, type='0 degree')

Add ROI.

Args

point : tuple[float, float]

Specify coordinate.

angle : float

Specify angle.

type : str

type detail: str: '0 degree', '90 degree', '45 degree', '135 degree', 'Box', 'Any', 'Edge', '2D Figure', '2D Area', '2D Center' or 'Pattern Match'

Specify type.

Returns

EbvItemList
Return new ROIs.
def delete()

Delete an item.

Returns

none
Always none.
def set_current()

Specify for the target measurement.

Returns

none
Always none.

Inherited members

class RegistrationRoi

RegistrationRoi (RegistrationListItem)

Class representing ROI of Registration.

Ancestors

Methods

def delete()

Delete an item.

Returns

none
Always none.

Inherited members