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

Source Code for Module omeroweb.webgateway.urls

  1  # 
  2  # webgateway/urls.py - django application url handling configuration 
  3  #  
  4  # Copyright (c) 2007, 2008, 2009 Glencoe Software, Inc. All rights reserved. 
  5  #  
  6  # This software is distributed under the terms described by the LICENCE file 
  7  # you can find at the root of the distribution bundle, which states you are 
  8  # free to use it only for non commercial purposes. 
  9  # If the file is missing please request a copy by contacting 
 10  # jason@glencoesoftware.com. 
 11  # 
 12  # Author: Carlos Neves <carlos(at)glencoesoftware.com> 
 13   
 14  from django.conf.urls.defaults import * 
 15   
 16  appmedia = (r'^appmedia/(?P<path>.*)$', 'django.views.static.serve', {'document_root': 'webgateway/media'}) 
 17  """  
 18  path to media files for webgateway  
 19      - path: path to media file 
 20  """ 
 21   
 22  render_image = (r'^render_image/(?P<iid>[^/]+)/(?P<z>[^/]+)/(?P<t>[^/]+)/$', 'webgateway.views.render_image') 
 23  """ 
 24  Returns a jpeg of the OMERO image. See L{views.render_image}. Rendering settings can be specified 
 25  in the request parameters. See L{views.getImgDetailsFromReq} for details.  
 26  Params in render_image/<iid>/<z>/<t>/ are: 
 27      - iid:  Image ID 
 28      - z:    Z index 
 29      - t:    T index 
 30  """ 
 31   
 32  render_image_region = (r'^render_image_region/(?P<iid>[^/]+)/(?P<z>[^/]+)/(?P<t>[^/]+)/$', 'webgateway.views.render_image_region') 
 33  """ 
 34  Returns a jpeg of the OMERO image, rendering only a region specified in query string as 
 35  region=x,y,width,height. E.g. region=0,512,256,256 See L{views.render_image_region}.  
 36  Rendering settings can be specified in the request parameters. 
 37  Params in render_image/<iid>/<z>/<t>/ are: 
 38      - iid:  Image ID 
 39      - z:    Z index 
 40      - t:    T index 
 41  """ 
 42   
 43  render_split_channel = (r'^render_split_channel/(?P<iid>[^/]+)/(?P<z>[^/]+)/(?P<t>[^/]+)/$', 'webgateway.views.render_split_channel') 
 44  """ 
 45  Returns a jpeg of OMERO Image with channels split into different panes in a grid. See L{views.render_split_channel}. 
 46  Rendering settings can be specified in the request parameters (as above). 
 47  Params in render_split_channel/<iid>/<z>/<t> are: 
 48      - iid:  Image ID 
 49      - z:    Z index 
 50      - t:    T index 
 51  """ 
 52   
 53  render_row_plot = (r'^render_row_plot/(?P<iid>[^/]+)/(?P<z>[^/]+)/(?P<t>[^/]+)/(?P<y>[^/]+)/(?:(?P<w>[^/]+)/)?$',  
 54      'webgateway.views.render_row_plot') 
 55  """ 
 56  Returns a gif graph of pixel values for a row of an image plane. See L{views.render_row_plot}. 
 57  Channels can be turned on/off using request. E.g. c=-1,2,-3,-4 
 58  Params in render_row_plot/<iid>/<z>/<t>/<y>/<w> are: 
 59      - iid:  Image ID 
 60      - z:    Z index 
 61      - t:    T index 
 62      - y:    Y position of pixel row 
 63      - w:    Optional line width of plot 
 64  """ 
 65   
 66  render_col_plot = (r'^render_col_plot/(?P<iid>[^/]+)/(?P<z>[^/]+)/(?P<t>[^/]+)/(?P<x>[^/]+)/(?:(?P<w>[^/]+)/)?$',  
 67      'webgateway.views.render_col_plot') 
 68  """ 
 69  Returns a gif graph of pixel values for a column of an image plane. See L{views.render_col_plot}. 
 70  Channels can be turned on/off using request. E.g. c=-1,2,-3,-4 
 71  Params in render_col_plot/<iid>/<z>/<t>/<x>/<w> are: 
 72      - iid:  Image ID 
 73      - z:    Z index 
 74      - t:    T index 
 75      - x:    X position of pixel column 
 76      - w:    Optional line width of plot 
 77  """ 
 78   
 79  render_thumbnail = (r'^render_thumbnail/(?P<iid>[^/]+)/(?:(?P<w>[^/]+)/)?(?:(?P<h>[^/]+)/)?$', 'webgateway.views.render_thumbnail') 
 80  """ 
 81  Returns a thumbnail jpeg of the OMERO Image, optionally scaled to max-width and max-height. 
 82  See L{views.render_thumbnail}. Uses current rendering settings.  
 83  Params in render_thumbnail/<iid>/<w>/<h> are: 
 84      - iid:  Image ID 
 85      - w:    Optional max width 
 86      - h:    Optional max height 
 87  """ 
 88   
 89  render_birds_eye_view = (r'^render_birds_eye_view/(?P<iid>[^/]+)/(?:(?P<size>[^/]+)/)?$', 'webgateway.views.render_birds_eye_view') 
 90  """ 
 91  Returns a bird's eye view JPEG of the OMERO Image. 
 92  See L{views.render_birds_eye_view}. Uses current rendering settings. 
 93  Params in render_birds_eye_view/<iid>/ are: 
 94      - iid:   Image ID 
 95      - size:  Maximum size of the longest side of the resulting bird's eye view. 
 96  """ 
 97   
 98  render_ome_tiff = (r'^render_ome_tiff/(?P<ctx>[^/]+)/(?P<cid>[^/]+)/$', 'webgateway.views.render_ome_tiff') 
 99  """ 
100  Generates an OME-TIFF of an Image (or zip for multiple OME-TIFFs) and returns the file or redirects  
101  to a temp file location. See L{views.render_ome_tiff} 
102  Params in render_ome_tiff/<ctx>/<cid> are: 
103      - ctx:      The container context. 'p' for Project, 'd' for Dataset or 'i' Image.  
104      - cid:      ID of container. 
105  """ 
106   
107  render_movie = (r'^render_movie/(?P<iid>[^/]+)/(?P<axis>[zt])/(?P<pos>[^/]+)/$', 'webgateway.views.render_movie') 
108  """ 
109  Generates a movie file from the image, spanning Z or T frames. See L{views.render_movie} 
110  Returns the file or redirects to temp file location.  
111  Params in render_movie/<iid>/<axis>/<pos> are: 
112      - iid:      Image ID 
113      - axis:     'z' or 't' dimension that movie plays 
114      - pos:      The T index (for 'z' movie) or Z index (for 't' movie) 
115  """ 
116   
117  # Template views 
118  test = (r'^test/$', 'webgateway.views.test') 
119  """ 
120  Test method: returns a blank template of the image-viewer 
121  """ 
122   
123  # json methods... 
124   
125  listProjects_json = (r'^proj/list/$', 'webgateway.views.listProjects_json') 
126  """ 
127  json method: returning list of all projects available to current user. See L{views.listProjects_json} . 
128  List of E.g. {"description": "", "id": 651, "name": "spim"} 
129  """ 
130   
131  projectDetail_json = (r'^proj/(?P<pid>[^/]+)/detail/$', 'webgateway.views.projectDetail_json') 
132  """ 
133  json method: returns details of specified Project. See L{views.projectDetail_json}. Returns E.g 
134  {"description": "", "type": "Project", "id": 651, "name": "spim"} 
135      - webgateway/proj/<pid>/detail params are: 
136      - pid:  Project ID 
137  """ 
138   
139  listDatasets_json = (r'^proj/(?P<pid>[^/]+)/children/$', 'webgateway.views.listDatasets_json') 
140  """ 
141  json method: returns list of Datasets belonging to specified Project. See L{views.listDatasets_json}. Returns E.g 
142  list of {"child_count": 4, "description": "", "type": "Dataset", "id": 901, "name": "example"} 
143      - webgateway/proj/<pid>/children params are: 
144      - pid:  Project ID 
145  """ 
146   
147  datasetDetail_json = (r'^dataset/(?P<did>[^/]+)/detail/$', 'webgateway.views.datasetDetail_json') 
148  """ 
149  json method: returns details of specified Dataset. See L{views.datasetDetail_json}. Returns E.g 
150  {"description": "", "type": "Dataset", "id": 901, "name": "example"} 
151      - webgateway/dataset/<did>/detail params are: 
152      - did:  Dataset ID 
153  """ 
154   
155  webgateway_listimages_json = url(r'^dataset/(?P<did>[^/]+)/children/$', 'webgateway.views.listImages_json', name="webgateway_listimages_json") 
156  """ 
157  json method: returns list of Images belonging to specified Dataset. See L{views.listImages_json}. Returns E.g list of  
158  {"description": "", "author": "Will Moore", "date": 1291325060.0, "thumb_url": "/webgateway/render_thumbnail/4701/", "type": "Image", "id": 4701, "name": "spim.png"} 
159      - webgateway/dataset/<did>/children params are: 
160      - did:  Dataset ID 
161  """ 
162   
163  webgateway_listwellimages_json = url(r'^well/(?P<did>[^/]+)/children/$', 'webgateway.views.listWellImages_json', name="webgateway_listwellimages_json") 
164  """ 
165  json method: returns list of Images belonging to specified Well. See L{views.listWellImages_json}. Returns E.g list of  
166  {"description": "", "author": "Will Moore", "date": 1291325060.0, "thumb_url": "/webgateway/render_thumbnail/4701/", "type": "Image", "id": 4701, "name": "spim.png"} 
167      - webgateway/well/<did>/children params are: 
168      - did:  Well ID 
169  """ 
170   
171  webgateway_plategrid_json = url(r'^plate/(?P<pid>[^/]+)/(?:(?P<field>[^/]+)/)?$', 'webgateway.views.plateGrid_json', name="webgateway_plategrid_json") 
172  """ 
173  """ 
174   
175  imageData_json = (r'^imgData/(?P<iid>[^/]+)/(?:(?P<key>[^/]+)/)?$', 'webgateway.views.imageData_json') 
176  """ 
177  json method: returns details of specified Image. See L{views.imageData_json}. Returns E.g 
178  {"description": "", "type": "Dataset", "id": 901, "name": "example"} 
179      - webgateway/imgData/<iid>/<key> params are: 
180      - did:  Dataset ID 
181      - key:  Optional key of selected attributes to return. E.g. meta, pixel_range, rdefs, split_channel, size etc 
182  """ 
183   
184  wellData_json = (r'^wellData/(?P<wid>[^/]+)/$', 'webgateway.views.wellData_json') 
185  """ 
186  json method: returns details of specified Well. See L{views.wellData_json}. 
187      - webgateway/wellData/<wid>/ params are: 
188      - wid:  Well ID 
189  """ 
190   
191  webgateway_search_json = url(r'^search/$', 'webgateway.views.search_json', name="webgateway_search_json") 
192  """ 
193  json method: returns search results. All parameters in request. See L{views.search_json} 
194  """ 
195   
196  get_rois_json = url( r'^get_rois_json/(?P<imageId>[0-9]+)$', 'webgateway.views.get_rois_json', name='webgateway_get_rois_json' ) 
197  """ 
198  gets all the ROIs for an Image as json. Image-ID is request: imageId=123 
199  [{'id':123, 'shapes':[{'type':'Rectangle', 'theZ':5, 'theT':0, 'x':250, 'y':100, 'width':10 'height':45} ] 
200  """ 
201   
202  full_viewer = (r'^img_detail/(?P<iid>[0-9]+)/$', "webgateway.views.full_viewer") 
203  """ 
204  Returns html page displaying full image viewer and image details, rendering settings etc.  
205  See L{views.full_viewer}. 
206      - webgateway/img_detail/<iid>/ params are: 
207      - iid:  Image ID.  
208  """ 
209   
210  save_image_rdef_json = (r'^saveImgRDef/(?P<iid>[^/]+)/$', 'webgateway.views.save_image_rdef_json') 
211  """ 
212  Saves rendering definition (from request parameters) on the image. See L{views.save_image_rdef_json}.  
213  For rendering parameters, see L{views.getImgDetailsFromReq} for details.  
214  Returns 'true' if worked OK.  
215      - webgateway/saveImgRDef/<iid>/ params are: 
216      - iid:  Image ID. 
217  """ 
218   
219  reset_image_rdef_json = (r'^resetImgRDef/(?P<iid>[^/]+)/$', 'webgateway.views.reset_image_rdef_json') 
220  """ 
221  Removes user's rendering settings on an image, reverting to settings created on import.  
222  See L{views.reset_image_rdef_json}.  
223      - webgateway/resetImgRDef/<iid>/ params are: 
224      - iid:  Image ID. 
225  """ 
226   
227  list_compatible_imgs_json = (r'^compatImgRDef/(?P<iid>[^/]+)/$', 'webgateway.views.list_compatible_imgs_json') 
228  """ 
229  json method: returns list of IDs for images that have channels compatible with the specified image, such 
230  that rendering settings can be copied from the image to those returned. Images are selected from the same 
231  project that the specified image is in.  
232      - webgateway/compatImgRDef/<iid>/ params are: 
233      - iid:  Image ID. 
234  """ 
235   
236  copy_image_rdef_json = (r'^copyImgRDef/$', 'webgateway.views.copy_image_rdef_json') 
237  """ 
238  Copy the rendering settings from one image to a list of images, specified in request 
239  by 'fromid' and list of 'toids'. See L{views.copy_image_rdef_json} 
240  """ 
241   
242  webgateway_su = url(r'^su/(?P<user>[^/]+)/$', 'webgateway.views.su', name="webgateway_su") 
243  """ 
244  Admin method to switch to the specified user, identified by username: <user>  
245  Returns 'true' if switch went OK. 
246  """ 
247   
248  urlpatterns = patterns('', 
249      appmedia, 
250      render_image, 
251      render_image_region, 
252      render_split_channel, 
253      render_row_plot, 
254      render_col_plot, 
255      render_thumbnail, 
256      render_birds_eye_view, 
257      render_ome_tiff, 
258      render_movie, 
259      # Template views 
260      test, 
261      # JSON methods 
262      listProjects_json, 
263      projectDetail_json, 
264      listDatasets_json, 
265      datasetDetail_json, 
266      webgateway_listimages_json, 
267      webgateway_listwellimages_json, 
268      webgateway_plategrid_json, 
269      imageData_json, 
270      wellData_json, 
271      webgateway_search_json, 
272      get_rois_json, 
273      # image viewer 
274      full_viewer, 
275      # rendering def methods 
276      save_image_rdef_json, 
277      reset_image_rdef_json, 
278      list_compatible_imgs_json, 
279      copy_image_rdef_json, 
280      # switch user 
281      webgateway_su, 
282       
283      # Debug stuff 
284      (r'^dbg_connectors/$', 'webgateway.views.dbg_connectors'), 
285   
286  ) 
287