OrsDatasetCropper

Plugin for creating subsets of datasets by cropping

author:ORS Team
contact:http://theobjects.com
email:info@theobjects.com
organization:Object Research Systems (ORS), Inc.
address:760 St-Paul West, suite 101, Montréal, Québec, Canada, H3C 1M4
copyright:Object Research Systems (ORS), Inc. All rights reserved.
date:July 2017
dragonflyVersion:
 3.0
UUID:6c71e7e8761111e7be64448a5b5d70c0

Class Code

class OrsPythonPlugins.OrsDatasetCropper.OrsDatasetCropper.OrsDatasetCropper(varname=None, managed=True)
OrsHandleClipPlane3D = 'OrsHandleClipPlane3D'
OrsStateClipBoxManipulate = 'OrsStateClipBoxManipulate'
UIDescriptors = [<ORSServiceClass.OrsPlugin.uidescriptor.UIDescriptor object>]
closable = True
closeWidget(name)
classmethod contextualMenu(context)
interfacemethod crop(structuredGrid, xMin, yMin, zMin, tMin, xMax, yMax, zMax, tMax, createNewStructuredGrid)

Crop a structured grid by index range.

Parameters:
  • structuredGrid (ORSModel.ors.StructuredGrid) – the structured grid to crop
  • xMin (int) – minimal cropping index in X
  • yMin (int) – minimal cropping index in Y
  • zMin (int) – minimal cropping index in Z
  • tMin (int) – minimal cropping index in T
  • xMax (int) – maximal cropping index in X
  • yMax (int) – maximal cropping index in Y
  • zMax (int) – maximal cropping index in Z
  • tMax (int) – maximal cropping index in T
  • createNewStructuredGrid (bool) – if True, a new dataset will be generated. If False, the input structuredGrid will be modified.
Returns:

newStructuredGrid (ORSModel.ors.StructuredGrid) – cropped dataset. If createNewStructuredGrid is False, None is returned.
interfacemethod cropFromBox(structuredGrid, createNewStructuredGrid, aBox=None, tMin=0, tMax=0)

Crop a structured grid using a box.

Parameters:
  • structuredGrid (ORSModel.ors.StructuredGrid) – the structured grid to crop
  • createNewStructuredGrid (bool) – if True, a new dataset will be generated. If False, the input structuredGrid will be modified.
  • aBox (ORSModel.ors.Box) – the box used to set the cropping range. If None, the box of the structured grid to crop is used.
  • tMin (int) – minimal cropping index in T
  • tMax (int) – maximal cropping index in T
Returns:

newStructuredGrid (ORSModel.ors.StructuredGrid) – cropped dataset. If createNewStructuredGrid is False, None is returned.
classmethod findAllDisplaysWhereStructuredGridIsVisible(structuredGrid)
classmethod getAbout()
getSourceStructuredGrid()
getStructuredGridGUID()
handleChanged(oldHandleName, newHandleName)
handleTriggered()
keepAlive = False
classmethod menuItemCrop()
multiple = False
classmethod openDatasetCropperAction(structuredGridGUID)
openWidget(name, dock=None, tab=None, x=-1, y=-1, w=-1, l=-1, order=-1)
orsCurrentDisplayChange()
savable = False
selectedObjectsChanged()
setSourceStructuredGrid(structuredGrid)
stateDescriptors = [<ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>]