Skip to content

Commit

Permalink
fix broke release notes, missed on git merge
Browse files Browse the repository at this point in the history
  • Loading branch information
brandondube committed Oct 8, 2019
1 parent 82f8ff1 commit 231263c
Showing 1 changed file with 0 additions and 19 deletions.
19 changes: 0 additions & 19 deletions docs/source/releases/v0.17.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,18 +33,9 @@ Note that this list is in logical order of dependence, not in order of importanc
* * * :class:`~prysm.qpoly.QBFSSag`
* * * :class:`~prysm.qpoly.QBFSCache`
* * QCon:
<<<<<<< HEAD
* * * :class:`~prysm.qpoly.QCONSag`
* * * :class:`~prysm.qpoly.QCONCache`
* * 2D-Q:
* * * :class:`~prysm.qpoly.Q2DSag`
* * * :class:`~prysm.qpoly.Q2DCache`
* 1D polynomials (Qbfs and Qcon) take keyword arguments A0..An with no limit. 2D polynomials (2D-Q) take arguments of Am_n
=======
* * * :code:`~prysm.qpoly.QCONSag`
* * * :code:`~prysm.qpoly.QCONCache`
* 1D polynomials (Qbfs and Qcon) take keyword arguments A0..An with no limit.
>>>>>>> dev
* Check the :mod:`~prysm.qpoly` docs for the "raw" functions.
* :code:`__str__` dunder method for :class:`~prysm.interferogram.Interferogram` objects.
* :class:`prysm.otf.OTF` and :class:`~prysm.otf.PTF` for Optical Transfer Function and Phase Transfer Function analysis.
Expand All @@ -66,11 +57,7 @@ Note that this list is in logical order of dependence, not in order of importanc
* * * :code:`(obj).exact_xy` for 2D sampling on (x, y)
* * * :code:`(obj).exact_polar` for 2D sampling on (r, p)
* Units rewrite:
<<<<<<< HEAD
* * prysm now utilizes / understands `astropy.units <https://docs.astropy.org/en/stable/units/>`_ for all calculations using the object-oriented API. :class:`BasicData` has become :class:`RichData` with new :code:`xy_unit` and :code:`z_unit` kwargs. If this is :code:`None`, the instance will adopt :code:`config.<class>.default_<xy or z>_units`. These default units mimic the behavior of prysm < 0.17, so users not adjusting units will feel no change. To use custom units, the :code:`spatial_unit`, and :code:`phase_unit` arguments are no more, and should be generated loosely as follows: For more information, see the `units documentation <../user_guide/units-and-labels.html>_.
=======
* * prysm now utilizes / understands `astropy.units <https://docs.astropy.org/en/stable/units/>`_ for all calculations using the object-oriented API. :class:`BasicData` has become :class:`RichData` with a new :code:`xy_unit` and :code:`z_unit` kwarg. If this is :code:`None`, the instance will adopt :code:`config.<class>.default_<xy or z>_units`. These default units mimic the behavior of prysm < 0.17, so users not adjusting units will feel no change. To use custom units, the :code:`spatial_unit`, and :code:`phase_unit` arguments are no more, and should be generated loosely as follows: For more information, see the `units documentation <../user_guide/units-and-labels.html>`_.
>>>>>>> dev
* Labels rewrite:
* * prysm now has a labels system that mimics the units system. The constructor works loosely as follows:

Expand All @@ -96,11 +83,6 @@ Breaking changes
================

* Slicing and plotting refactoring breaks compatibilty with the prysm <= v0.16 API.
<<<<<<< HEAD
* * :class:`BasicData` has become :class:`~prysm._richdata.RichData`.
* * Universal plotting breaks much code that any of :code:`plot2d`, :code:`plot_slice_xy`, :code:`plot_azimuthal_average`, :code:`plot_psd_slices`, :code:`plot_psd_2d` or other plotting functions, or accesses :code:`.slice_x` and :code:`.slice_y` attribute variables. For plots, see :code:`.plot2d()` and :code:`.slices().plot()`. For slices, see :code:`.slices.<x,y,z,... as enumerated above>`. To replicate the power law limits in plot_psd_slices, use :func:`prysm.plotting.add_psd_model`.
* * :attr:`tan` and :attr:`sag` properties removed from :class:`~prysm.otf.MTF` instances as well as :meth:`exact_tan` and :meth:`exact_sag`. These are now accessed via :code:`mtf.slices().x` and :code:`mtf.slices().y` and :meth:`~prysm.otf.MTF.exact_x` and :meth:`~prysm.otf.MTF.exact_y`. Likewise, for :meth:`mtf.azimuthal_average`, use :code:`mtf.slices().azavg`. The changes to tan and sag are made because it is not guaranteed that the x and y slices of the MTF correspond to tan and sag without more information given about field angles. This is not something prysm has any knowledge of at this time.
=======
* * :class:`BasicData`, has become :class:`~prysm._richdata.RichData`.
* * Universal plotting elimiates or changes the signature of many methods:
* * * :meth:`prysm.psf.PSF.plot2d` - use the same method name, note that arguments are different. For the :code:`circle_ee` functionality, use :func:`prysm.plotting.annotate_psf`.
Expand All @@ -110,7 +92,6 @@ Breaking changes
* * * default axis limits for PSFs and MTFs are no longer 20 and 200, but are the entire support of the object.
* * :code:`.slice_x` and :code:`.slice_y` on :class:`~prysm._phase.OpticalPhase`, :class:`~prysm.psf.PSF` and :class:`~prysm.otf.MTF` - use :code:`<obj>.slices().x or <obj>.slices().y`
* * :attr:`tan` and :attr:`sag` properties deprecated on :class:`~prysm.otf.MTF` instances as well as :meth:`exact_tan` and :meth:`exact_sag`. Please access via :code:`mtf.slices().x` and :code:`mtf.slices().y` and :meth:`~prysm.otf.MTF.exact_x` and :meth:`~prysm.otf.MTF.exact_y`. Likewise, for :meth:`mtf.azimuthal_average`, use :code:`mtf.slices().azavg`. These properties and functions will be removed in prysm v0.18. The changes to tan and sag are made because it is not guaranteed that the x and y slices of the MTF correspond to tan and sag without more information given about field angles. This is not something prysm has any knowledge of at this time.
>>>>>>> dev
* * :meth:`prysm.interferogram.Interferogram.psd` now returns a :class:`~prysm.interferogram.PSD` object, which is just a fancy :class:`~prysm._richdata.RichData` instance like any other prysm class.
* :meth:`prysm.psf.PSF.from_pupil` normalization with :code:`norm=radiometric` has changed to match Born & Wolf. Results using this kwarg generated with prysm >= 0.17 will not match those for prysm < 0.17 in terms of scaling. The contents will be otherwise the same.
* :class:`~prysm.pupil.Pupil` and subclasses no longer take arguments of :code:`mask` and :code:`mask_target`, instead taking :code:`phase_mask` and :code:`transmission`. This should improve clarity. Arguments may take a few forms - :code:`<ndarray>`, :code:`<str>`, or :code:`[<str>, <float>]`. In the ndarray case, the argument is used directly. Strings are passed to the mask cache with implicit :code:`radius=1`, while in the last case the argument is a tuple or list of the mask shape and radius.
Expand Down

0 comments on commit 231263c

Please sign in to comment.