adss 1.32__tar.gz → 1.34__tar.gz

{adss-1.32 → adss-1.34}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: adss
-Version: 1.32
+Version: 1.34
 Summary: Astronomical Data Smart System
 Author-email: Gustavo Schwarz <gustavo.b.schwarz@gmail.com>
 Project-URL: Homepage, https://github.com/schwarzam/adss
@@ -9,6 +9,7 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: pyarrow
+Requires-Dist: httpx
 Requires-Dist: requests
 Requires-Dist: astropy
 Dynamic: license-file
@@ -213,5 +214,112 @@ cl.list_files(1) ## pass the collection ID
 You can then download a file by its filename:
 
 ```python
-cl.images.download_file("SPLUS-s17s23_F515_swpweight.fz", download_path=".")
+file_bytes = cl.download_file(
+    file_id=28,
+    output_path=None
+)
+```
+
+Then handle the bytes. Example:
+
+```python
+# if a fits you may open like 
+import io
+from astropy.io import fits
+
+hdul = fits.open(io.BytesIO(file_bytes))
+
+# or a image 
+from PIL import Image
+import matplotlib.pyplot as plt
+
+image = Image.open(io.BytesIO(file_bytes))
+plt.imshow(image)
+```
+
+### Image Tools
+
+Now notice that (**if**) the image collection has some wcs parameters as `ra_center`, `dec_center`, `pixel_scale`. This allows us to do some image cutouts and colored images in real time. Example:
+
+```python
+cutout_bytes = cl.create_stamp_by_coordinates(
+    collection_id = 1, 
+    ra = 0.1, 
+    dec = 0.1, 
+    size = 300, 
+    filter = "R", 
+    size_unit="pixels", 
+    format = "fits", 
+    pattern="swp."
+)
+
+hdul = fits.open(BytesIO(cutout_bytes))
+```
+
+or if the image collection has object_name info you may filter by it, forcing the cutout from that object:
+
+```python
+cutout_bytes = cl.stamp_images.create_stamp_by_object(
+    collection_id=1, 
+    object_name="STRIPE82-0002", 
+    size=300, 
+    ra=0.1,
+    dec=0.1,
+    filter_name="R", 
+    size_unit="pixels", 
+    format="fits"
+)
+cutout = fits.open(BytesIO(cutout_bytes))
+```
+
+or just by file_id, this will force the cutout from that specific file:
+
+```python
+cl.stamp_images.create_stamp(
+    file_id=28,
+    size=300,
+    ra=0.1,
+    dec=0.1,
+    size_unit="pixels", 
+    format="fits"
+)
+```
+
+### Colored images 
+
+Colored images API is very similar to the cutouts. You just need to provide a list of filters and the output format (png or jpg). Example with lupton et al. (2004) algorithm:
+
+```python
+im_bytes = cl.create_rgb_image_by_coordinates(
+    collection_id=1,
+    ra=0.1,
+    dec=0.1,
+    size=300,
+    size_unit="pixels",
+    r_filter="I",
+    g_filter="R",
+    b_filter="G",
+)
+
+im = Image.open(BytesIO(im_bytes))
+im.show()
+```
+
+Or trilogy algorithm:
+
+```python
+im_bytes = cl.trilogy_images.create_trilogy_rgb_by_coordinates(
+    collection_id=1,
+    ra=0.1,
+    dec=0.1,
+    size=300,
+    size_unit="pixels",
+    r_filters=["I", "R", "Z", "F861", "G"],
+    g_filters=["F660"],
+    b_filters=["U", "F378", "F395", "F410", "F430", "F515"],
+    satpercent=0.15,
+)
+
+im = Image.open(BytesIO(im_bytes))
+im.show()
 ```

{adss-1.32 → adss-1.34}/README.md

@@ -198,5 +198,112 @@ cl.list_files(1) ## pass the collection ID
 You can then download a file by its filename:
 
 ```python
-cl.images.download_file("SPLUS-s17s23_F515_swpweight.fz", download_path=".")
+file_bytes = cl.download_file(
+    file_id=28,
+    output_path=None
+)
+```
+
+Then handle the bytes. Example:
+
+```python
+# if a fits you may open like 
+import io
+from astropy.io import fits
+
+hdul = fits.open(io.BytesIO(file_bytes))
+
+# or a image 
+from PIL import Image
+import matplotlib.pyplot as plt
+
+image = Image.open(io.BytesIO(file_bytes))
+plt.imshow(image)
+```
+
+### Image Tools
+
+Now notice that (**if**) the image collection has some wcs parameters as `ra_center`, `dec_center`, `pixel_scale`. This allows us to do some image cutouts and colored images in real time. Example:
+
+```python
+cutout_bytes = cl.create_stamp_by_coordinates(
+    collection_id = 1, 
+    ra = 0.1, 
+    dec = 0.1, 
+    size = 300, 
+    filter = "R", 
+    size_unit="pixels", 
+    format = "fits", 
+    pattern="swp."
+)
+
+hdul = fits.open(BytesIO(cutout_bytes))
+```
+
+or if the image collection has object_name info you may filter by it, forcing the cutout from that object:
+
+```python
+cutout_bytes = cl.stamp_images.create_stamp_by_object(
+    collection_id=1, 
+    object_name="STRIPE82-0002", 
+    size=300, 
+    ra=0.1,
+    dec=0.1,
+    filter_name="R", 
+    size_unit="pixels", 
+    format="fits"
+)
+cutout = fits.open(BytesIO(cutout_bytes))
+```
+
+or just by file_id, this will force the cutout from that specific file:
+
+```python
+cl.stamp_images.create_stamp(
+    file_id=28,
+    size=300,
+    ra=0.1,
+    dec=0.1,
+    size_unit="pixels", 
+    format="fits"
+)
+```
+
+### Colored images 
+
+Colored images API is very similar to the cutouts. You just need to provide a list of filters and the output format (png or jpg). Example with lupton et al. (2004) algorithm:
+
+```python
+im_bytes = cl.create_rgb_image_by_coordinates(
+    collection_id=1,
+    ra=0.1,
+    dec=0.1,
+    size=300,
+    size_unit="pixels",
+    r_filter="I",
+    g_filter="R",
+    b_filter="G",
+)
+
+im = Image.open(BytesIO(im_bytes))
+im.show()
+```
+
+Or trilogy algorithm:
+
+```python
+im_bytes = cl.trilogy_images.create_trilogy_rgb_by_coordinates(
+    collection_id=1,
+    ra=0.1,
+    dec=0.1,
+    size=300,
+    size_unit="pixels",
+    r_filters=["I", "R", "Z", "F861", "G"],
+    g_filters=["F660"],
+    b_filters=["U", "F378", "F395", "F410", "F430", "F515"],
+    satpercent=0.15,
+)
+
+im = Image.open(BytesIO(im_bytes))
+im.show()
 ```