OrsMarkedSlicesManipulator

Manages dataset marked slices

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:

Feb 13 2016 10:56

dragonflyVersion:

3.0

UUID:

bd221f92761511e7b3c1448a5b5d70c0

Class Code

class OrsPythonPlugins.OrsMarkedSlicesManipulator.OrsMarkedSlicesManipulator.OrsMarkedSlicesManipulator(*args, **kwargs)
interfacemethod copyMarkedSlice(dataset: Channel, interactive: bool = False) → bool

Copies the marked slice to the current slice.

Parameters:

  • dataset (ORSModel.ors.Channel) – the dataset to work on

  • interactive (bool) – True if interactive, i.e. can show an error message or not, False in headless mode

Returns:

copySuccess (bool) – True if successful, False otherwise

interfacemethod createDatasetFromMarkedSlice(dataset: Channel) → Channel

Create a new dataset from the marked slices of a dataset.

Parameters:

dataset (ORSModel.ors.Channel) – the input dataset

Returns:

newDataset (ORSModel.ors.Channel) – a new Channel

interfacemethod invertMarkedSliceSelection(dataset: Channel) → bool

Toggles the marking state of every slice of a dataset.

Parameters:

dataset (ORSModel.ors.Channel) – the dataset to toggle the marking of the slices on

Returns:

invertMarkingSuccess (bool) – True if successful, False otherwise

interfacemethod markAllSlice(dataset: Channel, marked: bool) → bool

Mark all slices of a dataset.

Parameters:

  • dataset (ORSModel.ors.Channel) – the dataset to mark the slices on

  • marked (bool) – True to set the entire slices as marked, False otherwise

Returns:

markingSuccess (bool) – True if successful, False otherwise

interfacemethod markSlice(dataset: Channel, sliceIndex: int, timeStep: int, marked: bool) → bool

Mark a slice of a dataset.

Parameters:

  • dataset (ORSModel.ors.Channel) – the dataset to mark the slice on

  • sliceIndex (int) – the slice index to mark

  • timeStep (int) – the time index to mark

  • marked (bool) – True to set the slice to be marked, False otherwise

Returns:

markingSuccess (bool) – True if successful, False otherwise

interfacemethod removeMarkedSlices(dataset: Channel, interactive: bool = False) → bool

Removes the marked slices of a dataset.

Parameters:

  • dataset (ORSModel.ors.Channel) – the dataset to remove the marked slices on

  • interactive (bool) – True if interactive, i.e. can show an error message or not, False in headless mode

Returns:

removalSuccess (bool) – True if successful, False otherwise

interfacemethod simpleMarkSliceReplacement(dataset: Channel) → bool

Replaces the marked slices of a dataset.

Parameters:

dataset (ORSModel.ors.Channel) – the dataset to replace the marked slices on

Returns:

replacementSuccess (bool) – True if successful, False otherwise