pycatia.analysis_interfaces.analysis_image¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.analysis_interfaces.analysis_image.AnalysisImage(com_object)¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

AnalysisImage

Represents the analysis image object.

property analysis_color_map: AnalysisColorMap¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357): o Property AnalysisColorMap() As AnalysisColorMap (Read Only)

Returns the color map object associated with an analysis image.

Return type:: AnalysisColorMap

property analysis_images: AnalysisImages¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357): o Property AnalysisImages() As AnalysisImages (Read Only)

Returns the analysis images collection associated with an analysis image.

Return type:: AnalysisImages

export_data(i_folder: Folder, i_file_name: str, i_extension_type: str) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub ExportData(Folder iFolder,

CATBSTR iFileName,

CATBSTR 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

ExportDataWithMeshPartId

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.

Parameters:

i_folder (Folder) –
i_file_name (str) –
i_extension_type (str) –

Return type:

None

export_data_in_any_user_axis(i_folder: Folder, i_file_name: str, i_extension_type: str, i_axis_system: AnyObject, i_product: Product, i_axis_orientation_type: int, i_export_mesh_part_id: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub ExportDataInAnyUserAxis(Folder iFolder,

CATBSTR iFileName,

CATBSTR iExtensionType,

AnyObject iAxisSystem,

Product iProduct,

CATAxisOrientationType iAxisOrientationType,

boolean 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

ExportDataWithMeshPartId

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

Parameters:

i_folder (Folder) –
i_file_name (str) –
i_extension_type (str) –
i_axis_system (AnyObject) –
i_product (Product) –
i_axis_orientation_type (int) – enum cat_axis_orientation_type
i_export_mesh_part_id (bool) –

Return type:

None

export_data_in_global_axis(i_folder: Folder, i_file_name: str, i_extension_type: str, i_axis_orientation_type: int, i_export_mesh_part_id: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub ExportDataInGlobalAxis(Folder iFolder,

CATBSTR iFileName,

CATBSTR iExtensionType,

CATAxisOrientationType iAxisOrientationType,

boolean 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

Parameters:

i_folder (Folder) –
i_file_name (str) –
i_extension_type (str) –
i_axis_orientation_type (int) – enum cat_axis_orientation_type
i_export_mesh_part_id (bool) –

Return type:

None

export_data_in_manual_axis(i_folder: Folder, i_file_name: str, i_extension_type: str, i_origin: tuple, i_x_direction: tuple, i_y_direction: tuple, i_z_direction: tuple, i_axis_orientation_type: int, i_export_mesh_part_id: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub ExportDataInManualAxis(Folder iFolder,

CATBSTR iFileName,

CATBSTR iExtensionType,

CATSafeArrayVariant iOrigin,

CATSafeArrayVariant iXDirection,

CATSafeArrayVariant iYDirection,

CATSafeArrayVariant iZDirection,

CATAxisOrientationType iAxisOrientationType,

boolean 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

Parameters:

i_folder (Folder) –
i_file_name (str) –
i_extension_type (str) –
i_origin (tuple) –
i_x_direction (tuple) –
i_y_direction (tuple) –
i_z_direction (tuple) –
i_axis_orientation_type (int) – enum cat_axis_orientation_type
i_export_mesh_part_id (bool) –

Return type:

None

export_data_in_user_axis(i_folder: Folder, i_file_name: str, i_extension_type: str, i_axis_system: AxisSystem, i_product: Product, i_axis_orientation_type: int, i_export_mesh_part_id: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub ExportDataInUserAxis(Folder iFolder,

CATBSTR iFileName,

CATBSTR iExtensionType,

AxisSystem iAxisSystem,

Product iProduct,

CATAxisOrientationType iAxisOrientationType,

boolean 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

ExportDataWithMeshPartId

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

Parameters:

i_folder (Folder) –
i_file_name (str) –
i_extension_type (str) –
i_axis_system (AxisSystem) –
i_product (Product) –
i_axis_orientation_type (int) – enum cat_axis_orientation_type
i_export_mesh_part_id (bool) –

Return type:

None

export_data_with_mesh_part_id(i_folder: Folder, i_file_name: str, i_extension_type: str) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub ExportDataWithMeshPartId(Folder iFolder,

CATBSTR iFileName,

CATBSTR 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

ExportData

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.

Parameters:

i_folder (Folder) –
i_file_name (str) –
i_extension_type (str) –

Return type:

None

reset_selection() → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub ResetSelection()

Resets all selections in an image.

This is done related to an existing image

Return type:: None

set_activation_status(i_activation_status: cat_variant) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub SetActivationStatus(CATVariant iActivationStatus)

Activates oe deactivates an image.

This is done related to an existing image

Parameters:

iActivationStatus

To activate or not the current image.

Parameters:: i_activation_status (cat_variant) –
Return type:: None

set_current_occurrence(i_occurrence_number: cat_variant) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub SetCurrentOccurrence(CATVariant 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

Parameters:: i_occurrence_number (cat_variant) –
Return type:: None

set_selection(i_reference: Reference, i_replace_mode: cat_variant) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub SetSelection(Reference iReference,

CATVariant 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.

Parameters:

i_reference (Reference) –
i_replace_mode (cat_variant) –

Return type:

None

update() → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub Update()

Updates an image.

This is done related to an existing image

Return type:: None

pycatia.analysis_interfaces.analysis_image¶

Navigation

Related Topics