visiannot.visiannot.components.LogoWidgets

Summary

Module defining classes for creating a widget with a logo image on which it is possible to click on to activate an action

Data

visiannot.visiannot.components.LogoWidgets.MODULE_DIR

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Classes

visiannot.visiannot.components.LogoWidgets.FullVisiWidget(…)	Base class of widgets with a single image on which it is possible to click in order to activate an action
visiannot.visiannot.components.LogoWidgets.LogoWidget(…)	Base class of widgets with a single image on which it is possible to click in order to activate an action
visiannot.visiannot.components.LogoWidgets.NextWidget(…)	Base class of widgets with a single image on which it is possible to click in order to activate an action
visiannot.visiannot.components.LogoWidgets.PreviousWidget(…)	Base class of widgets with a single image on which it is possible to click in order to activate an action
visiannot.visiannot.components.LogoWidgets.ZoomInWidget(*args)	Base class of widgets for zoom (in / out)
visiannot.visiannot.components.LogoWidgets.ZoomOutWidget(*args)	Base class of widgets for zoom (in / out)
visiannot.visiannot.components.LogoWidgets.ZoomWidget(*args)	Base class of widgets for zoom (in / out)

API

Data

visiannot.visiannot.components.LogoWidgets.MODULE_DIR = '/home/docs/checkouts/readthedocs.org/user_builds/visiannot/checkouts/latest/visiannot/visiannot/components'

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.

Class FullVisiWidget

class visiannot.visiannot.components.LogoWidgets.FullVisiWidget(visi, widget_position, im_name, box_size=50)

Bases: visiannot.visiannot.components.LogoWidgets.LogoWidget

Base class of widgets with a single image on which it is possible to click in order to activate an action

Parameters

• visi – associated instance of ViSiAnnoT

• widget_position (tuple or list) – position of the widget in the layout of the associated instance of ViSiAnnoT

• im_name – file name of the image to display in the widget, it must be located in the folder Images next to the module

• box_size (int or tuple) – see keyword argument box_size of create_widget_logo()

Methods:

callback(visi)

Callback method for zooming out to the full temporal range

callback(visi)

Callback method for zooming out to the full temporal range

Parameters

visi – associated instance of ViSiAnnoT

Class LogoWidget

class visiannot.visiannot.components.LogoWidgets.LogoWidget(visi, widget_position, im_name, box_size=50)

Bases: object

Base class of widgets with a single image on which it is possible to click in order to activate an action

Parameters

• visi – associated instance of ViSiAnnoT

• widget_position (tuple or list) – position of the widget in the layout of the associated instance of ViSiAnnoT

• im_name – file name of the image to display in the widget, it must be located in the folder Images next to the module

• box_size (int or tuple) – see keyword argument box_size of create_widget_logo()

Methods:

callback()

Callback method called when the widged is cliked on, to be re-implemented in the child class

callback()

Callback method called when the widged is cliked on, to be re-implemented in the child class

Class NextWidget

class visiannot.visiannot.components.LogoWidgets.NextWidget(visi, widget_position, im_name, box_size=50)

Bases: visiannot.visiannot.components.LogoWidgets.LogoWidget

Base class of widgets with a single image on which it is possible to click in order to activate an action

Parameters

• visi – associated instance of ViSiAnnoT

• widget_position (tuple or list) – position of the widget in the layout of the associated instance of ViSiAnnoT

• im_name – file name of the image to display in the widget, it must be located in the folder Images next to the module

• box_size (int or tuple) – see keyword argument box_size of create_widget_logo()

Methods:

callback(visi)

Callback method for selecting next file in long recording

callback(visi)

Callback method for selecting next file in long recording

Parameters

visi – associated instance of ViSiAnnoT

Class PreviousWidget

class visiannot.visiannot.components.LogoWidgets.PreviousWidget(visi, widget_position, im_name, box_size=50)

Bases: visiannot.visiannot.components.LogoWidgets.LogoWidget

Base class of widgets with a single image on which it is possible to click in order to activate an action

Parameters

• visi – associated instance of ViSiAnnoT

• widget_position (tuple or list) – position of the widget in the layout of the associated instance of ViSiAnnoT

• im_name – file name of the image to display in the widget, it must be located in the folder Images next to the module

• box_size (int or tuple) – see keyword argument box_size of create_widget_logo()

Methods:

callback(visi)

Callback method for selecting previous file in long recording

callback(visi)

Callback method for selecting previous file in long recording

Parameters

visi – associated instance of ViSiAnnoT

Class ZoomInWidget

class visiannot.visiannot.components.LogoWidgets.ZoomInWidget(*args, zoom_factor=2)

Bases: visiannot.visiannot.components.LogoWidgets.ZoomWidget

Base class of widgets for zoom (in / out)

Compared to LogoWidget, it just adds the attribute zoom_factor.

Parameters

• args – positional arguments of the constructor of LogoWidget

• zoom_factor (float) – zoom factor

Methods:

callback(visi)

Callback method for zooming in

callback(visi)

Callback method for zooming in

Parameters

visi – associated instance of ViSiAnnoT

Class ZoomOutWidget

class visiannot.visiannot.components.LogoWidgets.ZoomOutWidget(*args, zoom_factor=2)

Bases: visiannot.visiannot.components.LogoWidgets.ZoomWidget

Base class of widgets for zoom (in / out)

Compared to LogoWidget, it just adds the attribute zoom_factor.

Parameters

• args – positional arguments of the constructor of LogoWidget

• zoom_factor (float) – zoom factor

Methods:

callback(visi)

Callback method for zooming out

callback(visi)

Callback method for zooming out

Parameters

visi – associated instance of ViSiAnnoT

Class ZoomWidget

class visiannot.visiannot.components.LogoWidgets.ZoomWidget(*args, zoom_factor=2)

Bases: visiannot.visiannot.components.LogoWidgets.LogoWidget

Base class of widgets for zoom (in / out)

Compared to LogoWidget, it just adds the attribute zoom_factor.

Parameters

• args – positional arguments of the constructor of LogoWidget

• zoom_factor (float) – zoom factor

Attributes:

zoom_factor

(float) Zoom factor

zoom_factor

(float) Zoom factor