Tilecache API's
***************

You can also view the `NeuroData Tile API's <http://docs.neurodata.io/ndstore/api/tile_api.html>`_ which work similarly for `ndstore <http://docs.neurodata.io/ndstore/index.html>`_.

getSimpleTile
-------------

.. http:get:: (string:server_name)/ndtilecache/tilecache/(string:token_name)/(string:channel_name)/(string:slice_type)/(int:time)/(int:zvalue)/(int:ytile)_(int:xtile)_(int:resolution).png
   
   :synopsis: Get a 512x512 tile from the tilecache

   :param server_name: Server Name in NeuroData. In the general case this is ocp.me.
   :type server_name: string
   :param token_name: Token Name in NeuroData.
   :type token_name: string
   :param channel_name: Channel Name in NeuroData.
   :type channel_name: string
   :param slice_type: Type of Slice cutout. Can be xy/yz/xz
   :type slice_type: string
   :param time: Time value. *Optional*. Only possible in timeseries datasets.
   :type time: int
   :param zvalue: Zslice value.
   :type zvalue: int
   :param ytile: Y-Tile value. Each tile is 512x512.
   :type ytile: int
   :param xtile: X-Tile value. Each tile is 512x512.
   :type xtile: int
   :param resolution: Resolution value.
   :type resolution: int

   :statuscode 200: No error
   :statuscode 404: Error in the syntax or file format
   
   **Example Request**:
   
   .. sourcecode:: http
   
      GET  /ndtilecache/tilecache/kasthuri11/image/xy/1/1_1_4.png HTTP/1.1
      Host: openconnecto.me
   
   **Example Response**:
   
   .. sourcecode:: http 
      
      HTTP/1.1 200 OK
      Content-Type: application/png

.. figure:: ../images/simple_image_tile.png
    :align: center
    :width: 512px
    :height: 512px

getMcfcTile
-----------

.. http:get:: (string:server_name)/ndtilecache/tilecache/mcfc/(string:token_name)/(string:channel_name):(string:color_name)/(string:slice_type)/(int:time)/(int:zvalue)/(int:ytile)_(int:xtile)_(int:resolution).png
   
   :synopsis: Get a 512x512 tile from the tilecache

   :param server_name: Server Name in NeuroData. In the general case this is ocp.me.
   :type server_name: string
   :param token_name: Token Name in NeuroData.
   :type token_name: string
   :param channel_name: Channel Name in NeuroData.
   :type channel_name: string
   :param color_name: Color Name. Can be 'C/M/Y/R/G/B'. *Optional* If Missing will default to "CMYRGB".
   :type color_name: string
   :param slice_type: Type of Slice cutout. Can be xy/yz/xz
   :type slice_type: string
   :param time: Time value. *Optional*. Only possible in timeseries datasets.
   :type time: int
   :param zvalue: Zslice value.
   :type zvalue: int
   :param ytile: Y-Tile value. Each tile is 512x512.
   :type ytile: int
   :param xtile: X-Tile value. Each tile is 512x512.
   :type xtile: int
   :param resolution: Resolution value.
   :type resolution: int

   :statuscode 200: No error
   :statuscode 404: Error in the syntax or file format

   **Example Request**:
   
   .. sourcecode:: http
   
      GET  /ndtilecache/tilecache/mcfc/Thy1eYFPBrain10/Grayscale/xy/500/0_0_3.png HTTP/1.1
      Host: openconnecto.me
   
   **Example Response**:
   
   .. sourcecode:: http 
      
      HTTP/1.1 200 OK
      Content-Type: application/png

.. figure:: ../images/mcfc_image_tile.png
    :align: center
    :width: 512px
    :height: 512px


getVikingTile
-------------

.. http:get:: (string:server_name)/ndtilecache/tilecache/viking/(string:token_name)/volume/(string:channel_name)/(int:resolution)/X(int:xtile)_Y(int:xtile)_Z(int:zvalue).png
   
   :synopsis: Get a 512x512 tile from the tilecache

   :param server_name: Server Name in NeuroData. In the general case this is openconnecto.me.
   :type server_name: string
   :param token_name: Token Name in NeuroData.
   :type token_name: string
   :param channel_name: Channel Name in NeuroData.
   :type channel_name: string
   :param resolution: Resolution value.
   :type resolution: int
   :param xtile: X-Tile value. Each tile is 512x512.
   :type xtile: int
   :param ytile: Y-Tile value. Each tile is 512x512.
   :type ytile: int
   :param zvalue: Zslice value.
   :type zvalue: int

   :statuscode 200: No error
   :statuscode 404: Error in the syntax or file format
   
   **Example Request**:
   
   .. sourcecode:: http
   
      GET  /ndtilecache/tilecache/viking/kasthuri11/volume/image/4/X1_Y1_Z10.png HTTP/1.1
      Host: openconnecto.me
   
   **Example Response**:
   
   .. sourcecode:: http 
      
      HTTP/1.1 200 OK
      Content-Type: application/png

.. figure:: ../images/viking_image_tile.png
    :align: center
    :width: 512px
    :height: 512px