visbrain.objects.HypnogramObj.screenshot¶

HypnogramObj.screenshot(saveas, print_size=None, dpi=300.0, unit='centimeter', factor=None, region=None, autocrop=False, bgcolor=None, transparent=False, obj=None, line_width=1.0, **kwargs)[source]¶

Take a screeshot of the scene.

By default, the rendered canvas will have the size of your screen. The screenshot() method provides two ways to increase to exported image resolution :

Using print_size, unit and dpi inputs : specify the size of the image at a specific dpi level. For example, you might want to have an (10cm, 15cm) image at 300 dpi.

Using the factor input : multiply the default image size by this factor. For example, if you have a (1920, 1080) monitor and if factor is 2, the exported image should have a shape of (3840, 2160) pixels.

Parameters:

Parameters:	saveas : str The name of the file to be saved. This file must contains a extension like .png, .tiff, .jpg… print_size : tuple \| None The desired print size. This argument should be used in association with the dpi and unit inputs. print_size describe should be a tuple of two floats describing (width, height) of the exported image for a specific dpi level. The final image might not have the exact desired size but will try instead to find a compromize regarding to the proportion of width/height of the original image. dpi : float \| 300. Dots per inch for printing the image. unit : {‘centimeter’, ‘millimeter’, ‘pixel’, ‘inch’} Unit of the printed size. factor : float \| None If you don’t want to use the print_size input, factor simply multiply the resolution of your screen. region : tuple \| None Select a specific region. Must be a tuple of four integers each one describing (x_start, y_start, width, height). autocrop : bool \| False Automaticaly crop the figure in order to have the smallest space between the brain and the border of the picture. bgcolor : array_like/string \| None The background color of the image. transparent : bool \| False Specify if the exported figure have to contains a transparent background. obj : VisbrainObj \| None Pass a Visbrain object if you want to use the camera of an other object for the sceen rendering. kwargs : dict \| {} Optional arguments are passed to the VisbrainCanvas class.

saveas : str: The name of the file to be saved. This file must contains a extension like .png, .tiff, .jpg…
print_size : tuple | None: The desired print size. This argument should be used in association with the dpi and unit inputs. print_size describe should be a tuple of two floats describing (width, height) of the exported image for a specific dpi level. The final image might not have the exact desired size but will try instead to find a compromize regarding to the proportion of width/height of the original image.
dpi : float | 300.: Dots per inch for printing the image.
unit : {‘centimeter’, ‘millimeter’, ‘pixel’, ‘inch’}: Unit of the printed size.
factor : float | None: If you don’t want to use the print_size input, factor simply multiply the resolution of your screen.
region : tuple | None: Select a specific region. Must be a tuple of four integers each one describing (x_start, y_start, width, height).
autocrop : bool | False: Automaticaly crop the figure in order to have the smallest space between the brain and the border of the picture.
bgcolor : array_like/string | None: The background color of the image.
transparent : bool | False: Specify if the exported figure have to contains a transparent background.
obj : VisbrainObj | None: Pass a Visbrain object if you want to use the camera of an other object for the sceen rendering.
kwargs : dict | {}: Optional arguments are passed to the VisbrainCanvas class.