Skip to content

Commit

Permalink
Merge pull request #95 from AllenNeuralDynamics/wip/update_docs_docst…
Browse files Browse the repository at this point in the history
…rings

.PNG -->.png
  • Loading branch information
hannalee2 authored Oct 7, 2024
2 parents c2e7bd8 + 05da000 commit 54ab0e8
Show file tree
Hide file tree
Showing 19 changed files with 18 additions and 18 deletions.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
6 changes: 3 additions & 3 deletions docs/source/userGuideCalc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ reticle-specific metadata to the global coordinates during the conversion.
<div class="inline-images" style="text-align: center;">
<div style="display: inline-flex; align-items: center; justify-content: center;">
<div style="text-align: center;">
<img src="_static/_userGuide/_calc/12.png" width="150px"/>
<img src="_static/_userGuide/_calc/_12.png" width="150px"/>
</div>
<div style="margin: 0 10px; font-size: 18px;">→</div>
<div style="text-align: center;">
Expand All @@ -99,10 +99,10 @@ reticle-specific metadata to the global coordinates during the conversion.
After converting coordinates, you can move the stage to the desired local coordinates.

The `moveStageXY0` button allows you to send the stage to a specific (X, Y, 0) position, which is the highest position.

First, it moves to z = 0 (the highest height), and then it moves to the desired (X, Y) position to avoid collisions with the reticle surface.

.. image:: _static/_userGuide/_calc/10.png
.. image:: _static/_userGuide/_calc/_10.png
:alt: Calculator Overview
:width: 500px
:align: center
22 changes: 11 additions & 11 deletions docs/source/userGuideReticleMetadata.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Reticle Metadata
=================

.. image:: _static/_userGuide/_meta/6.png
.. image:: _static/_userGuide/_meta/_6.png
:alt: Reticle Metadata
:width: 500px
:align: center
Expand All @@ -24,7 +24,7 @@ This tool is essential for correcting reticle imprecisions. You can adjust retic

1. **Add / Remove Reticles**: Easily create new reticles or remove existing reticle metadata.

.. image:: _static/_userGuide/_meta/1.png
.. image:: _static/_userGuide/_meta/_1.png
:alt: Add / remove
:width: 300px
:align: center
Expand All @@ -35,14 +35,14 @@ This tool is essential for correcting reticle imprecisions. You can adjust retic
- **Rotation**: Set the rotation value (in degrees) to adjust the reticle’s orientation.
- **Offsets (X, Y, Z)**: Enter offset values to adjust the reticle's position in 3D space.

.. image:: _static/_userGuide/_meta/2.png
.. image:: _static/_userGuide/_meta/_2.png
:alt: Metadata
:width: 300px
:align: center

3. **Update**: Changes are saved to a JSON file and automatically reflected in other functions, such as the calculator and 3D point projection.

.. image:: _static/_userGuide/_meta/3.png
.. image:: _static/_userGuide/_meta/_3.png
:alt: Update
:width: 300px
:align: center
Expand All @@ -60,7 +60,7 @@ This tool is essential for correcting reticle imprecisions. You can adjust retic

If you update the reticle metadata for reticles 'A' and 'H', as shown in the image below, the system will automatically apply the changes to the global coordinates.

.. image:: _static/_userGuide/_meta/6.png
.. image:: _static/_userGuide/_meta/_6.png
:alt: Reticle Metadata
:width: 500px
:align: center
Expand All @@ -75,12 +75,12 @@ If the original global coordinates were (2000, 0, 0), as shown in the left image
<div class="inline-images" style="text-align: center;">
<div style="display: inline-flex; align-items: center; justify-content: center;">
<div style="text-align: center;">
<img src="_static/_userGuide/_meta/17.png" width="200px"/>
<img src="_static/_userGuide/_meta/_17.png" width="200px"/>
<div style="font-size: 10px;">Global Coords Original</div>
</div>
<div style="margin: 0 10px; font-size: 18px;">→</div>
<div style="text-align: center;">
<img src="_static/_userGuide/_meta/18.png" width="200px"/>
<img src="_static/_userGuide/_meta/_18.png" width="200px"/>
<div style="font-size: 10px;">Global Coords (H)</div>
</div>
</div>
Expand All @@ -94,12 +94,12 @@ If the original global coordinates were (2000, 0, 0), as shown in the left image
<div class="inline-images" style="text-align: center;">
<div style="display: inline-flex; align-items: center; justify-content: center;">
<div style="text-align: center;">
<img src="_static/_userGuide/_meta/17.png" width="200px"/>
<img src="_static/_userGuide/_meta/_17.png" width="200px"/>
<div style="font-size: 10px;">Original Image</div>
</div>
<div style="margin: 0 10px; font-size: 18px;">→</div>
<div style="text-align: center;">
<img src="_static/_userGuide/_meta/19.png" width="200px"/>
<img src="_static/_userGuide/_meta/_19.png" width="200px"/>
<div style="font-size: 10px;">Global Coords (A)</div>
</div>
</div>
Expand All @@ -110,14 +110,14 @@ These reticle metadata values are also used in the calculator and for 3D point p

- **Calculator**: You can convert local coordinates (stage coordinates) to global coordinates **with reticle metadata** by selecting the appropriate reticle from the drop-down menu. The calculator will automatically apply the metadata changes to the global coordinates based on your selection. For more details, see the *Calculator* section.

.. image:: _static/_userGuide/_meta/24.png
.. image:: _static/_userGuide/_meta/_24.png
:alt: Calculator with Reticle Metadata applied
:width: 500px
:align: center

- **3D Point Projection**: If you select 'Proj Global Coords (*reticle name*)' from the "Global coords" drop-down menu, and then click images in the camera views, you can see the 3D point projection of the clicked point. For more details, see the *'3D Point Projection'* section.

.. image:: _static/_userGuide/_meta/23.png
.. image:: _static/_userGuide/_meta/_23.png
:alt: 3D Point Projection
:width: 200px
:align: center
6 changes: 3 additions & 3 deletions docs/source/userGuideTrajectory.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Probe Calibration Trajectory

The ``PointMesh`` widget provides an interactive 3D visualization of point trajectories during and after calibration. It allows you to compare local and global point trajectories, making it easier to assess the accuracy of the calibration process.

.. image:: _static/_userGuide/_traj/4.png
.. image:: _static/_userGuide/_traj/_4.png
:alt: PointMesh Widget
:width: 500px
:align: center
Expand All @@ -21,14 +21,14 @@ The ``PointMesh`` widget provides an interactive 3D visualization of point traje

- **During Calibration**: While calibration is ongoing, the local point trajectory will change as the system applies transformation matrices to map local points to the global coordinate system. As you interact with the buttons, you can visualize both local (stage) and global points in the 3D plot.

.. image:: _static/_userGuide/_traj/1.png
.. image:: _static/_userGuide/_traj/_1.png
:alt: During Calibration
:width: 200px
:align: center

- **After Calibration**: Once calibration is complete, the local points should closely match the global points if the calibration was successful. The widget lets you compare how close these two trajectories are. The closer they are, the better the calibration result.

.. image:: _static/_userGuide/_traj/2.png
.. image:: _static/_userGuide/_traj/_2.png
:alt: After Calibration
:width: 200px
:align: center
Expand Down
2 changes: 1 addition & 1 deletion parallax/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

import os

__version__ = "0.38.7"
__version__ = "0.38.8"

# allow multiple OpenMP instances
os.environ["KMP_DUPLICATE_LIB_OK"] = "True"

0 comments on commit 54ab0e8

Please sign in to comment.