Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

SUBprocess IMAGE servER - an HTTP server that uses the LOCI BioFormats library to serve images on behalf of CellProfiler

branch: master
README
subimager: SUBprocess IMAGE servER

(C) Copyright 2011 Broad Institute, all rights reserved

Subimager is distributed under the GNU General Public License, version 2. 
See http://www.gnu.org/licenses/gpl-2.0.html.

The Subimager jar with dependencies contains the OME Bio-Formats library which
is Copyright (C) 2005-2011 UW-Madison LOCI and Glencoe Software, Inc. and
licensed under the GNU General Public License, version 2. Subimager is
a wrapper around the Bio-Formats library and Bio-Formats supplies all of the 
functionality that lets Subimager read and write images.

Subimager is an HTTP server that uses the Bio-Formats Java library as a 
back-end to serve .TIF images. Subimager is designed to be run as a
subprocess of CellProfiler to provide CellProfiler with the capability
to read and write a variety of image formats. It can be used as a stand-
alone image server.

To run Subimager from the command-line, run Java like this:

java -cp subimager-0.1-SNAPSHOT-jar-with-dependencies.jar org.cellprofiler.subimager.Main [--port=#] [--interface=#.#.#.#]
where --port is the port number used to listen for HTTP requests
             (default is to find an open port and print it at startup)
      --interface is the interface used to listen for HTTP requests
                  By default, subimager only listens on the loopback interface,
                  "127.0.0.1" which will only be accessible by the machine
                  running subimager. It can listen on any interface if
                  started on "0.0.0.0".
                  
Subimager currently accepts requests from two URLS:

/stop - stops the webserver process
/readimage - reads an image
    Query parameters:
    url - a URL-encoded url, typically a file URL of the image file to read
    series - the series number for a multi-series TIF file
    index - the index of the image plane within the file for movies and .TIF
    channel - the channel to read, for RGB and multi-channel files. Defaults
              to returning a color image if the input image is in color.

    The response is a content-type=image/tiff TIF file containing a single
    monochrome or interleaved color plane.  
Something went wrong with that request. Please try again.