Reaction Plane Fit 4.0

[4.0] - 21 October 2019

Added

• Additional documentation. See: c49fa75.
• Integration test for differential signal fit. See: efcfc40.

Changed

• Switch emphasis to fitting before normalizing by the number of triggers, including updating default arguments and documentation. See: 17a5d24, e04a1f3, 73f5f0d.
• When reading the RP fit object from YAML, setup the entire fit object. See: 1b38175.
• Improve Minuit fit strategy. See: d8dfb49.
• Rename _fit to cost_func for clarity - it represents the cost function, not the fit function. And it's sometimes useful to access from outside the object (such as when calculating effective chi squared). See: 3dc7501.
• Make the Minuit verbosity a user settable option. See: 22e67c8.
• Allow a user to skip HESSE when necessary. This should be rare, but it is required at times. See: 9810408.
• Updated the signal differential fit procedure. The inclusive case is just treated as a background only fit. This is required because adding coupling gaussian distributions is not a straightforward process (unlike if they were uncoupled). Consequently, extracting the inclusive width relies on fitting to information already included in the RP fit (included via the differential signal fit components), which means that the covariance of the fit is neglected. Use care when using this fit approach! (A warning is thrown when using it). See: 7ba221d.
• Sample data now acts as if it is the raw correlation rather than scaled by the number of triggers. See: 5c613d2, 9484b45, 5c613d2, and 7db8ea4.
• Improve testing procedure by loading stored fits from YAML rather than defining them by hand in the test file. This makes any future updates much easier. See: 5c613d2.

Fixed

• Log likelihood fits by updating the underlying pachyderm.fit package. See: 33bdcb4.
• Minor typos in code, documentation. See: 150afbb and 56af275.
• Create output directory when writing if necessary. See: 7ca7f01.
• Allow specification of v_{1} values. See: ed037ba and a fix in 63cb499.
• Updated typing. See: db79b41.
• Integration tests run successfully on TravisCI again. See: 330c3bc.

Reaction Plane Fit 3.1

[3.1] - 24 August 2019

Changed

• Added a method to create a full set of fit components for each EP orientation, regardless of which were used for the fit. This allows for downstream code to not need to differentiate between the different cases for most tasks, easing the user experience. See: Nearly all of the commits between 3.0 and 3.1.
• Use the pachyderm.fit.BaseFitResult for components in order to avoid needing to calculate unnecessary values for component fit results. It's more natural. See: bbbcac4.
• Updated the included test data for better test consistently with external sources. See: 0bf5e1c.
• Updated pre-commit hooks. See: 6d78054.

Fixed

• Warning about registering pytest marks. See: 8f6f538.
• Removed final probfit dependence. See: b94ea05.

Reaction Plane Fit 3.0

[3.0] - 8 August 2019

Changed

• Move to using the pachyderm fit package for general fit functionality, cost functions, and fit results. This move was instigated by the recognition that probfit cost functions didn't actually work properly with pre-binned data. It also allows for the centralization of basic fit code to make it generally available. Some code from this package was refactored into pachyderm. See: 9e62f67 and 0f66cff. Note that developed was handled in a private branch in this repository, so some older commits have references to a fit package in the RPF package before it was moved to pachyderm.
• No longer rely on probfit. All functionality and more is now provided in pachyderm.fit. Plus, the package wasn't super actively maintained. See: 9e62f67.
• Updated pre-commit hooks. See: 0384449.

Fixed

• Log likelihood and chi squared cost functions properly take binned data into account. See: 0f66cff.

Reaction Plane Fit 2.1.2

[2.1.2] - 4 May 2019

Added

• Enabled strict mypy checks. See: 1585c73.

Changed

• Improved typing. 341330a.

Reaction Plane Fit 2.1.1

[2.1.1] - 3 May 2019

Changed

• Refactor function error calculation so that it can used by other packages. See: 04dff6c.

Fixed

• Enable fixing parameters via user arguments. See: cf9de68.
• Properly mark the package as typed. See: fe43d53.
• Improved code formatting and typing information, and fixed typos.
• Fix mypy typing in third party packages by adding zip_safe = False in the setup.py. See: 79eb4e8.

Reaction Plane Fit 2.1

[2.1] - 29 March 2019

Added

• Calculate the correlation matrix in the fit result. See: ee94cb8.
• Read and write fit results with YAML, including integration tests. See: 983a251.
• Added test for invalid fit arguments. See: 009a974.

Changed

• Modify the ReactionPlaneFit.fit(...) to return the minuit object for advanced use cases. The fit result stores almost all of the minuit information, but it can be useful in limited circumstances. For now, it is only used to check the correlation matrix calculation. See: 7a1efd9.
• Initialize the component fit functions when defining the fit objects. This allows fit components to be evaluated using stored fit results. See: e2673f2.
• Updated typing information. See: 0f284c7 and 60af852.
• Updated documentation. See: b94fc95.
• Updated pre-commit hooks with newer versions of the packages. See: 6d54231.

Reaction Plane Fit 2.0

[2.0] - 22 February 2019

Note the API changes introduced by moving the fit results to the components!

Added

• Store errors on fit parameters. See: fbb9bd3.
• Evaluate the background function of a component. For a background fit component, this is the same as the fit function, while for a signal fit component, this will describe only the
  background contributions. See: 8836a38.
• Preliminary instructions on running the fit via c++. They are not yet tested. See: 8f6d57c.

Changed

• Moved component fit results into the fit components. See: a08c42a and 51ef750.
• Moved fit evaluation into the fit component. This was enabled by moving the fit results into the fit components. See: e3c1395.
• Moved FitType to the base module so that it is more easily accessible. See: f3513c9.
• Moved error calculation to fit component. See: 674c8cf.
• Refactor error calculation to allow it to calculate errors for both the fit and background functions (or any other function). See: 674c8cf.
• Improved example plot styling. See: eb9fe16 (included with a few other minor changes).
• Determine and plot errors on residual. See: 74b7f14.
• Large improvements to typing information and documentation in a variety of commits.

Fixed

• Background fit example legend placement was accidentally moved. See: 1869eb0.
• Baseline test images, which started failing after a number of small aesthetic changes. See: 795d9d2 and 33f9dd8.
• Failing tests due to floating point variations in calculating parameter errors. The comparison tolerances had to be loosened. See: e668599 and
  f2729a4.
• Indicate that the package is typed. The typing information is already there - it just didn't know it propagate it when running mypy on other packages. See:
  b113e40.
• Updated call to the old pachyderm.Histogram1D API. See: f23f314.

Removed

• evaluate_fit_component(...) from the ReactionPlaneFit object. It is unnecessary given the API changes. See 5e2048e.

Reaction Plane Fit 1.2

[1.2] - 30 January 2019

Added

• Added mypy to Travis CI checks. See: 3fe44b4.
• Pre-commit hooks configuration to the repository based on pre-commit. This should generally improve the quality of commits. Currently includes flake8, mypy, yamllint, and some
  additional minor python checks. See: e0218df and a40c72e.
• Ability to run Minos errors. They aren't stored (because it doesn't make sense to do so), but they can be compared to Hesse errors. See: b014909.
• Allow for user arguments to override the fit arguments. See: bf570c3.

Changed

• Adapted to new pachyderm histogram API. See: c6b17fe.
• To implement the new API, it required some relaxation of array comparison tolerances (but they are still quite stringent). See: 631db84.
• Renamed "inPlane" -> "in_plane" (and the other angles accordingly) for better matching of conventions (which makes it easier to use and integrate with other packages). See:
  300258f.
• Updated RP plot labeling for new RP orientation naming convention. See: 7a9e939.

Fixed

• A number of type annotation issues identified by mypy. See: 8b71c77.
• Test discovery failed in some cases. See: 85e5ad0

Reaction Plane Fit 1.1

[1.1] - 11 December 2018

Added

• Test the FitComponentResult objects in the integration tests. See: dcb2196.
• Updated documentation.
• mypy to the dev requirements. Although not run in the CI (because not all of the identified issues are actually issues), it is good to have available and run from time to time. See:
  bdc216a.

Changed

• Refactored Histogram class to pachyderm, where it was renamed Histogram1D. See: 923c384.

Reaction Plane Fit 1.0.1

[1.0.1] - 30 November 2018

Note: 1.0.1 resolves a tagging problem related to a rebase. The 1.0 change log is below:

Added

• Zenodo DOI information.
• Chi2/ndf calculation.
• Plot module (with tests) to draw the fit and the residual.
  • The tests take advantage of image comparion.
• Additional fit quality checks.

Fixed

• Parameter argument ordering in the signal inclusive fit. See ba4e833.
• Fixed error propagation by calculating the error for each individual component rather than for the simultaneous fit (which was the wrong approach). This has the side effect of substantially speeding up the error calculation.
• Specify all initial parameters, limits, and steps, which can substantially improve the chi2.
• Various type annotations.