Skip to content
Snippets Groups Projects
Commit a4586f41 authored by Adam J. Jackson's avatar Adam J. Jackson
Browse files

Move Abins details to dev docs and expand content.

parent 67743e98
No related branches found
No related tags found
No related merge requests found
...@@ -36,24 +36,33 @@ whole number of *bin_width*. ...@@ -36,24 +36,33 @@ whole number of *bin_width*.
The histogram of data sampled in these N bins has N-1 "points", which The histogram of data sampled in these N bins has N-1 "points", which
should be aligned with the corresponding bin centres if plotted as a should be aligned with the corresponding bin centres if plotted as a
line. line. In the code this array of frequency coordinates is generally
named _freq_points_.
Broadening Broadening
---------- ----------
The legacy implementation of broadening uses a Gaussian kernel with a Earlier versions of Abins implemented a Gaussian kernel with a
fixed number of points spread over a range scaled to the peak width, fixed number of points spread over a range scaled to the peak width,
set by the *pkt_per_peak* and *fwhm* parameters in set by *pkt_per_peak* and *fwhm* parameters in
``AbinsParameters.sampling``. This method is not recommended, as ``AbinsParameters.sampling``. This method leads to aliasing when the
aliasing occurs when the x-coordinates are not commensurate with the x-coordinates are not commensurate with the histogram bin.
histogram bin.
.. image:: ../images/gaussian_aliasing.png .. image:: ../images/gaussian_aliasing.png
:align: center :align: center
These parameters are retained temporarily in order to allow a The safest way to avoid such trouble is for all broadening methods to
comparison with the newer broadening implementations, but will output onto the regular _freq_points_ grid. A number of broadening
not be used going forwards. implementations have been provided in
_AbinsModules.Instruments.Broadening_. It is up to the Instrument
logic to dispatch broadening calls to the requested implementation,
and it is up to specific Instruments to select an appropriate scheme
for their needs.
The advanced parameter *AbinsParameters.sampling['broadening_scheme']*
is made available so that this can be overruled, but it is up to the
Instrument to interpret this information. 'auto' should select an
intelligent scheme and inappropriate methods can be forbidden.
Deprecation plans Deprecation plans
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment