From 2673066099557a4fe8c11c7676ecc73b875181f8 Mon Sep 17 00:00:00 2001 From: Phil Marshall Date: Mon, 27 Aug 2018 00:08:15 +0000 Subject: [PATCH] Added help() statements --- Visualization/AFW_Display_Demo.ipynb | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/Visualization/AFW_Display_Demo.ipynb b/Visualization/AFW_Display_Demo.ipynb index d5fddc42..be21db3e 100644 --- a/Visualization/AFW_Display_Demo.ipynb +++ b/Visualization/AFW_Display_Demo.ipynb @@ -150,7 +150,7 @@ "\n", "To plot an image to the screen, we must first load some data. In this tutorial, we will use the `Twinkles` simulated images available in the StackClub data repository. These data sit in the data directory `/project/shared/data/Twinkles_subset/output_data_v2` and contain a set of data produced in generating a calibrated exposure by the DM Stack. These data are organized in a structure that enables a DM Stack `Butler` instance to be generated and provide access to a single filter image (in this case `r` band), a specific detector raft (2,2), a specific sensor in the raft (`1,1`) and a specific visit (in this case, 235 -- note only one band is available per visit in this example).\n", "\n", - "Once we define a string that contains the data directory, we start the `Butler` instance using the `lsst.daf.persistence` library alias `dafPersist` and its function `Butler()`. The function `Butler()` takes as an argument a string containing the data directory we wish to access. Running the cell may take a few moments." + "Once we define a string that contains the data directory, we start the `Butler` instance using the `lsst.daf.persistence` library alias `dafPersist` and its `Butler` class. The `Butler` object is initialized with a string containing the data directory we wish to access. Running the cell may take a few moments." ] }, { @@ -256,7 +256,27 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "If you'd like to learn more about any given function, please see the [`lsst.afw.display` source code](https://github.com/lsst/afw/tree/master/python/lsst/afw/display)." + "If you'd like to learn more about any given function, please see the [`lsst.afw.display` source code](https://github.com/lsst/afw/tree/master/python/lsst/afw/display).\n", + "\n", + "You can also read the API documentation about the above functions using the Jupyter notebook `help()` function:" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "help(afw_display.scale)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "help(afw_display.mtv)" ] }, {