Skip to content

Commit

Permalink
Filter resource querying on coverage at source, adjust userflow to se…
Browse files Browse the repository at this point in the history 
…lect source before resource, add manual coordinate toggle to viewer dropdown
  • Loading branch information
@duytnguyendtn
duytnguyendtn committed Jul 17, 2024
1 parent 73c3579 commit cdcaa1c
Show file tree
Hide file tree
Showing 2 changed files with 102 additions and 52 deletions.
68 changes: 52 additions & 16 deletions jdaviz/configs/default/plugins/virtual_observatory/vo_plugin.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,34 +7,38 @@
from pyvo import registry
from pyvo.dal.exceptions import DALFormatError
from requests.exceptions import ConnectionError as RequestConnectionError
from traitlets import Dict, Bool, Unicode, Any, List, Int
from traitlets import Dict, Bool, Unicode, Any, List, Int, observe

from jdaviz.core.events import SnackbarMessage, AddDataMessage, RemoveDataMessage
from jdaviz.core.registries import tray_registry
from jdaviz.core.template_mixin import PluginTemplateMixin, AddResultsMixin, TableMixin, ViewerSelectMixin
from jdaviz.core.template_mixin import PluginTemplateMixin, AddResultsMixin, TableMixin, ViewerSelect

__all__ = ['VoPlugin']


@tray_registry('VoPlugin', label="Virtual Observatory")
class VoPlugin(PluginTemplateMixin, AddResultsMixin, TableMixin, ViewerSelectMixin):
class VoPlugin(PluginTemplateMixin, AddResultsMixin, TableMixin):
""" Plugin to query the Virtual Observatory and load data into Imviz """
template_file = __file__, "vo_plugin.vue"

viewer_items = List([]).tag(sync=True)
viewer_selected = Unicode().tag(sync=True)

wavebands = List().tag(sync=True)
resources = List([]).tag(sync=True)
resources_loading= Bool(False).tag(sync=True)

source = Unicode('').tag(sync=True)
coordframes = List([]).tag(sync=True)
coordframe_selected = Unicode('ICRS').tag(sync=True)
coordframe_selected = Unicode('icrs').tag(sync=True)
radius_deg = Int(1).tag(sync=True)

results_loading = Bool(False).tag(sync=True)
data_loading = Bool(False).tag(sync=True)

def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.viewer = ViewerSelect(self, 'viewer_items', 'viewer_selected', manual_options=['Manual'])

# Waveband properties to filter available registry resources
self.wavebands = [w.lower() for w in vocabularies.get_vocabulary("messenger")["terms"]]
Expand All @@ -55,21 +59,22 @@ def __init__(self, *args, **kwargs):
self.hub.subscribe(self, AddDataMessage, handler=self._center_on_data)
self.hub.subscribe(self, RemoveDataMessage, handler=self._center_on_data)

self.previous_autogen_source = None


@observe("viewer_selected", "change")
def _center_on_data(self, _):
"""
If data is present in the default viewer, center the plugin's coordinates on
the viewer's center WCS coordinates.
the viewer's center WCS coordinates.
"""
# This plugin should not overwrite existing user input.
# Immediately exit if the user has entered a value
if self.source not in ('', self.previous_autogen_source):
if not hasattr(self, 'viewer'):
# mixin object not yet initialized
return
if self.viewer_selected == "Manual":
return

# gets the current viewer
viewer = self.viewer.selected_obj
if self.viewer_selected:
viewer = self.viewer.selected_obj

# nothing happens in the case there is no image in the viewer
# additionally if the data does not have WCS
Expand All @@ -89,31 +94,62 @@ def _center_on_data(self, _):
# Show center value in plugin
self.source = f"{ra_deg} {dec_deg}"
self.coordframe_selected = frame
self.previous_autogen_source = self.source


def vue_waveband_selected(self,event):
def vue_waveband_selected(self, event):
""" Sync waveband selected
When the user selects a waveband, query Virtual Observatory registry
for all SIA services that serve data in that waveband. Then update
the dropdown accordingly.
"""
self.waveband_selected = event
self.vue_query_registry_resources()


@observe("source", "change")
def vue_query_registry_resources(self, event=None):
"""
Query Virtual Observatory registry
for all SIA services that serve data in that waveband around the source.
Then update the dropdown accordingly.
"""
# If missing either required fields, immediately quit
if not self.source or not self.waveband_selected:
return

# Clear existing resources list
self.resources = []
self.resource_selected = None
self.resources_loading = True # Start loading bar
try:
if event is not None:
self._full_registry_results = registry.search(registry.Servicetype("sia"), registry.Waveband(self.waveband_selected))
self.resources = list(self._full_registry_results.getcolumn("short_name"))
# First parse user-provided source as direct coordinates
coord = SkyCoord(self.source, unit=u.deg, frame=self.coordframe_selected)
except:
try:
# If that didn't work, try parsing it as an object name
coord = SkyCoord.from_name(self.source, frame=self.coordframe_selected)
except Exception:
self.resources_loading = False # Stop loading bar
self.hub.broadcast(SnackbarMessage(
f"Unable to resolve source coordinates: {self.source}", sender=self, color="error"))
raise LookupError(f"Unable to resolve source coordinates: {self.source}")

try:
registry_args = [registry.Servicetype("sia"), registry.Waveband(self.waveband_selected)]
if coord != None:
registry_args.append(registry.Spatial(coord, self.radius_deg, intersect="overlaps"))
self._full_registry_results = registry.search(*registry_args)
self.resources = list(self._full_registry_results.getcolumn("short_name"))
except DALFormatError as e:
if type(e.cause) is RequestConnectionError:
self.hub.broadcast(SnackbarMessage(
f"Unable to connect to VO registry. Please check your internet connection: {e}", sender=self, color="error"))
else:
raise e
except Exception as e:
self.hub.broadcast(SnackbarMessage(
f"An error occured querying the VO Registry: {e}", sender=self, color="error"))
finally:
self.resources_loading = False # Stop loading bar

Expand Down
86 changes: 50 additions & 36 deletions jdaviz/configs/default/plugins/virtual_observatory/vo_plugin.vue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,49 +4,24 @@
:link="'https://www.ivoa.net/astronomers/index.html'"
:popout_button="popout_button">

<plugin-viewer-select
:items="viewer_items"
:selected.sync="viewer_selected"
label="Viewer"
:show_if_single_entry="false"
hint="Select a viewer to search."
/>

<j-plugin-section-header>Survey Collections</j-plugin-section-header>
<v-row>
<v-select
:menu-props="{ left: true }"
attach
:items="wavebands"
@change="waveband_selected"
label="Resource Waveband"
hint="Select a spectral waveband to filter your surveys"
persistent-hint
></v-select>
</v-row>

<v-row>
<v-select
:menu-props="{ left: true }"
attach
:items="resources"
:loading="resources_loading"
@change="resource_selected"
label="Available Resources"
hint="Select a SIA resource to query"
persistent-hint
></v-select>
</v-row>

<j-plugin-section-header>Source Selection</j-plugin-section-header>

<plugin-viewer-select
:items="viewer_items"
:selected.sync="viewer_selected"
label="Viewer"
:show_if_single_entry="true"
hint="Select a viewer to autofill center coordinates, or Manual for manual coordinate entry."
/>

<v-row>
<v-text-field
<v-text-field
v-model="source"
label="Source or Coordinates"
hint="Enter a source name or ICRS coordinates in degrees to center your query on"
:disabled="viewer_selected !== 'Manual'"
persistent-hint>
</v-text-field>
</v-text-field>
</v-row>

<v-row>
Expand All @@ -58,6 +33,7 @@
@change="coordframe_selected"
label="Coordinate Frame"
hint="Astronomical Coordinate Frame of the provided Coordinates"
:disabled="viewer_selected !== 'Manual'"
persistent-hint
></v-select>
</v-row>
Expand All @@ -74,6 +50,44 @@
</v-text-field>
</v-row>


<j-plugin-section-header>Survey Collections</j-plugin-section-header>
<v-row>
<v-select
:menu-props="{ left: true }"
attach
:items="wavebands"
@change="waveband_selected"
label="Resource Waveband"
hint="Select a spectral waveband to filter your surveys"
persistent-hint
></v-select>
</v-row>

<v-row>
<div class="row-select">
<v-select
:menu-props="{ left: true }"
attach
:items="resources"
:loading="resources_loading"
@change="resource_selected"
label="Available Resources"
hint="Select a SIA resource to query"
persistent-hint
></v-select>
</div>
<div style="line-height: 64px; width=32px">
<v-btn
id="querybtn"
@click="query_registry_resources"
icon
:loading="resources_loading">
<v-icon>mdi-refresh</v-icon>
</v-btn>
</div>
</v-row>

<v-row class="row-no-outside-padding">
<v-col>
<v-btn color="primary" :loading="results_loading" text @click="query_resource">Query Archive</v-btn>
Expand Down

0 comments on commit cdcaa1c

Please sign in to comment.