Unclear documentation of argument nsteps in Steps()

opticspy / lightpipes

LightPipes for Python, "Pure Python version"

https://opticspy.github.io/lightpipes/

BSD 3-Clause "New" or "Revised" License

232 stars 54 forks source link

Unclear documentation of argument nsteps in Steps() #26

Closed MaxGilljohann closed 6 years ago

MaxGilljohann commented 6 years ago

Hi there,

the command reference of Steps(z, nstep, refr, Fin) says

Propagates the field a distance, z, in nstep steps in a medium [...]

and to me that is a bit confusing. I would expect that the distance z is divided into n steps, but apparently the Field seems to be propagated n times the distance z through the medium.

Anyhow, thanks a lot for the development and the python port of lightpipes, it helps me a lot!

Best regards, Max

FredvanGoor commented 6 years ago

Hi Max,

I changed the description of the Steps command. Thank you for the comment.

Fred.

MaxGilljohann commented 6 years ago

Hi Fred,

thank you!

Best regards, Max