Skip to content

Commit

Permalink
Fix typos (ref #18)
Browse files Browse the repository at this point in the history
  • Loading branch information
saimn committed Feb 28, 2021
1 parent e4d3d37 commit 7946934
Show file tree
Hide file tree
Showing 15 changed files with 109 additions and 110 deletions.
32 changes: 16 additions & 16 deletions CHANGELOG
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@

- Fix `mpdaf.sdetect.Source.info` to correctly print header comments.

- Allow to use a correction for zero offset in `mpdaf.obj.CubeList.combine`.
- Allow one to use a correction for zero offset in `mpdaf.obj.CubeList.combine`.
[:pull:`163`]

- Fix precision issue with `mpdaf.obj.WCS.isEqual` and add precision keywords.
Expand Down Expand Up @@ -102,8 +102,8 @@ Removal of deprecated code:
- The self-calibration code has been removed (``PixTable.selfcalibrate`` and
``PixTable.sky_ref``). The self-calibration method is available in the DRS
since version 2.4, with the ``autocalib="deepfield"`` parameter. This should
be prefered as it is more efficient (no need to save the Pixtable to read it
in MPDAF), includes a few bug fixes, and allows to use the DRS
be preferred as it is more efficient (no need to save the Pixtable to read it
in MPDAF), includes a few bug fixes, and allows one to use the DRS
sky-subtraction after the autocalib. New DRS versions may also include more
features.

Expand Down Expand Up @@ -281,12 +281,12 @@ Misc
more required to run the setup, and it can be installed directly as
a dependency.

- Allow to pickle MPDAF objects (``Cube``, ``Image``, ``Spectrum``,
- Allow one to pickle MPDAF objects (``Cube``, ``Image``, ``Spectrum``,
``Source``). This makes it much easier to use these MPDAF objects with
``multiprocessing`` as they can now be passed transparently to the
subprocesses.

- Allow to specify the wavelength range in ``Cube.subcube_circle_aperture``.
- Allow one to specify the wavelength range in ``Cube.subcube_circle_aperture``.

- Speedup ``create_psf_cube``, ``moffat_image`` and ``gauss_image``.

Expand All @@ -299,7 +299,7 @@ Sources

- Better completions for Source attributes, and for keys in IPython.

- Allow to load a "fieldmap" from a dedicated file (in ``Source.add_FSF``).
- Allow one to load a "fieldmap" from a dedicated file (in ``Source.add_FSF``).

- New method to get FSF keywords from a Source (``Source.get_FSF``).

Expand All @@ -310,21 +310,21 @@ Catalog
causing errors with some operations due to bugs in the Astropy
implementations. Indexes can still be added manually if needed.

- Allow to pass additional Ellipse arguments to ``Catalog.plot_symb``.
- Allow one to pass additional Ellipse arguments to ``Catalog.plot_symb``.

- Allow to export coordinates from their columns to
- Allow one to export coordinates from their columns to
a ``astropy.coordinates.SkyCoord`` object (``Catalog.to_skycoord``) and to
ds9 region file (``Catalog.to_ds9_regions``).

- New methods ``Catalog.nearest``, to get the nearest sources with respect to
a given coordinate, and ``Catalog.match3Dline``, to match elements of the
current catalog with an other using spatial (RA, DEC) and a list of spectral
current catalog with another using spatial (RA, DEC) and a list of spectral
lines location.

- ``Catalog.plot_id`` is deprecated, in favor of ``Catalog.plot_symb`` with
``label=True``.

- Allow to use a mask in ``Catalog.select``.
- Allow one to use a mask in ``Catalog.select``.

- Add workaround for reading FITS table written with ``Catalog``, with Astropy
3.0 (because of a bug introduced with their new serialization feature, which
Expand Down Expand Up @@ -352,7 +352,7 @@ Sources

- Keep the original order of the header keywords in ``.info()``.

- Allow to set the size of a source without needing the white image.
- Allow one to set the size of a source without needing the white image.

- New option to add the white image directly within ``add_cube``.

Expand Down Expand Up @@ -396,7 +396,7 @@ Image

- Margin of 1/100th of pixel added in `~mpdaf.obj.Image.inside`.

- Allow to set the center outside the parent image in `~mpdaf.obj.Image.subimage`.
- Allow one to set the center outside the parent image in `~mpdaf.obj.Image.subimage`.

Cube
~~~~
Expand All @@ -421,7 +421,7 @@ Sources

- New optimal extraction algorithm for "CCD spectroscopy", Horne, K. 1986.

- Allow to set the order for the spline interpolation in
- Allow one to set the order for the spline interpolation in
`~mpdaf.sdetect.Source.add_image`.

Catalog
Expand Down Expand Up @@ -501,10 +501,10 @@ v2.1 (16/11/2016)
New Features
~~~~~~~~~~~~

* Allow to pass optional arguments when opening a FITS file, using the
* Allow one to pass optional arguments when opening a FITS file, using the
``fits_kwargs`` parameter.

* Allow to write ``CHECKSUM``/``DATASUM`` when saving a FITS file (use
* Allow one to write ``CHECKSUM``/``DATASUM`` when saving a FITS file (use
``checksum=True``). [:pull:`53`]

* ``Image`` and ``Spectrum`` objects keep now by default the type of the FITS
Expand Down Expand Up @@ -732,7 +732,7 @@ Pixtable

* Use a more efficient implementation for ``PixTable.sky_ref``.

* Allow to work on ``PixTable`` object without the ``.filename`` attribute.
* Allow one to work on ``PixTable`` object without the ``.filename`` attribute.

* Fix ``PixTable.divide_slice_median``.

Expand Down
2 changes: 1 addition & 1 deletion doc/muse.rst
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ from the AO telemetry information saved in the raw data.
Methods
-------

Various methods allow to get the FSF array (2D or 3D, as mpdaf Image or Cube)
Various methods allow one to get the FSF array (2D or 3D, as mpdaf Image or Cube)
for given wavelengths, or the FWHM in pixel and in arcseconds.

.. ipython::
Expand Down
4 changes: 2 additions & 2 deletions doc/objconvol.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ Convolution

`mpdaf.obj.Image.gaussian_filter <mpdaf.obj.Image.gaussian_filter>` applies gaussian filter to the image.

`mpdaf.obj.Image.fftconvolve <mpdaf.obj.Image.fftconvolve>` convolves the image with an other image using fft.
`mpdaf.obj.Image.fftconvolve <mpdaf.obj.Image.fftconvolve>` convolves the image with another image using fft.

`mpdaf.obj.Image.fftconvolve_gauss <mpdaf.obj.Image.fftconvolve_gauss>` convolves the image with a 2D gaussian.

`mpdaf.obj.Image.fftconvolve_moffat <mpdaf.obj.Image.fftconvolve_moffat>` convolves the image with a 2D moffat.

`mpdaf.obj.Image.correlate2d <mpdaf.obj.Image.correlate2d>` cross-correlates the image with an array/image.

`mpdaf.obj.Image.add_gaussian_noise <mpdaf.obj.Image.add_gaussian_noise>` adds Gaussian noise to image (in place).
`mpdaf.obj.Image.add_gaussian_noise <mpdaf.obj.Image.add_gaussian_noise>` adds Gaussian noise to image (in place).
36 changes: 18 additions & 18 deletions doc/oldchangelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ WCS
Data classes (Cube, Image, Spectrum)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Methods which transform the object return now by default an other object.
* Methods which transform the object return now by default another object.
The optional copy argument can be used to request that the input data be
transformed in-place.

Expand All @@ -172,7 +172,7 @@ Data classes (Cube, Image, Spectrum)
* `Cube.get_image <mpdaf.obj.Cube.get_image>`: add input parameters in the
FITS header.

* Allow to overwrite `BUNIT` for data without unit.
* Allow one to overwrite `BUNIT` for data without unit.

* Fix `EXPTIME` of combined cubes when cubes overlap (using a median of the
exposure map give a more realistic estimate).
Expand Down Expand Up @@ -212,7 +212,7 @@ Sources

* Tell which keyword is missing when creating a source.

* Allow to deactivate the masking of invalid values when loading a source.
* Allow one to deactivate the masking of invalid values when loading a source.
This part (`~mpdaf.sdetect.Catalog.masked_invalid`) takes ~40% of the
total load time for sources with a lot of tables and columns.

Expand Down Expand Up @@ -242,7 +242,7 @@ Pixtable
* Fix initial value for `~mpdaf.drs.PixTable.subtract_slice_median` correction.
This value was set to 1 which seems wrong for an additive correction. To
emphasize the fact that some combination of slices and quadrants are not
valid, and allow to filter these values later, this commit changes the init
valid, and allow one to filter these values later, this commit changes the init
value for the count to -1, and the correction to NaN.

* Fix `~mpdaf.drs.PixTable.select_sky` in the case of positioned pixel table.
Expand Down Expand Up @@ -275,7 +275,7 @@ v1.2 (13/01/2016)
* Correct ``cube.get_step`` that returned nothing.
* Use setuptools for the ``setup.py``:

- Allow to use develop mode (``python setup.py develop``).
- Allow one to use develop mode (``python setup.py develop``).
- Install dependencies automatically.
- Use optional dependencies.

Expand All @@ -298,7 +298,7 @@ PixTable
pixtables.
* Remove ``cos(delta)`` correction for positioned pixtables.
* Use directly the binary mask in ``extract_from_mask``.
* Allow to use a boolean mask for pixtable selections.
* Allow one to use a boolean mask for pixtable selections.

Sources
~~~~~~~
Expand All @@ -308,7 +308,7 @@ Sources
* Add methods to manage a history in the sources headers.
* Use ``savemask='none'`` for MASK and SEG extensions.
* Correct bug in ``source.write`` when a column has no unit.
* Allow to pass the lambda range and wave unit to ``Source.extract_spectra``.
* Allow one to pass the lambda range and wave unit to ``Source.extract_spectra``.
* Correct bug in Catalog initialization due to units.
* ``Catalog.from_sources``: update the default format.
* Split ``Source.add_masks`` in 3 methods: ``find_sky_mask``,
Expand All @@ -331,7 +331,7 @@ Breaking changes

* Add a new base class for the :class:`~mpdaf.obj.Cube`,
:class:`~mpdaf.obj.Image` and :class:`~mpdaf.obj.Spectrum` classes. This
allows to fix some inconsistencies between these classes and to bring more
allows one to fix some inconsistencies between these classes and to bring more
easily new common features.

* FITS files are now read only when the data is needed: when creating an object
Expand All @@ -347,7 +347,7 @@ Breaking changes
- Spectrum's shape is now a tuple, which is consistent with the Cube and Image
classes, and with Numpy arrays.

* Allow to specify the data type of Cube/Image/Spectrum in the constructor (and
* Allow one to specify the data type of Cube/Image/Spectrum in the constructor (and
read an extension as an integer array).

* Change the behavior of the ``.clone`` method: now by default it returns an
Expand Down Expand Up @@ -386,7 +386,7 @@ Changes that should be imperceptible to users

* Use ``astropy.wcs`` for handling the wavelength coordinates.
* Simplify logging configuration.
* Cube/Image/Spectrum constructors: allow to pass a hdulist object in place of
* Cube/Image/Spectrum constructors: allow one to pass a hdulist object in place of
the filename (this option should reduce the time when the FITS file is used
several times because of the big time spent reading the FITS headers).

Expand Down Expand Up @@ -415,7 +415,7 @@ v1.1.18 (08/07/2015)
* Optimize C libraries using openmp (cubes combination).
* Update WCS according to FITS standard.
* Modify ``Spectrum.log_plot`` to be the same as plot with a log stretch.
* Allow to create a cube object with a masked array.
* Allow one to create a cube object with a masked array.
* Correct bug in ``mask_polygon`` function of Image object.
* Possibility to use MAD (median absolute deviation) statistics for
sigma-clipping during cube combination.
Expand Down Expand Up @@ -447,7 +447,7 @@ v1.1.18 (08/07/2015)

- Add needed keywords: RA, DEC, MJD-OBS, DATE-OBS, PI-COI, OBSERVER, OBJECT,
ESO INS DROT POSANG, ESO INS MODE
- Allow to override OBJECT name
- Allow one to override OBJECT name
- Compute a correct EXPTIME for the mosaic case
- Put the list of merged files in comments, otherwise the keyword value can be
too long for MuseWise
Expand All @@ -464,7 +464,7 @@ v1.1.17.1
* Optimize c libraries using openmp.
* Update WCS according to FITS standard.
* Modify ``Spectrum.log_plot`` to be the same as plot with a log stretch.
* Allow to create a cube object with a masked array.
* Allow one to create a cube object with a masked array.
* Corrected bug in ``mask_polygon`` function of Image object.

v1.1.17 (16/06/2015)
Expand Down Expand Up @@ -494,7 +494,7 @@ v1.1.17 (16/06/2015)
* Refactor common part of PixTable.extract
* Remove 'ESO PRO' keywords writing in PixTable.
This was changed a long time ago and is not useful anymore.
* Allow to extract data from a PixTable with stack numbers.
* Allow one to extract data from a PixTable with stack numbers.
* Add a param to PixTable.extract to choose if multiple selection are combined
with logical_and (default) or logical_or.
* Refactor ``get_*`` methods of PixTable.
Expand Down Expand Up @@ -618,7 +618,7 @@ v1.1.14 (21/01/2015)
* compute the reference sky spectrum from a pixel table
* method mask_image that creates a new image from a table of apertures.
* update Image.mask and Image.mask_ellipse methods
* allow to apply a slice on all the cubes of a CubeList.
* allow one to apply a slice on all the cubes of a CubeList.
* Image/Cube/CubeDisk: correct truncate methods
* PixTable: new methods to bring all slices to the same median value
(using sky reference spectrum)
Expand Down Expand Up @@ -765,7 +765,7 @@ v1.1.1 (29/08/2013)
* correct bug in WCS.isEqual
* correct fscale value in multiprocess functions of Cube
* optimize interactive plots
* update Channel.get_trimmed_image to do bias substraction
* update Channel.get_trimmed_image to do bias subtraction
* update Image.segment with new parameters
* add warnings according to M Wendt comments
* added method to plot a RawFile object
Expand Down Expand Up @@ -807,7 +807,7 @@ v1.0.2 (19/11/2012)
* ima[:,q] or ima[p,:] return Spectrum objects and not 1D images
* link on new version of HyperFusion
* Image: add iterative methods for Gaussian and Moffat fit
* Image: remove matplotlib clear before ploting
* Image: remove matplotlib clear before plotting
* fusion: update FSF model
* Spectrum/Image/Cube .primary_header and .data_header attributes
* fusion: add copy and clean, continue_fit methods
Expand Down Expand Up @@ -865,7 +865,7 @@ v1.0.1 (27/09/2012)
* Pixtable: optimize and split origin2coords in multiple helpers
* Update WCS object accoriding to the python notation : (dec,ra)
* Image: add methods to mask/unmask the image.
* Udpate the python interface for HyperF v1.1
* Update the python interface for HyperF v1.1
* Add euro3D package
* Correct error with new version of pywcs (remplace 'UNITLESS' by '' for unit type)
* Compatibility with pyfits 3.0 (The Header.ascardlist() method is deprecated,
Expand Down
12 changes: 6 additions & 6 deletions doc/pixtable.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ un-resampled until the very last step. The pixel tables used for this purpose
can be saved at each intermediate reduction step and hence contain lists of
pixels together with output coordinates and values. The pixel tables values
and units change according to the reduction step. Please consult the data
reduction user manual for further informations.
reduction user manual for further information.

The `~mpdaf.drs.PixTable` object is used to handle the MUSE pixel tables
created by the data reduction system. The PixTable object can be read and write
Expand Down Expand Up @@ -52,7 +52,7 @@ that the `~mpdaf.MUSE` package provides a `~mpdaf.MUSE.Slicer` class
to convert the slicer number between various numbering schemes.


Read a pixtable, display informations and extract a smaller pixtable centered around an object
Read a pixtable, display information and extract a smaller pixtable centered around an object
==============================================================================================

Preliminary imports::
Expand All @@ -64,7 +64,7 @@ Preliminary imports::
In [3]: from mpdaf.drs import PixTable

We read the `~mpdaf.drs.PixTable` from the disk and check its basic
informations (`~mpdaf.drs.PixTable.info`) and FITS header content::
information (`~mpdaf.drs.PixTable.info`) and FITS header content::

In [4]: pix = PixTable('PIXTABLE-MUSE.2014-07-26T04:37:08.541.fits')

Expand Down Expand Up @@ -364,14 +364,14 @@ Self-calibration method for empty fields

.. note::
The self-calibration method is available in the DRS since version 2.4, with
the ``autocalib="deepfield"`` parameter. This should be prefered as it is
the ``autocalib="deepfield"`` parameter. This should be preferred as it is
more efficient (no need to save the Pixtable to read it in MPDAF), includes
a few bug fixes, and allows to use the DRS sky-subtraction after the
a few bug fixes, and allows one to use the DRS sky-subtraction after the
autocalib. New DRS versions may also include more features.

**The implementation in MPDAF has been removed in v3.2**.

The self-calibration method works on a pixel table and allows to bring all
The self-calibration method works on a pixel table and allows one to bring all
slices to the same median value. This is useful to remove residual IFU and
slice mean level variations. It was designed to work on sparse fields, where
objects are small compared to the size of a slice. This is because it needs to
Expand Down

0 comments on commit 7946934

Please sign in to comment.