Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cellprofiler Web API tool: images API #3313

Open
wants to merge 22 commits into
base: develop
Choose a base branch
from

Conversation

ekazachkova
Copy link
Contributor

The current PR provides a new API method GET /hcs/images for cellprofiler web service. This method provides an ability to save image in original quality and z-plane projection.

The following request path parameters can be provided:

  • original (possible values 0|1) - this flag indicates if image shall be saved in original quality
  • zPlanes - a comma separated list of z-plane ids
  • path - a path to hcs file
  • format - a format of result image (tiff|png)
  • cells - a comma separated list of cell ids. If original file requested the fields ids are expected. The single well ID shall be provided for overview file case.
  • timepoint - the certain timepoint
  • sequenceId - the certain sequence ID
  • well - the well ID - the key for wells_map.json. This parameter is required for original case and if path to preview images shall be found via wells_map.json.
  • the key-value channels info

This method return the path to generated image with the following format:

{
    "payload": {
        "path":"/common/path/to/results/images/random-generated-value.png"
    },
    "status":"OK"
}

@ekazachkova ekazachkova requested a review from mzueva June 30, 2023 15:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant