Package omeroweb :: Package webgateway :: Module urls
[hide private]
[frames] | no frames]

Module urls

source code

Variables [hide private]
  appmedia = r'^appmedia/(?P<path>.*)$', 'django.views.static.se...
path to media files for webgateway
  render_image = r'^render_image/(?P<iid>[^/]+)/(?P<z>[^/]+)/(?P...
Returns a jpeg of the OMERO image.
  render_image_region = r'^render_image_region/(?P<iid>[^/]+)/(?...
Returns a jpeg of the OMERO image, rendering only a region specified in query string as region=x,y,width,height.
  render_split_channel = r'^render_split_channel/(?P<iid>[^/]+)/...
Returns a jpeg of OMERO Image with channels split into different panes in a grid.
  render_row_plot = r'^render_row_plot/(?P<iid>[^/]+)/(?P<z>[^/]...
Returns a gif graph of pixel values for a row of an image plane.
  render_col_plot = r'^render_col_plot/(?P<iid>[^/]+)/(?P<z>[^/]...
Returns a gif graph of pixel values for a column of an image plane.
  render_thumbnail = r'^render_thumbnail/(?P<iid>[^/]+)/(?:(?P<w...
Returns a thumbnail jpeg of the OMERO Image, optionally scaled to max-width and max-height.
  render_birds_eye_view = r'^render_birds_eye_view/(?P<iid>[^/]+...
Returns a bird's eye view JPEG of the OMERO Image.
  render_ome_tiff = r'^render_ome_tiff/(?P<ctx>[^/]+)/(?P<cid>[^...
Generates an OME-TIFF of an Image (or zip for multiple OME-TIFFs) and returns the file or redirects to a temp file location.
  render_movie = r'^render_movie/(?P<iid>[^/]+)/(?P<axis>[zt])/(...
Generates a movie file from the image, spanning Z or T frames.
  test = r'^test/$', 'webgateway.views.test'
Test method: returns a blank template of the image-viewer
  listProjects_json = r'^proj/list/$', 'webgateway.views.listPro...
json method: returning list of all projects available to current user.
  projectDetail_json = r'^proj/(?P<pid>[^/]+)/detail/$', 'webgat...
json method: returns details of specified Project.
  listDatasets_json = r'^proj/(?P<pid>[^/]+)/children/$', 'webga...
json method: returns list of Datasets belonging to specified Project.
  datasetDetail_json = r'^dataset/(?P<did>[^/]+)/detail/$', 'web...
json method: returns details of specified Dataset.
  webgateway_listimages_json = url(r'^dataset/(?P<did>[^/]+)/chi...
json method: returns list of Images belonging to specified Dataset.
  webgateway_listwellimages_json = url(r'^well/(?P<did>[^/]+)/ch...
json method: returns list of Images belonging to specified Well.
  webgateway_plategrid_json = url(r'^plate/(?P<pid>[^/]+)/(?:(?P...
  imageData_json = r'^imgData/(?P<iid>[^/]+)/(?:(?P<key>[^/]+)/)...
json method: returns details of specified Image.
  wellData_json = r'^wellData/(?P<wid>[^/]+)/$', 'webgateway.vie...
json method: returns details of specified Well.
  webgateway_search_json = url(r'^search/$', 'webgateway.views.s...
json method: returns search results.
  get_rois_json = url(r'^get_rois_json/(?P<imageId>[0-9]+)$', 'w...
gets all the ROIs for an Image as json.
  full_viewer = r'^img_detail/(?P<iid>[0-9]+)/$', "webgateway.vi...
Returns html page displaying full image viewer and image details, rendering settings etc.
  save_image_rdef_json = r'^saveImgRDef/(?P<iid>[^/]+)/$', 'webg...
Saves rendering definition (from request parameters) on the image.
  reset_image_rdef_json = r'^resetImgRDef/(?P<iid>[^/]+)/$', 'we...
Removes user's rendering settings on an image, reverting to settings created on import.
  list_compatible_imgs_json = r'^compatImgRDef/(?P<iid>[^/]+)/$'...
json method: returns list of IDs for images that have channels compatible with the specified image, such that rendering settings can be copied from the image to those returned.
  copy_image_rdef_json = r'^copyImgRDef/$', 'webgateway.views.co...
Copy the rendering settings from one image to a list of images, specified in request by 'fromid' and list of 'toids'.
  webgateway_su = url(r'^su/(?P<user>[^/]+)/$', 'webgateway.view...
Admin method to switch to the specified user, identified by username: <user> Returns 'true' if switch went OK.
  urlpatterns = patterns('', appmedia, render_image, render_imag...
Variables Details [hide private]

appmedia

path to media files for webgateway

  • path: path to media file
Value:
r'^appmedia/(?P<path>.*)$', 'django.views.static.serve', {'document_ro\
ot': 'webgateway/media'}

render_image

Returns a jpeg of the OMERO image. See views.render_image. Rendering settings can be specified in the request parameters. See views.getImgDetailsFromReq for details. Params in render_image/<iid>/<z>/<t>/ are:

  • iid: Image ID
  • z: Z index
  • t: T index
Value:
r'^render_image/(?P<iid>[^/]+)/(?P<z>[^/]+)/(?P<t>[^/]+)/$', 'webgatew\
ay.views.render_image'

render_image_region

Returns a jpeg of the OMERO image, rendering only a region specified in query string as region=x,y,width,height. E.g. region=0,512,256,256 See views.render_image_region. Rendering settings can be specified in the request parameters. Params in render_image/<iid>/<z>/<t>/ are:

  • iid: Image ID
  • z: Z index
  • t: T index
Value:
r'^render_image_region/(?P<iid>[^/]+)/(?P<z>[^/]+)/(?P<t>[^/]+)/$', 'w\
ebgateway.views.render_image_region'

render_split_channel

Returns a jpeg of OMERO Image with channels split into different panes in a grid. See views.render_split_channel. Rendering settings can be specified in the request parameters (as above). Params in render_split_channel/<iid>/<z>/<t> are:

  • iid: Image ID
  • z: Z index
  • t: T index
Value:
r'^render_split_channel/(?P<iid>[^/]+)/(?P<z>[^/]+)/(?P<t>[^/]+)/$', '\
webgateway.views.render_split_channel'

render_row_plot

Returns a gif graph of pixel values for a row of an image plane. See views.render_row_plot. Channels can be turned on/off using request. E.g. c=-1,2,-3,-4 Params in render_row_plot/<iid>/<z>/<t>/<y>/<w> are:

  • iid: Image ID
  • z: Z index
  • t: T index
  • y: Y position of pixel row
  • w: Optional line width of plot
Value:
r'^render_row_plot/(?P<iid>[^/]+)/(?P<z>[^/]+)/(?P<t>[^/]+)/(?P<y>[^/]\
+)/(?:(?P<w>[^/]+)/)?$', 'webgateway.views.render_row_plot'

render_col_plot

Returns a gif graph of pixel values for a column of an image plane. See views.render_col_plot. Channels can be turned on/off using request. E.g. c=-1,2,-3,-4 Params in render_col_plot/<iid>/<z>/<t>/<x>/<w> are:

  • iid: Image ID
  • z: Z index
  • t: T index
  • x: X position of pixel column
  • w: Optional line width of plot
Value:
r'^render_col_plot/(?P<iid>[^/]+)/(?P<z>[^/]+)/(?P<t>[^/]+)/(?P<x>[^/]\
+)/(?:(?P<w>[^/]+)/)?$', 'webgateway.views.render_col_plot'

render_thumbnail

Returns a thumbnail jpeg of the OMERO Image, optionally scaled to max-width and max-height. See views.render_thumbnail. Uses current rendering settings. Params in render_thumbnail/<iid>/<w>/<h> are:

  • iid: Image ID
  • w: Optional max width
  • h: Optional max height
Value:
r'^render_thumbnail/(?P<iid>[^/]+)/(?:(?P<w>[^/]+)/)?(?:(?P<h>[^/]+)/)\
?$', 'webgateway.views.render_thumbnail'

render_birds_eye_view

Returns a bird's eye view JPEG of the OMERO Image. See views.render_birds_eye_view. Uses current rendering settings. Params in render_birds_eye_view/<iid>/ are:

  • iid: Image ID
  • size: Maximum size of the longest side of the resulting bird's eye view.
Value:
r'^render_birds_eye_view/(?P<iid>[^/]+)/(?:(?P<size>[^/]+)/)?$', 'webg\
ateway.views.render_birds_eye_view'

render_ome_tiff

Generates an OME-TIFF of an Image (or zip for multiple OME-TIFFs) and returns the file or redirects to a temp file location. See views.render_ome_tiff Params in render_ome_tiff/<ctx>/<cid> are:

  • ctx: The container context. 'p' for Project, 'd' for Dataset or 'i' Image.
  • cid: ID of container.
Value:
r'^render_ome_tiff/(?P<ctx>[^/]+)/(?P<cid>[^/]+)/$', 'webgateway.views\
.render_ome_tiff'

render_movie

Generates a movie file from the image, spanning Z or T frames. See views.render_movie Returns the file or redirects to temp file location. Params in render_movie/<iid>/<axis>/<pos> are:

  • iid: Image ID
  • axis: 'z' or 't' dimension that movie plays
  • pos: The T index (for 'z' movie) or Z index (for 't' movie)
Value:
r'^render_movie/(?P<iid>[^/]+)/(?P<axis>[zt])/(?P<pos>[^/]+)/$', 'webg\
ateway.views.render_movie'

listProjects_json

json method: returning list of all projects available to current user. See views.listProjects_json . List of E.g. {"description": "", "id": 651, "name": "spim"}

Value:
r'^proj/list/$', 'webgateway.views.listProjects_json'

projectDetail_json

json method: returns details of specified Project. See views.projectDetail_json. Returns E.g {"description": "", "type": "Project", "id": 651, "name": "spim"}

  • webgateway/proj/<pid>/detail params are:
  • pid: Project ID
Value:
r'^proj/(?P<pid>[^/]+)/detail/$', 'webgateway.views.projectDetail_json\
'

listDatasets_json

json method: returns list of Datasets belonging to specified Project. See views.listDatasets_json. Returns E.g list of {"child_count": 4, "description": "", "type": "Dataset", "id": 901, "name": "example"}

  • webgateway/proj/<pid>/children params are:
  • pid: Project ID
Value:
r'^proj/(?P<pid>[^/]+)/children/$', 'webgateway.views.listDatasets_jso\
n'

datasetDetail_json

json method: returns details of specified Dataset. See views.datasetDetail_json. Returns E.g {"description": "", "type": "Dataset", "id": 901, "name": "example"}

  • webgateway/dataset/<did>/detail params are:
  • did: Dataset ID
Value:
r'^dataset/(?P<did>[^/]+)/detail/$', 'webgateway.views.datasetDetail_j\
son'

webgateway_listimages_json

json method: returns list of Images belonging to specified Dataset. See views.listImages_json. Returns E.g list of {"description": "", "author": "Will Moore", "date": 1291325060.0, "thumb_url": "/webgateway/render_thumbnail/4701/", "type": "Image", "id": 4701, "name": "spim.png"}

  • webgateway/dataset/<did>/children params are:
  • did: Dataset ID
Value:
url(r'^dataset/(?P<did>[^/]+)/children/$', 'webgateway.views.listImage\
s_json', name= "webgateway_listimages_json")

webgateway_listwellimages_json

json method: returns list of Images belonging to specified Well. See views.listWellImages_json. Returns E.g list of {"description": "", "author": "Will Moore", "date": 1291325060.0, "thumb_url": "/webgateway/render_thumbnail/4701/", "type": "Image", "id": 4701, "name": "spim.png"}

  • webgateway/well/<did>/children params are:
  • did: Well ID
Value:
url(r'^well/(?P<did>[^/]+)/children/$', 'webgateway.views.listWellImag\
es_json', name= "webgateway_listwellimages_json")

webgateway_plategrid_json

Value:
url(r'^plate/(?P<pid>[^/]+)/(?:(?P<field>[^/]+)/)?$', 'webgateway.view\
s.plateGrid_json', name= "webgateway_plategrid_json")

imageData_json

json method: returns details of specified Image. See views.imageData_json. Returns E.g {"description": "", "type": "Dataset", "id": 901, "name": "example"}

  • webgateway/imgData/<iid>/<key> params are:
  • did: Dataset ID
  • key: Optional key of selected attributes to return. E.g. meta, pixel_range, rdefs, split_channel, size etc
Value:
r'^imgData/(?P<iid>[^/]+)/(?:(?P<key>[^/]+)/)?$', 'webgateway.views.im\
ageData_json'

wellData_json

json method: returns details of specified Well. See views.wellData_json.

  • webgateway/wellData/<wid>/ params are:
  • wid: Well ID
Value:
r'^wellData/(?P<wid>[^/]+)/$', 'webgateway.views.wellData_json'

webgateway_search_json

json method: returns search results. All parameters in request. See views.search_json

Value:
url(r'^search/$', 'webgateway.views.search_json', name= "webgateway_se\
arch_json")

get_rois_json


gets all the ROIs for an Image as json. Image-ID is request: imageId=123
[{'id':123, 'shapes':[{'type':'Rectangle', 'theZ':5, 'theT':0, 'x':250, 'y':100, 'width':10 'height':45} ]

Value:
url(r'^get_rois_json/(?P<imageId>[0-9]+)$', 'webgateway.views.get_rois\
_json', name= 'webgateway_get_rois_json')

full_viewer

Returns html page displaying full image viewer and image details, rendering settings etc. See views.full_viewer.

  • webgateway/img_detail/<iid>/ params are:
  • iid: Image ID.
Value:
r'^img_detail/(?P<iid>[0-9]+)/$', "webgateway.views.full_viewer"

save_image_rdef_json

Saves rendering definition (from request parameters) on the image. See views.save_image_rdef_json. For rendering parameters, see views.getImgDetailsFromReq for details. Returns 'true' if worked OK.

  • webgateway/saveImgRDef/<iid>/ params are:
  • iid: Image ID.
Value:
r'^saveImgRDef/(?P<iid>[^/]+)/$', 'webgateway.views.save_image_rdef_js\
on'

reset_image_rdef_json

Removes user's rendering settings on an image, reverting to settings created on import. See views.reset_image_rdef_json.

  • webgateway/resetImgRDef/<iid>/ params are:
  • iid: Image ID.
Value:
r'^resetImgRDef/(?P<iid>[^/]+)/$', 'webgateway.views.reset_image_rdef_\
json'

list_compatible_imgs_json

json method: returns list of IDs for images that have channels compatible with the specified image, such that rendering settings can be copied from the image to those returned. Images are selected from the same project that the specified image is in.

  • webgateway/compatImgRDef/<iid>/ params are:
  • iid: Image ID.
Value:
r'^compatImgRDef/(?P<iid>[^/]+)/$', 'webgateway.views.list_compatible_\
imgs_json'

copy_image_rdef_json

Copy the rendering settings from one image to a list of images, specified in request by 'fromid' and list of 'toids'. See views.copy_image_rdef_json

Value:
r'^copyImgRDef/$', 'webgateway.views.copy_image_rdef_json'

webgateway_su

Admin method to switch to the specified user, identified by username: <user> Returns 'true' if switch went OK.

Value:
url(r'^su/(?P<user>[^/]+)/$', 'webgateway.views.su', name= "webgateway\
_su")

urlpatterns

Value:
patterns('', appmedia, render_image, render_image_region, render_split\
_channel, render_row_plot, render_col_plot, render_thumbnail, render_b\
irds_eye_view, render_ome_tiff, render_movie, test, listProjects_json,\
 projectDetail_json, listDatasets_json, datasetDetail_json, webgateway\
_listimages_json, webgateway_listwellimages_json, webgateway_plategrid\
_json, imageData_json, wellData_json, webgateway_search_json, get_rois\
_json, full_viewer, save_image_rdef_json, reset_image_rdef_json, list_\
compatible_imgs_json, copy_image_rdef_json, webgateway_su, (r'^dbg_con\
...