OrsCreateMaskForChannel_00114c2e057911ea85750c9d927663a1

author:

Dragonfly Team

contact:

https://dragonfly.comet.tech

email:

support.dragonfly@comet.tech

organization:

Comet Technologies Canada Inc.

address:

460 Ste-Catherine Ouest, suite 600, Montréal, Québec, Canada, H3B 1A7

copyright:

Comet Technologies Canada Inc. All rights reserved 2023.

date:

Nov 12 2019 13:19

dragonflyVersion:

4.5.0.11522

UUID:

00114c2e057911ea85750c9d927663a1

Class Code

class OrsPythonPlugins.OrsCreateMaskForChannel_00114c2e057911ea85750c9d927663a1.OrsCreateMaskForChannel_00114c2e057911ea85750c9d927663a1.OrsCreateMaskForChannel_00114c2e057911ea85750c9d927663a1(*args, **kwargs)
interfacemethod createMask(channel: Channel, xstart: int, xend: int, xincrement: int, ystart: int, yend: int, yincrement: int, zstart: int, zend: int, zincrement: int) → None

Create a ROI that will serve as a mask for the channel

Parameters:

  • channel (ORSModel.ors.Channel) – the channel to mask

  • xstart (int) – the x coordinate at which the mask start

  • xend (int) – the x coordinate at which the mask end

  • xincrement (int) – the x increment

  • ystart (int) – the y coordinate at which the mask start

  • yend (int) – the y coordinate at which the mask end

  • yincrement (int) – the y increment

  • zstart (int) – the z coordinate at which the mask start

  • zend (int) – the z coordinate at which the mask end

  • zincrement (int) – the z increment

classmethod getMainFormClass()

Gets the class of the main form

Returns:

output –

classmethod startupDefault(openMainForm=True)

Creates an instance of the plugin class and opens the main form (if required) at the default position.

Returns:

output (AbstractPlugin) – plugin instance