| Name | osirixgrpc JSON |
| Version |
0.2.1b4
JSON |
| download |
| home_page | None |
| Summary | gRPC interface for interacting with OsiriX |
| upload_time | 2024-06-14 22:29:06 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | Copyright (c) 2024 Matthew D Blackledge, Timothy Sum Hon Mun, and The Institute of Cancer Research Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
artificial intelligence
dicom
image processing
medical imaging
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# OsiriXgrpc
[](https://grpc.io)
[](https://github.com/osirixgrpc/osirixgrpc/blob/main/LICENSE)
[](https://github.com/osirixgrpc/osirixgrpc/issues)
[](https://ai-2-ase.github.io/papers/29%5cCameraReady%5cAAAI_OsiriXgrpc__Rapid_prototyping_and_development_of_state_of_the_art_artificial_intelligence_in_OsiriX_cam_ready.pdf)
__Welcome to OsiriXgrpc__, a research plugin for the popular [OsiriX](https://www.osirix-viewer.com) medical image
viewing platform for macOS. It leverages the [gRPC](https://grpc.io) architecture to provide fast communication between
OsiriX (the _server_) and custom-built software or scripts running on a different local process (the _client_). This
enables fast development of additional OsiriX functionality, including the adoption of state-of-the-art libraries for
image processing and artificial intelligence. Currently, Python is the only in-built supported language, though
adoption of [other languages](https://grpc.io/docs/languages) can be easily achieved.
!!! note "Using osirixgrpc versus pyosirix"
It can be much simpler to interact with OsiriXgrpc using the more pythonic __pyOsiriX__ glue code. See the
dedicated [documentation](https://osirixgrpc.github.io/osirixgrpc/pyosirix/) for further information.
## Installation
For instructions on how to install and set up the plugin, please see the
[getting started](https://osirixgrpc.github.io/osirixgrpc/api/) page.
## Any suggestions?
We are always happy to receive suggestions for future versions of the plugin, or just to hear about what is or isn't
working. We would appreciate if this is done by raising an [issue](https://github.com/osirixgrpc/osirixgrpc/issues).
Please see more information in our [contributing](contributing/CONTRIBUTING.md) section.
## Any questions?
We are happy to answer any questions on the use of osirixgrpc, but please do so by raising an
[issue](https://github.com/osirixgrpc/osirixgrpc/issues) so that others can benefit from the answer. Please ensure that
you use the relevant issue template so that we get all the information we need!
## Future Ambitions
We are always looking to improve things. We have a few suggestions in our roadmap, and would be happy to hear your
thoughts - please let us know using a `feature request` [issue](https://github.com/osirixgrpc/osirixgrpc/issues)
template.
- Support for other scripting languages including Java and Ruby.
- Improve security through SSL/TCL encryption.
## Examples
### Establishing a connection with grpc
```
import grpc
import osirix_pb2_grpc
port = 12345 # Must match activated port in OsiriX plugin
server_url_localhost = 'localhost:' + str(port)
channel_opt = [('grpc.max_send_message_length', 512 * 1024 * 1024), ('grpc.max_receive_message_length', 512 * 1024 * 1024)]
channel = grpc.insecure_channel(server_url_localhost, options=channel_opt)
stub = osirix_pb2_grpc.OsiriXServiceStub(channel)
```
### Obtain a copy of the current browser
```
import utilities_pb2
request = utilities_pb2.Empty() # For functions with no input, use an empty request
response = stub.OsirixCurrentBrowser(request)
if response.status.status == 0:
raise Exception("Could not get browser. Reason: %s" % response.status.message)
browser_controller = response.browser_controller
```
### Get the current database selection within the browser controller
```
import browsercontroller_pb2
response = stub.BrowserControllerDatabaseSelection(browser_controller)
series = response.series
studies = response.studies
```
### Obtain the names of the selected studies
```
import dicomstudy_pb2
for dicom_study in studies:
response = stub.DicomStudyName(dicom_study)
print("Study name: ", response.name)
```
Raw data
{
"_id": null,
"home_page": null,
"name": "osirixgrpc",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Matthew D Blackledge <mattyblackledge@gmail.com>",
"keywords": "Artificial Intelligence, Dicom, Image Processing, Medical Imaging",
"author": null,
"author_email": "Matthew D Blackledge <mattyblackledge@gmail.com>, Timothy Sum Hon Mun <timothy22000@gmail.com>, Richard Holbrey <richard.holbrey@icr.ac.uk>",
"download_url": "https://files.pythonhosted.org/packages/3e/59/984966d92f9dec46418735d3c73fa78b4d65796192ba75741998ac169ed5/osirixgrpc-0.2.1b4.tar.gz",
"platform": null,
"description": "# OsiriXgrpc \n\n\n\n[](https://grpc.io)\n[](https://github.com/osirixgrpc/osirixgrpc/blob/main/LICENSE)\n\n[](https://github.com/osirixgrpc/osirixgrpc/issues)\n[](https://ai-2-ase.github.io/papers/29%5cCameraReady%5cAAAI_OsiriXgrpc__Rapid_prototyping_and_development_of_state_of_the_art_artificial_intelligence_in_OsiriX_cam_ready.pdf)\n\n__Welcome to OsiriXgrpc__, a research plugin for the popular [OsiriX](https://www.osirix-viewer.com) medical image \nviewing platform for macOS. It leverages the [gRPC](https://grpc.io) architecture to provide fast communication between \nOsiriX (the _server_) and custom-built software or scripts running on a different local process (the _client_). This \nenables fast development of additional OsiriX functionality, including the adoption of state-of-the-art libraries for \nimage processing and artificial intelligence. Currently, Python is the only in-built supported language, though\nadoption of [other languages](https://grpc.io/docs/languages) can be easily achieved. \n\n!!! note \"Using osirixgrpc versus pyosirix\"\n It can be much simpler to interact with OsiriXgrpc using the more pythonic __pyOsiriX__ glue code. See the\n dedicated [documentation](https://osirixgrpc.github.io/osirixgrpc/pyosirix/) for further information.\n\n## Installation\nFor instructions on how to install and set up the plugin, please see the \n[getting started](https://osirixgrpc.github.io/osirixgrpc/api/) page.\n\n## Any suggestions?\nWe are always happy to receive suggestions for future versions of the plugin, or just to hear about what is or isn't \nworking. We would appreciate if this is done by raising an [issue](https://github.com/osirixgrpc/osirixgrpc/issues). \nPlease see more information in our [contributing](contributing/CONTRIBUTING.md) section.\n\n## Any questions?\nWe are happy to answer any questions on the use of osirixgrpc, but please do so by raising an \n[issue](https://github.com/osirixgrpc/osirixgrpc/issues) so that others can benefit from the answer. Please ensure that \nyou use the relevant issue template so that we get all the information we need!\n\n## Future Ambitions\nWe are always looking to improve things. We have a few suggestions in our roadmap, and would be happy to hear your \nthoughts - please let us know using a `feature request` [issue](https://github.com/osirixgrpc/osirixgrpc/issues) \ntemplate.\n\n - Support for other scripting languages including Java and Ruby.\n - Improve security through SSL/TCL encryption.\n\n## Examples\n### Establishing a connection with grpc\n```\nimport grpc\nimport osirix_pb2_grpc\n\nport = 12345 # Must match activated port in OsiriX plugin\nserver_url_localhost = 'localhost:' + str(port)\nchannel_opt = [('grpc.max_send_message_length', 512 * 1024 * 1024), ('grpc.max_receive_message_length', 512 * 1024 * 1024)]\nchannel = grpc.insecure_channel(server_url_localhost, options=channel_opt)\nstub = osirix_pb2_grpc.OsiriXServiceStub(channel)\n```\n### Obtain a copy of the current browser\n```\nimport utilities_pb2\n\nrequest = utilities_pb2.Empty() # For functions with no input, use an empty request\nresponse = stub.OsirixCurrentBrowser(request)\nif response.status.status == 0:\n raise Exception(\"Could not get browser. Reason: %s\" % response.status.message)\nbrowser_controller = response.browser_controller\n```\n### Get the current database selection within the browser controller\n```\nimport browsercontroller_pb2\n\nresponse = stub.BrowserControllerDatabaseSelection(browser_controller)\nseries = response.series\nstudies = response.studies\n```\n### Obtain the names of the selected studies\n```\nimport dicomstudy_pb2\n\nfor dicom_study in studies:\n response = stub.DicomStudyName(dicom_study)\n print(\"Study name: \", response.name)\n```\n",
"bugtrack_url": null,
"license": "Copyright (c) 2024 Matthew D Blackledge, Timothy Sum Hon Mun, and The Institute of Cancer Research Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "gRPC interface for interacting with OsiriX",
"version": "0.2.1b4",
"project_urls": {
"Bug Tracker": "https://github.com/osirixgrpc/osirixgrpc/issues",
"Documentation": "https://osirixgrpc.github.io/osirixgrpc/",
"Homepage": "https://osirixgrpc.github.io/osirixgrpc/",
"Repository": "https://github.com/osirixgrpc/osirixgrpc"
},
"split_keywords": [
"artificial intelligence",
" dicom",
" image processing",
" medical imaging"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "504ca71d5e72df849359df0de03ae9262016b9d4974a6b30733cc46f20cc3611",
"md5": "693cada9026cf8df6cec37629f298399",
"sha256": "2eb151a4bcdb6c677dc5f175aee9651e92a2efefc70bc7fa65d1884e21d73e26"
},
"downloads": -1,
"filename": "osirixgrpc-0.2.1b4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "693cada9026cf8df6cec37629f298399",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 35187,
"upload_time": "2024-06-14T22:29:05",
"upload_time_iso_8601": "2024-06-14T22:29:05.474882Z",
"url": "https://files.pythonhosted.org/packages/50/4c/a71d5e72df849359df0de03ae9262016b9d4974a6b30733cc46f20cc3611/osirixgrpc-0.2.1b4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3e59984966d92f9dec46418735d3c73fa78b4d65796192ba75741998ac169ed5",
"md5": "1944bc0d9f42cd2b9a28b71953a2c8c0",
"sha256": "e48e4a0a106880e06ed1fb677fed2292551a4b9e9450187cf896852a8e92484d"
},
"downloads": -1,
"filename": "osirixgrpc-0.2.1b4.tar.gz",
"has_sig": false,
"md5_digest": "1944bc0d9f42cd2b9a28b71953a2c8c0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 27237,
"upload_time": "2024-06-14T22:29:06",
"upload_time_iso_8601": "2024-06-14T22:29:06.990385Z",
"url": "https://files.pythonhosted.org/packages/3e/59/984966d92f9dec46418735d3c73fa78b4d65796192ba75741998ac169ed5/osirixgrpc-0.2.1b4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-14 22:29:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "osirixgrpc",
"github_project": "osirixgrpc",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "osirixgrpc"
}
