pycatia.abq_automation_interfaces.abq_image_query

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.abq_automation_interfaces.abq_image_query.ABQImageQuery(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
ABQImageQuery

Provides an image query object.

Role: Use to query result images for values on nodes / elements / groups. Image query can be done simultaneously for multiple images. User can call methods such as ExportImageData or ExportGroupImageData. Use following method to get an object of ABQImageQuery Dim abqCase As ABQAnalysisCase Dim ImageQuery As ABQImageQuery Set ImageQuery = abqCase.GetItem (“ABQVBImageQuery”)
export_group_image_data(i_images_list: AnalysisImages, i_group: AnalysisEntity, i_type: int, i_file: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ExportGroupImageData(AnalysisImages iImagesList,
AnalysisEntity iGroup,
ABQEntityType iType,
CATBSTR iFile)

Method to export image data in text or excel format for a
group.
The data in a row will be in following order: Node / element id, X
coordinate, Y coordinate, Z coordinate, value for image 1, value for image 2,
…

File type will be identified using file extension. If file extension is
‘xls’ then it will be exported in excel otherwise the file type will be
considered as text

Parameters:

iImagesList
List of images to export
iGroup
CATIA group or display group to query image data
iType
Entity type to query.
Legal values

ABQ_NODE
ABQ_ELEMENT

iFile
File path to export data.
Example:
The following example exports image query data to specified
file

Dim ImageQuery As ABQImageQuery
Dim File As FileSystem
Dim MyGroup As AnalysisEntity
Dim imageList As AnalysisImages
ImageQuery.ExportImageData imageList, MyGroup, ABQ_NODE,
File
Parameters:
Return type:

None

export_image_data(i_images_list: AnalysisImages, i_list_numbers: tuple, i_type: int, i_file: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ExportImageData(AnalysisImages iImagesList,
CATSafeArrayVariant iListNumbers,
ABQEntityType iType,
CATBSTR iFile)

Method to export image data in text or excel format.
The data in a row will be in following order: Node / element id, X
coordinate, Y coordinate, Z coordinate, value for image 1, value for image 2,
…

File type will be identified using file extension. If file extension is
‘xls’ then it will be exported in excel otherwise the file type will be
considered as text

Parameters:

iImagesList
List of images to export
iListNumbers
List of entity indices to export (node numbers or element numbers)

iType
Entity type to query.
Legal values

ABQ_NODE
ABQ_ELEMENT

iFile
File path to export data
Example:
The following example exports image query data to specified
file

Dim ImageQuery As ABQImageQuery
Dim File As FileSystem
Dim EntityList As CATSafeArrayVariant
Dim imageList As AnalysisImages
ImageQuery.ExportImageData imageList, EntityList, ABQ_NODE,
File
Parameters:

  • i_images_list (AnalysisImages) –

  • i_list_numbers (tuple) –

  • i_type (int) – enum abq_entity_type

  • i_file (str) –

Return type:

None