AddFromFile then Flip

[mikamyara]

Hello,

I followed the example : AddFromFileAndFlip.rst and tried to adapt it on a custom example. Here is my code :

%reset -sf
%matplotlib widget
from rayoptics.environment import *

mainOpm = OpticalModel()

sm  = mainOpm['seq_model']
osp = mainOpm['optical_spec']
pm = mainOpm['parax_model']
em = mainOpm['ele_model']
pt = mainOpm['part_tree']
ar = mainOpm['analysis_results']

osp.pupil = PupilSpec(osp, key=['object', 'pupil'], value=8.0)
osp.field_of_view = FieldSpec(osp, key=['object', 'height'],flds=[0,0.0,])

sm.gaps[0].thi=19.0
mainOpm.add_from_file(Path().resolve()/"ACL3026U-Zemax(ZMX).zmx", t=50.)

# display the data in various ways
sm.list_model()     
print()
for k,el in enumerate(em.elements): print(k," -- ",el) 
print()
em.list_model()
print()
print(em.elements[3])

mainOpm.flip(em.elements[3])

mainOpm.update_model()
layout_plt = plt.figure(FigureClass=InteractiveLayout,do_draw_ray_fans=True, do_draw_rays=True, do_paraxial_layout=False, opt_model=mainOpm).plot()

It loads a Zemax Model taken from Thorlabs, adds it to my current Opm, then trys to filp. I think I did something similar as the example from "AddFromFileAndFlip.rst". However I get an error at the call to flip. Here is what the program writes, before the error and at the error :

              c            t        medium     mode   zdr      sd
  Obj:     0.000000      19.0000       air             1      0.0000
    1:     0.000000      5.00000       air             1      13.500
    2:     0.073795      11.9000  not B270             1      15.000
    3:     0.000000      50.0000       air             1      15.000
  Img:     0.000000      0.00000                       1      5.0154

0  --  Surface(lbl='Obj', profile=Spherical(c=0.0), interact_mode='dummy')
1  --  Gap(t=19.0, medium=Air())
2  --  Gap(t=5.0, medium=Air())
3  --  Element: EvenPolynomial(c=0.07379474728988791, cc=-0.6301, coefs=[0.0, 5.513e-06, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]), Spherical(c=0.0), t=11.9000, sd=15.0000, glass: not B270
4  --  Gap(t=50.0, medium=Air())
5  --  Surface(lbl='Img', profile=Spherical(c=0.0), interact_mode='dummy')

0: Object (DummyInterface): Surface(lbl='Obj', profile=Spherical(c=0.0), interact_mode='dummy')
1: E1 (Element): Element: EvenPolynomial(c=0.07379474728988791, cc=-0.6301, coefs=[0.0, 5.513e-06, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]), Spherical(c=0.0), t=11.9000, sd=15.0000, glass: not B270
2: Image (DummyInterface): Surface(lbl='Img', profile=Spherical(c=0.0), interact_mode='dummy')

Element: EvenPolynomial(c=0.07379474728988791, cc=-0.6301, coefs=[0.0, 5.513e-06, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]), Spherical(c=0.0), t=11.9000, sd=15.0000, glass: not B270

And the error itself :

---------------------------------------------------------------------------
TypeError                                 Traceback (most recent call last)
Cell In [2], line 29
     26 print()
     27 print(em.elements[3])
---> 29 mainOpm.flip(em.elements[3])
     31 mainOpm.update_model()
     32 layout_plt = plt.figure(FigureClass=InteractiveLayout,do_draw_ray_fans=True, do_draw_rays=True, do_paraxial_layout=False, opt_model=mainOpm).plot()

File ~/.conda/envs/rayOptics/lib/python3.10/site-packages/rayoptics/optical/opticalmodel.py:483, in OpticalModel.flip(self, *args, **kwargs)
    480     flip_pt_tfrm = sm.gbl_tfrms[idx1][0], flip_pt
    481     elements.do_flip_with_part_list(part_list, flip_pt_tfrm)
--> 483 elif isinstance(args[0], ele.Part):
    484     # flip a Part, any subtype
    485     p = args[0]
    486     p.flip()

File ~/.conda/envs/rayOptics/lib/python3.10/typing.py:1498, in _ProtocolMeta.__instancecheck__(cls, instance)
   1490 def __instancecheck__(cls, instance):
   1491     # We need this method for situations where attributes are
   1492     # assigned in __init__.
   1493     if (
   1494         getattr(cls, '_is_protocol', False) and
   1495         not getattr(cls, '_is_runtime_protocol', False) and
   1496         not _allow_reckless_class_checks(depth=2)
   1497     ):
-> 1498         raise TypeError("Instance and class checks can only be used with"
   1499                         " @runtime_checkable protocols")
   1501     if ((not getattr(cls, '_is_protocol', False) or
   1502             _is_callable_members_only(cls)) and
   1503             issubclass(instance.__class__, cls)):
   1504         return True

TypeError: Instance and class checks can only be used with @runtime_checkable protocols

I don't know if I do something wrong (I would like to know what ...). I use rayoptics installed in a fresh new environment with anaconda. rayoptics version is, after conda :

rayoptics                 0.8.3              pyhd8ed1ab_0    conda-forge

thanks a lot, I am sorry to ask so many questions these days ...
Best regards,
Mike

[mjhoptics]

Quick note, this is an issue introduced in python 3.10. I have checked in a fix and will try to get a updated conda version by tomorrow.

[mikamyara]

"for me" there is no emergency : I can go back to Python 3.9 in a dedicated environment ...
However : thanks a lot !

[mjhoptics]

rayoptics 0.8.5 is available now thru pip or conda. This should address the problem under python 3.10.

A note about using catalog lenses. Many times the materials in the lens files are not in any of the major glass catalogs rayoptics searches. When a glass name can't be found in any catalog, a material with an index of 1.5 is substituted and called 'not glassname'. Note the material on surface #2 above is 'not B270'.
It turns out this glass is on the RefractiveIndex.INFO website. You can create a material using the opticalglass.rindexinfo module and substitute it for the fake material as follows:

import opticalglass.rindexinfo as rii
b270 = rii.create_material(*rii.read_rii_url('https://refractiveindex.info/database/data/glass/schott/misc/B270.yml'))
sm.gaps[2].medium = b270
opm.update_model()

Hope this helps. Questions are welcome :-)
Mike Hayford

[mikamyara]

Thanks a lot for that ! About materials, I guess you already did speak about it in a tutorial somewhere, I remember I did read about it.

Thanks again I will try !