AnalysisImage (Object)

Represents the analysis image object.

Properties


Property AnalysisColorMap() As (Read Only)
Returns the color map object associated with an analysis image.
Property AnalysisImages() As (Read Only)
Returns the analysis images collection associated with an analysis image.

Methods


Sub ExportData( iFolder, iFileName, iExtensionType)
Extracts image results.
The export is done related to an existing image and will be stored in a CATIA Folder as a Text file or as an Excel file.
Limitations:
  • The allowed output positions are: node, element, center of element, and node of element
  • The allowed values are: integer, real or double
  • The allowed value types are: average or discontinuous iso, symbol, fringe or text

To export data with mesh-part identification use

Parameters:
iFolder
The folder to store the file to create
iFileName
The name of the file to create
iExtensionType
The extension of the file
Legal values:
  • "xls" for a Microsoft Excel workbook
  • "txt" for a text file.
Sub ExportDataInAnyUserAxis( iFolder, iFileName, iExtensionType, iAxisSystem, iProduct, iAxisOrientationType, iExportMeshPartID)
Extracts image results.
The export is done related to an existing image and will be stored in a CATIA Folder as a Text file or as an Excel file. If User has not implemented CATIAAxisSystem interface for axis system, but has CATIABase interface implementation.
Limitations:
  • The allowed output positions are: node, element, center of element, and node of element
  • The allowed values are: integer, real or double
  • The allowed value types are: average or discontinuous iso, symbol, fringe or text

To export data with mesh-part identification use

Parameters:
iFolder
The folder to store the file to create
iFileName
The name of the file to create
iExtensionType
The extension of the file
Legal values:
  • "xls" for a Microsoft Excel workbook
  • "txt" for a text file.
iAxisSystem
Reference to the axis system to be used for location transformation.
iProduct
Reference to the product, where the above axis system is defined.
iAxisOrientationType
Coordinate system type of location axis system
iExportMeshPartID
Flag for exporting with meshpartid or not
Sub ExportDataInGlobalAxis( iFolder, iFileName, iExtensionType, iAxisOrientationType, iExportMeshPartID)
Extracts image results.
The export is done related to an existing image and will be stored in a CATIA Folder as a Text file or as an Excel file.
Limitations:
  • The allowed output positions are: node, element, center of element, and node of element
  • The allowed values are: integer, real or double
  • The allowed value types are: average or discontinuous iso, symbol, fringe or text
Parameters:
iFolder
The folder to store the file to create
iFileName
The name of the file to create
iExtensionType
The extension of the file
Legal values:
  • "xls" for a Microsoft Excel workbook
  • "txt" for a text file.
iAxisOrientationType
Coordinate system type of location axis system
iExportMeshPartID
Flag for exporting with meshpartid or not
Sub ExportDataInManualAxis( iFolder, iFileName, iExtensionType, iOrigin, iXDirection, iYDirection, iZDirection, iAxisOrientationType, iExportMeshPartID)
Extracts image results.
The export is done related to an existing image and will be stored in a CATIA Folder as a Text file or as an Excel file.
Limitations:
  • The allowed output positions are: node, element, center of element, and node of element
  • The allowed values are: integer, real or double
  • The allowed value types are: average or discontinuous iso, symbol, fringe or text
Parameters:
iFolder
The folder to store the file to create
iFileName
The name of the file to create
iExtensionType
The extension of the file
Legal values:
  • "xls" for a Microsoft Excel workbook
  • "txt" for a text file.
iOrigin
Origin of Location axis system
iXDirection
co-ordinates of a point on X- axis of Location axis system
iYDirection
co-ordinates of a point on Y- axis of Location axis system
iZDirection
co-ordinates of a point on Z- axis of Location axis system
iAxisOrientationType
Coordinate system type of location axis system
iExportMeshPartID
Flag for exporting with meshpartid or not
Sub ExportDataInUserAxis( iFolder, iFileName, iExtensionType, iAxisSystem, iProduct, iAxisOrientationType, iExportMeshPartID)
Extracts image results.
The export is done related to an existing image and will be stored in a CATIA Folder as a Text file or as an Excel file.
Limitations:
  • The allowed output positions are: node, element, center of element, and node of element
  • The allowed values are: integer, real or double
  • The allowed value types are: average or discontinuous iso, symbol, fringe or text

To export data with mesh-part identification use

Parameters:
iFolder
The folder to store the file to create
iFileName
The name of the file to create
iExtensionType
The extension of the file
Legal values:
  • "xls" for a Microsoft Excel workbook
  • "txt" for a text file.
iAxisSystem
Reference to the axis system to be used for location transformation.
iProduct
Reference to the product, where the above axis system is defined.
iAxisOrientationType
Coordinate system type of location axis system
iExportMeshPartID
Flag for exporting with meshpartid or not
Sub ExportDataWithMeshPartId( iFolder, iFileName, iExtensionType)
Extracts image results and location with mesh part name (as identifier).
The export is done related to an existing image and will be stored in a CATIA Folder as a Text file or as an Excel file.
Limitations:
  • The allowed output positions are: element, center of element, and node of element
  • The allowed values are: integer, real or double
  • The allowed value types are: average or discontinuous iso, symbol, fringe or text

To export data with mesh-part identification use

Parameters:
iFolder
The folder to store the file to create
iFileName
The name of the file to create
iExtensionType
The extension of the file
Legal values:
  • "xls" for a Microsoft Excel workbook
  • "txt" for a text file.
Sub ResetSelection()
Resets all selections in an image.
This is done related to an existing image
Sub SetActivationStatus( iActivationStatus)
Activates oe deactivates an image.
This is done related to an existing image
Parameters:
iActivationStatus
To activate or not the current image.
Sub SetCurrentOccurrence( iOccurrenceNumber)
Sets occurrence number for an image.
This is done related to an existing image
Parameters:
iOccurrenceNumber
The number to select
Legal value: 1 ≤ iOccurrenceNumber ≤ nbOccurrence
Sub SetSelection( iReference, iReplaceMode)
Adds a selection to an image.
This is done related to an existing image
Parameters:
iReference
The selectionGroup to add
iReplaceMode
To replace or not the current selections.
Sub Update()
Updates an image.
This is done related to an existing image