diff --git a/doc/python_examples/examples_overview.md b/doc/python_examples/examples_overview.md new file mode 100644 index 000000000..56909ec49 --- /dev/null +++ b/doc/python_examples/examples_overview.md @@ -0,0 +1,125 @@ +# ZEISS INSPECT App Examples Overview + +## data_interfaces — How to access data of ZEISS INSPECT elements + +|                         App                         |                                     Description                                     | Example Projects | References |        Tags        | +| --- | ----------- | ---------------- | ---------- | ---- | +| ReferencePointsAndMeshData
[view](data_interfaces/ReferencePointsAndMeshData/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/ReferencePointsAndMeshData) | This example demonstrates how to access the reference points in a measurement and the mesh from Python. | [1)](#example-projects) | [HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/python_api_introduction.html#element-data-interfaces)
| | +| CheckResultsDataArray
[view](data_interfaces/CheckResultsDataArray/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/CheckResultsDataArray) | This example demonstrates two ways of accessing result data from checks using the element properties and data interfaces. | [1)](#example-projects) | [HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/python_api_introduction.html#access-element-properties)
| | +| VolumeSectionImageData
[view](data_interfaces/VolumeSectionImageData/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/VolumeSectionImageData) | This example demonstrates how to access the image data of a volume section. | [3)](#example-projects) | [HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/python_api_introduction.html#element-data-interfaces)
| | + +## dialog_widgets — How to use custom dialogs and handle user input events + +|                         App                         |                                     Description                                     | Example Projects | References |        Tags        | +| --- | ----------- | ---------------- | ---------- | ---- | +| WidgetVisibility
[view](dialog_widgets/WidgetVisibility/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/WidgetVisibility) | This example shows how to use a dialog event handler to turn on/off widget visibilities. | | [HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.html)
| | +| UnitDialogEventHandler
[view](dialog_widgets/UnitDialogEventHandler/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/UnitDialogEventHandler) | This basic example demonstrates how to use an event handler on a script dialog to set the unit to multiple widgets. | | [HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.html#unit-widget)
| | +| ExplorerSelectedElementsInDialog
[view](dialog_widgets/ExplorerSelectedElementsInDialog/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/ExplorerSelectedElementsInDialog) | This example shows how to get a list of elements selected in the element explorer and use it in a script dialog. | [1)](#example-projects) | [HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.html#selection-element-widget)
| | +| DropdownWidget
[view](dialog_widgets/DropdownWidget/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/DropdownWidget) | This basic example shows how to use the dropdown widget and how to define items at script runtime. | | [HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.html#selection-list-widget)
| | + +## misc — Miscellaneous + +|                         App                         |                                     Description                                     | Example Projects | References |        Tags        | +| --- | ----------- | ---------------- | ---------- | ---- | +| CSVExample
[view](misc/CSVExample/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/CSVExample) | This example demonstrates how to read and write CSV files (comma separated values) from an App. | [1)](#example-projects) | | | +| DialogReopenExample
[view](misc/DialogReopenExample/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/DialogReopenExample) | This examples demonstrates, how a dialog can be closed from its own handler, just to be opened again. | | [HowTo]( https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.html#executing-dialogs)
| | +| PointPixelTransformations
[view](misc/PointPixelTransformations/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/PointPixelTransformations) | This example demonstrates how to find the 2D pixel coordinates of a 3D point coordinate and vice versa. | [2)](#example-projects) | [API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/python_api.html#gom-api-imaging)
| | + +## projects — ZEISS INSPECT projects + +|                         App                         |                                     Description                                     | Example Projects | References |        Tags        | +| --- | ----------- | ---------------- | ---------- | ---- | +| ExampleProjects
[view](projects/ExampleProjects/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/ExampleProjects) | ZEISS INSPECT Example Projects | | | | + +## script_icons — How to set icons for scripts or buttons + +|                         App                         |                                     Description                                     | Example Projects | References |        Tags        | +| --- | ----------- | ---------------- | ---------- | ---- | +| ScriptIcon
[view](script_icons/ScriptIcon/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/ScriptIcon) | This example shows how an icon can be set to a script, whereas the icon itself resides in the App as a resource. | | | | + +## script_resources — How to access binary data of your App (resources) + +|                         App                         |                                     Description                                     | Example Projects | References |        Tags        | +| --- | ----------- | ---------------- | ---------- | ---- | +| ScriptResources
[view](script_resources/ScriptResources/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/ScriptResources) | A simple example showing the usage of script resources. | | [HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/using_script_resources.html)
[API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/resource_api.html)
| | + +## scripted_actuals — Building custom actual elements with Python code + +|                         App                         |                                     Description                                     | Example Projects | References |        Tags        | +| --- | ----------- | ---------------- | ---------- | ---- | +| ScriptedActualVolume
[view](scripted_actuals/ScriptedActualVolume/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/ScriptedActualVolume) | This is an example for a scripted actual ‘volume’ element. | | [HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html)
[API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#volume)
| [![Static Badge](https://img.shields.io/badge/xray-blue)](#xray)
| +| ScriptedElementProgress
[view](scripted_actuals/ScriptedElementProgress/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/ScriptedElementProgress) | This examples demonstrates how to show progress information to the user while calcualting a scripted element. | | | | +| ScriptedActualCircle
[view](scripted_actuals/ScriptedActualCircle/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/ScriptedActualCircle) | This is an example for a scripted actual ‘circle’ element. | | [HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html)
[API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#circle)
| | +| ScriptedActualCone
[view](scripted_actuals/ScriptedActualCone/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/ScriptedActualCone) | This is an example for a scripted actual ‘cone’ element. | | [HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html)
[API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#cone)
| | +| ScriptedActualDistance
[view](scripted_actuals/ScriptedActualDistance/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/ScriptedActualDistance) | This is an example for a scripted actual ‘distance’ element. | | [HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html)
[API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#distance)
| | +| ScriptedActualSection
[view](scripted_actuals/ScriptedActualSection/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/ScriptedActualSection) | This is an example for a scripted actual ‘section’ element. | | [HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html)
[API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#section)
| | +| ScriptedActualPoint
[view](scripted_actuals/ScriptedActualPoint/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/ScriptedActualPoint) | These are two examples for scripted actual points, which serve as an introduction to the concept of scripted actual elements. | | [HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html)
[API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#point)
| | +| ScriptedActualVolumeDefects
[view](scripted_actuals/ScriptedActualVolumeDefects/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/ScriptedActualVolumeDefects) | This is an example for a scripted actual ‘volume defects’ element. | | [HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html)
[API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#volume-defects)
| [![Static Badge](https://img.shields.io/badge/xray-blue)](#xray)
| +| ScriptedActualVolumeRegion
[view](scripted_actuals/ScriptedActualVolumeRegion/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/ScriptedActualVolumeRegion) | This is an example for a scripted actual ‘volume region’ element. | | [HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html)
[API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#volume-region)
| [![Static Badge](https://img.shields.io/badge/xray-blue)](#xray)
| +| ScriptedActualCurve
[view](scripted_actuals/ScriptedActualCurve/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/ScriptedActualCurve) | This is an example for a scripted actual ‘curve’ element. | | [HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html)
[API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#curve)
| | +| ScriptedActualSurface
[view](scripted_actuals/ScriptedActualSurface/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/ScriptedActualSurface) | This is an example for a scripted actual ‘surface’ element. | | [HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html)
[API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#surface)
| | +| ScriptedActualCylinder
[view](scripted_actuals/ScriptedActualCylinder/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/ScriptedActualCylinder) | This is an example for a scripted actual ‘cylinder’ element. | | [HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html)
[API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#cylinder)
| | +| ScriptedActualPointCloud
[view](scripted_actuals/ScriptedActualPointCloud/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/ScriptedActualPointCloud) | This is an example for a scripted actual ‘point cloud’ element. | | [HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html)
[API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#point-cloud)
| | +| ScriptedActualVolumeSection
[view](scripted_actuals/ScriptedActualVolumeSection/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/ScriptedActualVolumeSection) | This is an example for a scripted actual ‘volume section’ element. | | [HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html)
[API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#volume-section)
| [![Static Badge](https://img.shields.io/badge/xray-blue)](#xray)
| +| ScriptedActualSurfaceCurve
[view](scripted_actuals/ScriptedActualSurfaceCurve/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/ScriptedActualSurfaceCurve) | This is an example for a scripted actual ‘surface curve’ element. | | [HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html)
[API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#surface-curve)
| | +| TrimeshDeformMesh
[view](scripted_actuals/TrimeshDeformMesh/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/TrimeshDeformMesh) | This example demonstrates how to generate a custom surface element using a scripted element. The example script accesses mesh information from an existing mesh in the project and adds a random deformation to each point. | [1)](#example-projects) | [HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html)
[API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#surface)
| [![Static Badge](https://img.shields.io/badge/surface-blue)](#surface)
[![Static Badge](https://img.shields.io/badge/scripted--actual-blue)](#scripted-actual)
| + +## scripted_checks — Building custom checks with Python code + +|                         App                         |                                     Description                                     | Example Projects | References |        Tags        | +| --- | ----------- | ---------------- | ---------- | ---- | +| ScriptedSurfaceCheck
[view](scripted_checks/ScriptedSurfaceCheck/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/ScriptedSurfaceCheck) | This example demonstrates how to create a scalar surface check by a script. Also, the usage of custom coordinate systems and element preview in scripted checks is shown. | [1)](#example-projects) | [HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_checks.html)
[API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#scalar-surface)
| [![Static Badge](https://img.shields.io/badge/scripted--check-blue)](#scripted-check)
[![Static Badge](https://img.shields.io/badge/surface-blue)](#surface)
| +| ScriptedScalarCheck
[view](scripted_checks/ScriptedScalarCheck/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/ScriptedScalarCheck) | This example shows how to create a scalar check by script. A scalar check is the most basic check, as it assigns a scalar value to an element. Nearly all elements you can find in the software can be checked like this. | [1)](#example-projects) | [HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_checks.html)
[API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#scalar)
| [![Static Badge](https://img.shields.io/badge/scripted--check-blue)](#scripted-check)
[![Static Badge](https://img.shields.io/badge/scalar-blue)](#scalar)
| +| ScriptedCurveCheck
[view](scripted_checks/ScriptedCurveCheck/doc/Documentation.md) / [download](https://software-store.zeiss.com/products/apps/ScriptedCurveCheck) | This example demonstrates how to create a scalar curve check by a script. Also, the usage of custom coordinate systems in scripted checks is shown. | [1)](#example-projects) | [HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_checks.html)
[API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#scalar-curve)
| [![Static Badge](https://img.shields.io/badge/scripted--check-blue)](#scripted-check)
[![Static Badge](https://img.shields.io/badge/curve-blue)](#curve)
| + +## Example projects + +1) zeiss_part_test_project +2) zeiss_part_test_measurement +3) volume_test_project + +[Download Example Projects App](https://software-store.zeiss.com/products/apps/ExampleProjects) + +## Tag Index + +### ![Static Badge](https://img.shields.io/badge/curve-blue) + +* [ScriptedCurveCheck](#ScriptedCurveCheck) + + +### ![Static Badge](https://img.shields.io/badge/scalar-blue) + +* [ScriptedScalarCheck](#ScriptedScalarCheck) + + +### ![Static Badge](https://img.shields.io/badge/scripted--actual-blue) + +* [TrimeshDeformMesh](#TrimeshDeformMesh) + + +### ![Static Badge](https://img.shields.io/badge/scripted--check-blue) + +* [ScriptedCurveCheck](#ScriptedCurveCheck) +* [ScriptedScalarCheck](#ScriptedScalarCheck) +* [ScriptedSurfaceCheck](#ScriptedSurfaceCheck) + + +### ![Static Badge](https://img.shields.io/badge/surface-blue) + +* [ScriptedSurfaceCheck](#ScriptedSurfaceCheck) +* [TrimeshDeformMesh](#TrimeshDeformMesh) + + +### ![Static Badge](https://img.shields.io/badge/xray-blue) + +* [ScriptedActualVolume](#ScriptedActualVolume) +* [ScriptedActualVolumeDefects](#ScriptedActualVolumeDefects) +* [ScriptedActualVolumeRegion](#ScriptedActualVolumeRegion) +* [ScriptedActualVolumeSection](#ScriptedActualVolumeSection) + + +## Related + +* [ZEISS IQS GitHub — App Development Documentation](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/index.html) +* [ZEISS Quality Software Store](https://software-store.zeiss.com) +