GalSim-developers / GalSim

The modular galaxy image simulation toolkit. Documentation:
http://galsim-developers.github.io/GalSim/
Other
227 stars 107 forks source link

Change withOrigin -> shiftOrigin for non-local WCS types #1085

Closed rmjarvis closed 4 years ago

rmjarvis commented 4 years ago

This is a quick hit to address issue #1073.

For non-local WCS types, the name withOrigin is deprecated in favor of shiftOrigin. The functionality hasn't changed, but the name withOrigin is only really appropriate for LocalWCS types. When the WCS already has a non-zero origin, then the action takes in really to shift the origin, not set a new value.

I kept the name withOrigin for local WCS types where I think it is more intuitive and accurately describes the action taken. Both names are available for LocalWCS types and they are equivalent.

I also updated the docs a bit to hopefully make the action that is happening here somewhat clearer.