Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

sdynpy.fileio.sdynpy_psv.Alignment2D

Signature

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

Wrapper around COM 2D alignment data and operations.

Attributes

NameSummary
align_2d_points2D alignment points.
scan_head_distanceDistance from the scan head front panel to the object, in meters.
scan_head_typeType of scanning head used for the alignment.
scanner_quantityPhysical quantity represented by the scanner coordinates.
validWhether the 2D alignment is valid.

align_2d_points

2D alignment points.

scan_head_distance

Distance from the scan head front panel to the object, in meters.

scan_head_type

Type of scanning head used for the alignment.

scanner_quantity

Physical quantity represented by the scanner coordinates.

valid

Whether the 2D alignment is valid.

Methods

NameSummary
__init__Initialize self. See help(type(self)) for accurate signature.
calculateCalculate a new 2D alignment.
get_cosine_correction_factorReturn the cosine-correction factor for the given scanner coordinates.
invalidateInvalidate the current 2D alignment and reset related properties.
scanner_to_videoConvert scanner coordinates to video coordinates.
video_to_scannerConvert video coordinates to scanner coordinates.

__init__

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

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

calculate

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

Calculate a new 2D alignment.

get_cosine_correction_factor

def sdynpy.fileio.sdynpy_psv.Alignment2D.get_cosine_correction_factor(self, scanner_x: 'float', scanner_y: 'float', vib_correct_x: 'bool', vib_correct_y: 'bool') -> 'float'

Return the cosine-correction factor for the given scanner coordinates.

invalidate

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

Invalidate the current 2D alignment and reset related properties.

scanner_to_video

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

Convert scanner coordinates to video coordinates.

video_to_scanner

def sdynpy.fileio.sdynpy_psv.Alignment2D.video_to_scanner(self, video_x: 'float', video_y: 'float') -> 'Any'

Convert video coordinates to scanner coordinates.