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

Signature

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

Wrapper around COM video-bitmap info.

Attributes

NameSummary
nameInfo-object name.
texture_columnsNumber of columns in a stitched combined-file image.
texture_coordinatesTexture coordinates for scan points.
texture_countNumber of stitched video bitmaps.
texture_rowsNumber of rows in a stitched combined-file image.
typeInfo-object type identifier.

name

Info-object name.

texture_columns

Number of columns in a stitched combined-file image.

texture_coordinates

Texture coordinates for scan points.

texture_count

Number of stitched video bitmaps.

texture_rows

Number of rows in a stitched combined-file image.

type

Info-object type identifier.

Methods

NameSummary
__init__Initialize self. See help(type(self)) for accurate signature.
get_3d_video_offsetGet the video-position offset in 3D coordinates.
get_imageReturn a PIL.Image.Image object for the bitmap.
get_image_rectGet the image rectangle in video coordinates.
get_video_offsetGet the video-position offset in video coordinates.
image_bytesReturn image bytes and dimensions.
load_image_fileLoad an image from the given file.
saveCommit changes to the underlying file.
set_imageSet the image from an array of bytes.

__init__

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

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

get_3d_video_offset

def sdynpy.fileio.sdynpy_psv.VideoBitmap.get_3d_video_offset(self) -> 'Any'

Get the video-position offset in 3D coordinates.

get_image

def sdynpy.fileio.sdynpy_psv.VideoBitmap.get_image(self) -> 'Image.Image'

Return a PIL.Image.Image object for the bitmap.

get_image_rect

def sdynpy.fileio.sdynpy_psv.VideoBitmap.get_image_rect(self) -> 'Any'

Get the image rectangle in video coordinates.

get_video_offset

def sdynpy.fileio.sdynpy_psv.VideoBitmap.get_video_offset(self) -> 'Any'

Get the video-position offset in video coordinates.

image_bytes

def sdynpy.fileio.sdynpy_psv.VideoBitmap.image_bytes(self, fmt: 'GraphicFormatType' = <GraphicFormatType.BITMAP: 0>) -> 'tuple[bytes, int, int]'

Return image bytes and dimensions.

Parameters

Returns

load_image_file

def sdynpy.fileio.sdynpy_psv.VideoBitmap.load_image_file(self, file_name: 'str') -> 'None'

Load an image from the given file.

save

def sdynpy.fileio.sdynpy_psv.VideoBitmap.save(self) -> 'None'

Commit changes to the underlying file.

set_image

def sdynpy.fileio.sdynpy_psv.VideoBitmap.set_image(self, image_bytes: 'bytes') -> 'None'

Set the image from an array of bytes.