sdynpy.fileio.sdynpy_psv.Alignment3D

• Module: sdynpy.fileio.sdynpy_psv

• Source: GitHub

Signature¶

class sdynpy.fileio.sdynpy_psv.Alignment3D(obj: 'Any') -> 'None'

Wrapper around COM 3D alignment data and operations.

Attributes¶

align_3d_points¶

3D alignment points.

coord_definition_mode¶

Coordinate-definition mode for the 3D alignment.

current_quality¶

Current 3D alignment quality in meters.

mirror¶

Whether the 3D alignment was performed through a mirror.

scan_head_type¶

Scanning-head type.

target_quality¶

Target 3D alignment quality in meters.

valid¶

Whether the alignment is valid.

Methods¶

__init__¶

• Source: GitHub

def sdynpy.fileio.sdynpy_psv.Alignment3D.__init__(self, obj: 'Any') -> 'None'

Initialize self. See help(type(self)) for accurate signature.

calculate¶

• Source: GitHub

def sdynpy.fileio.sdynpy_psv.Alignment3D.calculate(self) -> 'None'

Calculate a new 3D alignment.

coord_3d_to_scanner¶

• Source: GitHub

def sdynpy.fileio.sdynpy_psv.Alignment3D.coord_3d_to_scanner(self, x: 'float', y: 'float', z: 'float') -> 'Any'

Convert 3D coordinates to scanner coordinates and distance.

get_beam_length¶

• Source: GitHub

def sdynpy.fileio.sdynpy_psv.Alignment3D.get_beam_length(self, x: 'float', y: 'float', z: 'float') -> 'float'

Retrieve beam length from the objective to the specified point.

get_beam_origin¶

• Source: GitHub

def sdynpy.fileio.sdynpy_psv.Alignment3D.get_beam_origin(self, scanner_x: 'float' = 0.0, scanner_y: 'float' = 0.0) -> 'Any'

Retrieve the beam origin at the second scanner mirror.

get_scan_head_position¶

• Source: GitHub

def sdynpy.fileio.sdynpy_psv.Alignment3D.get_scan_head_position(self) -> 'Any'

Retrieve the scan-head position at the first scanner mirror.

invalidate¶

• Source: GitHub

def sdynpy.fileio.sdynpy_psv.Alignment3D.invalidate(self) -> 'None'

Invalidate the current 3D alignment.

scanner_to_coord_3d¶

• Source: GitHub

def sdynpy.fileio.sdynpy_psv.Alignment3D.scanner_to_coord_3d(self, scanner_x: 'float', scanner_y: 'float', distance: 'float') -> 'Any'

Convert scanner coordinates and distance to 3D coordinates.

scanner_to_vector_3d¶

• Source: GitHub

def sdynpy.fileio.sdynpy_psv.Alignment3D.scanner_to_vector_3d(self, scanner_x: 'float', scanner_y: 'float') -> 'Any'

Convert scanner coordinates to a unit-direction vector.