diff --git a/doc/HRIXS.ipynb b/doc/HRIXS.ipynb index 7278b136dd2dc10cd9954acefb2af6e9e05233ab..e6f31903f9fdc073723dda50d40003c5d68bc483 100644 --- a/doc/HRIXS.ipynb +++ b/doc/HRIXS.ipynb @@ -1626,7 +1626,8 @@ "source": [ "## finding the curvature\n", "\n", - "there is an automatic procedure to find the curvature for an HRIXS operation point." + "there is an automatic procedure to find the curvature for an HRIXS operation point.\n", + "The method `find_curvature` takes a run, integrates the images and fits the curvature parameters to it. During the fit, it will use the current curvature as starting values. It outputs the new curvature parameters, together with a plot of the curvature overlayed on top of the data, where the starting values are shown in blue, while the fitted curve is in orange.\n" ] }, { @@ -1660,7 +1661,7 @@ ], "source": [ "h.Y_RANGE = slice(700, 900) # tell the algorithm where the data actually is\n", - "h.find_curvature(1, 3485) # use run 272 of proposal 2769 to fit the curvature" + "h.find_curvature(1, 3485) # use run 1 of proposal 3485 to fit the curvature" ] } ], diff --git a/doc/changelog.rst b/doc/changelog.rst index cc9779f352ee9d5375cc37cf60a0653a5bd9fbf0..f94e2143ebb0c08779b7170eb3eca16fb0187cc5 100644 --- a/doc/changelog.rst +++ b/doc/changelog.rst @@ -18,6 +18,7 @@ unreleased - Documentation on extracting digitizer peaks, clean up of digitizer functions :mr:`215` - Improved peak-finding algorithm for digitizer traces :mr:`216`, :mr:`227` - Only load bunch pattern table when necessary :mr:`234` + - Document the HRIXS class :mr:`238` - **New Features**