OrsDatasetProperties

Manages dataset properties

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:

Aug 03 2015 15:11

dragonflyVersion:

3.0

UUID:

94c07368761111e79147448a5b5d70c0

Class Code

class OrsPythonPlugins.OrsDatasetProperties.OrsDatasetProperties.OrsDatasetProperties(*args, **kwargs)
interfacemethod changeAdvancedStructuredGridProperties(structuredGrid: StructuredGrid, xPosition: float, yPosition: float, zPosition: float, orientationAxis1X: float, orientationAxis1Y: float, orientationAxis1Z: float, orientationAxis2X: float, orientationAxis2Y: float, orientationAxis2Z: float, orientationAxis3X: float, orientationAxis3Y: float, orientationAxis3Z: float) → None

Changes the structured grid advanced properties.

Parameters:

  • structuredGrid (ORSModel.ors.StructuredGrid) – the structured grid to modify

  • xPosition (float) – new position in the X direction

  • yPosition (float) – new position in the Y direction

  • zPosition (float) – new position in the Z direction

  • orientationAxis1X (float) – new X component for the direction 1

  • orientationAxis1Y (float) – new Y component for the direction 1

  • orientationAxis1Z (float) – new Z component for the direction 1

  • orientationAxis2X (float) – new X component for the direction 2

  • orientationAxis2Y (float) – new Y component for the direction 2

  • orientationAxis2Z (float) – new Z component for the direction 2

  • orientationAxis3X (float) – new X component for the direction 3

  • orientationAxis3Y (float) – new Y component for the direction 3

  • orientationAxis3Z (float) – new Z component for the direction 3

interfacemethod changeStructuredGridProperties(structuredGrid: StructuredGrid, xSpacing: float, ySpacing: float, zSpacing: float, offset: float, slope: float, dataDimensionUnit: DimensionUnit = None, dataUnit: str = None) → None

Changes the structured grid properties.

Changed in version -: Argument dataUnit (str) is replaced by dataDimensionUnit (DimensionUnit instance)

Parameters:

  • structuredGrid (ORSModel.ors.StructuredGrid) – the structured grid to modify

  • xSpacing (float) – new spacing in the X direction

  • ySpacing (float) – new spacing in the Y direction

  • zSpacing (float) – new spacing in the Z direction

  • offset (float) – new data offset (used with channels only)

  • slope (float) – new data slope (used with channels only)

  • dataDimensionUnit (ORSModel.ors.DimensionUnit) – new data DimensionUnit (used with channels only)

  • dataUnit (str) [deprecated: use dataDimensionUnit instead] – new data unit (used with channels only)

cleanup()

Deletes the variables managed by the plugin. It is the place to remove callbacks and other references to Python objects that would prevent them to be garbage collected. This method is called during the process of deletion of the plugin. It calls for the cleanup and deletion of the forms.

classmethod getMainFormClass()

Gets the class of the main form

Returns:

output –