adding new cutout sync section 4 to image cutout nb

Author: christinawilliams

DP1/100_How_to_Use_RSP_Tools/103_Image_access_and_display/103_4_Small_Image_Cutout.ipynb

@@ -324,7 +324,9 @@
    "id": "d945e191-7ee4-458a-bb0f-fb00cd219e30",
    "metadata": {},
    "source": [
-    "Lastly, call the Rubin Image Cutout Service. This is the IVOA procedure `cutout-sync` that is called using `get_adhocservice_by_id`. It is done by feeding the data link created above (called `dl_result`) to `from_resource`. Since the Rubin DP1 imaging is proprietary it is necessary to again provide the authorization for the current RSP session. Do this using the `get_pyvo_auth` function."
+    "Lastly, call the Rubin Image Cutout Service. Three types of cutout services exist: `cutout-sync` which, by default, returns just the image extension of the LSST imaging; `cutout-sync-exposure`, which returns the full set of metadata and image extensions that are contained in the `ExposureF` data type; and `cutout-sync-mask` which contains just the mask extension. This section will demonstrate the use of `cutout-sync-exposure` and Section 4 below will demonstrate the other two. \n",
+    "\n",
+    "To use the cutout service in this example, the IVOA procedure `cutout-sync-exposure` is called using `get_adhocservice_by_id`. It is done by feeding the data link created above (called `dl_result`) to `from_resource`. Since the Rubin DP1 imaging is proprietary it is necessary to again provide the authorization for the current RSP session. Do this using the `get_pyvo_auth` function."
    ]
   },
   {
@@ -386,15 +388,15 @@
     "sq.raise_if_error()\n",
     "mem = MemFileManager(len(cutout_bytes))\n",
     "mem.setData(cutout_bytes, len(cutout_bytes))\n",
-    "exposure = ExposureF(mem)"
+    "exposure = ExposureF(mem)\n"
    ]
   },
   {
    "cell_type": "markdown",
    "id": "324be87a-337b-4db7-b57d-842f14614613",
    "metadata": {},
    "source": [
-    "Display the cutout."
+    "Display the image extension of the `ExposureF` cutout."
    ]
   },
   {
@@ -502,7 +504,7 @@
    "outputs": [],
    "source": [
     "sqp = SodaQuery.from_resource(dl_result,\n",
-    "                              dl_result.get_adhocservice_by_id(\"cutout-sync\"),\n",
+    "                              dl_result.get_adhocservice_by_id(\"cutout-sync-exposure\"),\n",
     "                              session=get_pyvo_auth())\n",
     "\n",
     "ra_edge = 0.02 * u.deg\n",
@@ -565,7 +567,7 @@
    "outputs": [],
    "source": [
     "sq2 = SodaQuery.from_resource(dl_result,\n",
-    "                              dl_result.get_adhocservice_by_id(\"cutout-sync\"),\n",
+    "                              dl_result.get_adhocservice_by_id(\"cutout-sync-exposure\"),\n",
     "                              session=get_pyvo_auth())\n",
     "\n",
     "edge1 = Radius\n",
@@ -604,7 +606,7 @@
     "cosd = np.cos(a.radian)\n",
     "\n",
     "sq3 = SodaQuery.from_resource(dl_result,\n",
-    "                              dl_result.get_adhocservice_by_id(\"cutout-sync\"),\n",
+    "                              dl_result.get_adhocservice_by_id(\"cutout-sync-exposure\"),\n",
     "                              session=get_pyvo_auth())\n",
     "\n",
     "sq3.polygon = (spherePoint.getRa().asDegrees() * u.deg - edge1/cosd,\n",
@@ -674,6 +676,117 @@
     "The zooniverse package should be used instead of this procedure for citizen science applications. "
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "99e75a7a-348e-409e-88f6-871b68a4e9dc",
+   "metadata": {},
+   "source": [
+    "## 4. Other cutout service data types\n",
+    "\n",
+    "As mentioned in Section 3, there are three types of cutout services: cutout-sync-exposure to return an `ExposureF` type image with all LSST image extensions (demonstrated above); cutout-sync which returns just the image extension, and and cutout-sync-mask which contains just the mask extension. The latter 2 will be demonstrated below.\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "c2c8ab4c-cd1d-4ae8-937d-b34a21035e1e",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from astropy.io import fits\n",
+    "import io\n",
+    "\n",
+    "print(results[0])\n",
+    "datalink_url = results[0].access_url\n",
+    "dl_result = DatalinkResults.from_result_url(datalink_url,\n",
+    "                                            session=get_pyvo_auth())\n",
+    "\n",
+    "f\"Datalink status: {dl_result.status}. Datalink service url: {datalink_url}\"\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "837fbd2a-c3e2-4ee3-a06d-69f4df50823b",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "\n",
+    "sq5 = SodaQuery.from_resource(dl_result,\n",
+    "                             dl_result.get_adhocservice_by_id(\"cutout-sync\"),\n",
+    "                             session=get_pyvo_auth())\n",
+    "\n",
+    "spherePoint = geom.SpherePoint(target_ra*geom.degrees, target_dec*geom.degrees)\n",
+    "Radius = 0.01 * u.deg\n",
+    "sq5.circle = (spherePoint.getRa().asDegrees() * u.deg,\n",
+    "             spherePoint.getDec().asDegrees() * u.deg,\n",
+    "             Radius)\n",
+    "\n",
+    "cutout_bytes = sq5.execute_stream().read()\n",
+    "sq5.raise_if_error()\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "516dbd86-d573-4d81-a017-2ebbce8fb445",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "mem = MemFileManager(len(cutout_bytes))\n",
+    "mem.setData(cutout_bytes, len(cutout_bytes))\n",
+    "\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "ed3f7908-a256-42f5-939f-61f38645c7ca",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "data = mem.getData()   # returns `bytes`\n",
+    "\n",
+    "# this doesn't work\n",
+    "import lsst.afw.image as afwImage\n",
+    "\n",
+    "#image = afwImage.ImageF(mem)\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "d23a0397-6500-4e36-b956-7917ed6a7173",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "\n",
+    "#data = mem.getData()\n",
+    "hdul = fits.open(io.BytesIO(data))\n",
+    "hdul.info()\n",
+    "\n",
+    "image_hdu = hdul[1]        # IMAGE extension\n",
+    "image_data = image_hdu.data  # NumPy array\n",
+    "#image = afwImage.ImageF(image_data)\n",
+    "image = afwImage.ImageF(image_data.astype(\"float32\"))\n",
+    "print(type(image_data))   # numpy.ndarray\n",
+    "print(type(image))        # lsst.afw.image._image.ImageF\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "1aa9009a-b493-41ea-bc3c-e0c79adef913",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "\n",
+    "display = afwDisplay.Display()\n",
+    "display.scale('asinh', 'zscale')\n",
+    "display.image(image)\n",
+    "plt.show()"
+   ]
+  },
   {
    "attachments": {
     "923e951d-30c0-4a8f-a1b0-8bb851f1cb5f.png": {
@@ -684,7 +797,7 @@
    "id": "acbe9638-e7b7-4229-8301-3f57eb0b0c5b",
    "metadata": {},
    "source": [
-    "## 4. Exercise for the learner\n",
+    "## 5. Exercise for the learner\n",
     "\n",
     "Reproduce the cutout below, whose center is (ra, dec) = 59.1, -48.8 with 0.06 degrees on a side.\n",
     "\n",