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.AlignmentCamera

Signature

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

Wrapper around COM camera-alignment data and operations.

Attributes

NameSummary
align_3d_points3D alignment points.
aspect_ratioVideo width-to-height aspect ratio.
cam_pos_xX coordinate of the camera position.
cam_pos_yY coordinate of the camera position.
cam_pos_zZ coordinate of the camera position.
cam_vec_xX coordinate of the camera view direction.
cam_vec_yY coordinate of the camera view direction.
cam_vec_zZ coordinate of the camera view direction.
current_qualityCurrent alignment quality.
mirrorWhether the object is viewed through a mirror.
target_qualityTarget alignment quality.
validWhether the current alignment is valid.
view_angleCamera aperture angle in degrees.
view_up_xX coordinate of the camera view-up direction.
view_up_yY coordinate of the camera view-up direction.
view_up_zZ coordinate of the camera view-up direction.

align_3d_points

3D alignment points.

aspect_ratio

Video width-to-height aspect ratio.

cam_pos_x

X coordinate of the camera position.

cam_pos_y

Y coordinate of the camera position.

cam_pos_z

Z coordinate of the camera position.

cam_vec_x

X coordinate of the camera view direction.

cam_vec_y

Y coordinate of the camera view direction.

cam_vec_z

Z coordinate of the camera view direction.

current_quality

Current alignment quality.

mirror

Whether the object is viewed through a mirror.

target_quality

Target alignment quality.

valid

Whether the current alignment is valid.

view_angle

Camera aperture angle in degrees.

view_up_x

X coordinate of the camera view-up direction.

view_up_y

Y coordinate of the camera view-up direction.

view_up_z

Z coordinate of the camera view-up direction.

Methods

NameSummary
__init__Initialize self. See help(type(self)) for accurate signature.
calculateCalculate camera parameters from input parameters and alignment points.
choose_camera_positionChoose a camera position to view the specified 3D points.
coord_3d_to_videoConvert 3D object coordinates to video coordinates.
scanner_to_videoConvert scanner coordinates to video coordinates.
set_cameraSet camera parameters.
video_to_coord_3dConvert video coordinates to 3D object coordinates.
video_to_scannerConvert video coordinates to scanner coordinates.

__init__

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

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

calculate

def sdynpy.fileio.sdynpy_psv.AlignmentCamera.calculate(self, *args: 'Any') -> 'Any'

Calculate camera parameters from input parameters and alignment points.

choose_camera_position

def sdynpy.fileio.sdynpy_psv.AlignmentCamera.choose_camera_position(self, *args: 'Any') -> 'Any'

Choose a camera position to view the specified 3D points.

coord_3d_to_video

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

Convert 3D object coordinates to video coordinates.

scanner_to_video

def sdynpy.fileio.sdynpy_psv.AlignmentCamera.scanner_to_video(self, *args: 'Any') -> 'Any'

Convert scanner coordinates to video coordinates.

set_camera

def sdynpy.fileio.sdynpy_psv.AlignmentCamera.set_camera(self, *args: 'Any') -> 'Any'

Set camera parameters.

video_to_coord_3d

def sdynpy.fileio.sdynpy_psv.AlignmentCamera.video_to_coord_3d(self, *args: 'Any') -> 'Any'

Convert video coordinates to 3D object coordinates.

video_to_scanner

def sdynpy.fileio.sdynpy_psv.AlignmentCamera.video_to_scanner(self, *args: 'Any') -> 'Any'

Convert video coordinates to scanner coordinates.