| Name | VisiOmatic JSON |
| Version |
3.0.0
JSON |
| download |
| home_page | None |
| Summary | A web application for visualizing astronomical images |
| upload_time | 2024-07-04 11:50:20 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License
Copyright (c) 2022 Emmanuel Bertin
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 |
astronomy
cfht
imaging
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
#  VisiOmatic 3
[](https://github.com/astromatic/visiomatic/actions/workflows/doc.yml)[](https://github.com/astromatic/visiomatic/actions/workflows/tests.yml)
[](https://codecov.io/gh/astromatic/visiomatic)
VisiOmatic is a web application for visualizing astronomical images. This is the version 3 of the package. Code from the older versions can still be accessed through the [``legacy``](https://github.com/astromatic/visiomatic/tree/legacy) branch.
## Installation
You can install Visiomatic via pip:
```bash
pip install visiomatic
```
## Usage
```bash
visiomatic image.fits
```
## Documentation
A detailed documentation, including API reference is available [here](https://astromatic.github.io/visiomatic). Note: this is still work in progress.
## Technical overview
The VisiOmatic package provides a complete remote visualization system for large multispectral/hyperspectral astronomical image data (or image sequences). The web client interface runs in standard web browsers, generating image requests to a server on behalf of the user. These HTTP requests are processed in real-time by the server, through a web API, to compute and deliver compressed images which are then updated almost immediately in the browser.
### Web client
The VisiOmatic web client is built on top of the Leaflet Javascript mini-framework (e.g., MapBox, OpenStreetMap, ...). The VisiOmatic web client interface is fully asynchronous, and is particularly immune to connection glitches. It is embeddable in regular Web pages, blog posts, portals, or wiki entries, and is fully templatable. It is compatible with touchscreen interfaces such as those offered by iOS and Android mobile devices. The position and appearance of widgets is fully customizable through module options and Cascading Style Sheets. The graphic engine relies purely on Javascript and HTML5 and not on proprietary technology. It is fully compatible with the current breed of popular web browsers, including Mozilla Firefox (v94 and above), Google Chrome (v95 and above), Apple Safari (v15 and above), Microsoft Edge (v95 an above) and Opera (v80 and above).
### Web server
The VisiOmatic web server version 3 is written in the Python language. It replaces the IIPImage-astro FCGI (Fast Common Gateway Interface) C++ code of earlier VisiOmatic versions. It operates as a web-service that encodes and streams in real-time large high resolution images which are delivered in the form of compressed "tiles". It is designed to be fast and bandwidth-efficient.
Compared to other existing solutions, VisiOmatic has the advantage of providing on-the-fly compression to image formats natively supported in web browsers, as well as access to uncompressed pixel data. This means that it can operate directly on science-grade multichannel data stored in floating-point format, and perform operations such as rescaling or channel-mixing before sending out the resulting image to the client. Contrary to other solutions dealing with multispectral data, all the image processing and compositing is done server-side. This dramatically decreases the quantity of information that has to be sent to the browser, and the amount of computing which must be performed client-side, making the exploration of large datacubes from a smartphone a comfortable experience, even through a 4G connection.
## Data management
Previous versions of VisiOmatic would require the original image data files to be converted to a tiled multi-resolution TIFF format. The new version works directly on FITS images, including data cubes and MEF files, and performs image tiling and rebinning on-the-fly.
Vector data are stored in GeoJSON format. GeoJSON offers a compact, yet human-friendly representation of features such as markers, lines, polygons, and can easily be generated from e.g., CSV or ds9 region files.
## Security
Data security is a major issue for online services. In VisiOmatic, two mechanisms allow the webmaster to control the dissemination of data:
* Paths where the data files are located are not accessible from the web; they are only accessible by the server code, and absolute or relative access through upper levels of the directory tree is forbidden.
* The same origin security policy in web browsers restricts data access to servers located in the same domain as the server hosting the client code, and prevents Javascript applications on websites from other domains sending AJAX requests directly to the VisiOmatic server.
If however data sharing with other domains is a desired feature, VisiOmatic implements the CORS mechanism to allow such requests from selected or all external websites.
## Performance
Although Python is not the fastest language for manipulating data, VisiOmatic is fairly efficient. Current server code is able to serve thousands of 256×256 JPEG tiles per second per CPU core. The output image stream from a single 16-core server under heavy load (tens of thousands of tile requests per second) can thus easily saturate a 1 Gbit/s connection without caching.
## Portability
The server has been tested on the Linux, MacOS and Windows platforms. Note that presently only the Linux version can take advantage of multiple CPU cores, due to limitations with Python wrappers to low-level system libraries.
## License
Visiomatic is licensed under the [MIT License](https://raw.githubusercontent.com/astromatic/visiomatic/develop/LICENSE).
Raw data
{
"_id": null,
"home_page": null,
"name": "VisiOmatic",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "astronomy, CFHT, imaging",
"author": null,
"author_email": "Emmanuel Bertin <bertin@cfht.hawaii.edu>",
"download_url": "https://files.pythonhosted.org/packages/3a/ec/5596cef33f2668c474d46716a66f9ae2475b879a7d7c23a8189a5c1b0352/visiomatic-3.0.0.tar.gz",
"platform": null,
"description": "#  VisiOmatic 3\n\n[](https://github.com/astromatic/visiomatic/actions/workflows/doc.yml)[](https://github.com/astromatic/visiomatic/actions/workflows/tests.yml)\n[](https://codecov.io/gh/astromatic/visiomatic)\n\nVisiOmatic is a web application for visualizing astronomical images. This is the version 3 of the package. Code from the older versions can still be accessed through the [``legacy``](https://github.com/astromatic/visiomatic/tree/legacy) branch.\n\n## Installation\n\nYou can install Visiomatic via pip:\n\n```bash\npip install visiomatic\n```\n\n## Usage\n\n```bash\nvisiomatic image.fits\n```\n\n## Documentation\n\nA detailed documentation, including API reference is available [here](https://astromatic.github.io/visiomatic). Note: this is still work in progress.\n\n## Technical overview\n\nThe VisiOmatic package provides a complete remote visualization system for large multispectral/hyperspectral astronomical image data (or image sequences). The web client interface runs in standard web browsers, generating image requests to a server on behalf of the user. These HTTP requests are processed in real-time by the server, through a web API, to compute and deliver compressed images which are then updated almost immediately in the browser.\n\n### Web client\nThe VisiOmatic web client is built on top of the Leaflet Javascript mini-framework (e.g., MapBox, OpenStreetMap, ...). The VisiOmatic web client interface is fully asynchronous, and is particularly immune to connection glitches. It is embeddable in regular Web pages, blog posts, portals, or wiki entries, and is fully templatable. It is compatible with touchscreen interfaces such as those offered by iOS and Android mobile devices. The position and appearance of widgets is fully customizable through module options and Cascading Style Sheets. The graphic engine relies purely on Javascript and HTML5 and not on proprietary technology. It is fully compatible with the current breed of popular web browsers, including Mozilla Firefox (v94 and above), Google Chrome (v95 and above), Apple Safari (v15 and above), Microsoft Edge (v95 an above) and Opera (v80 and above).\n\n### Web server\n\nThe VisiOmatic web server version 3 is written in the Python language. It replaces the IIPImage-astro FCGI (Fast Common Gateway Interface) C++ code of earlier VisiOmatic versions. It operates as a web-service that encodes and streams in real-time large high resolution images which are delivered in the form of compressed \"tiles\". It is designed to be fast and bandwidth-efficient.\n\nCompared to other existing solutions, VisiOmatic has the advantage of providing on-the-fly compression to image formats natively supported in web browsers, as well as access to uncompressed pixel data. This means that it can operate directly on science-grade multichannel data stored in floating-point format, and perform operations such as rescaling or channel-mixing before sending out the resulting image to the client. Contrary to other solutions dealing with multispectral data, all the image processing and compositing is done server-side. This dramatically decreases the quantity of information that has to be sent to the browser, and the amount of computing which must be performed client-side, making the exploration of large datacubes from a smartphone a comfortable experience, even through a 4G connection.\n\n## Data management\n\nPrevious versions of VisiOmatic would require the original image data files to be converted to a tiled multi-resolution TIFF format. The new version works directly on FITS images, including data cubes and MEF files, and performs image tiling and rebinning on-the-fly.\n\nVector data are stored in GeoJSON format. GeoJSON offers a compact, yet human-friendly representation of features such as markers, lines, polygons, and can easily be generated from e.g., CSV or ds9 region files.\n\n## Security\n\nData security is a major issue for online services. In VisiOmatic, two mechanisms allow the webmaster to control the dissemination of data:\n\n* Paths where the data files are located are not accessible from the web; they are only accessible by the server code, and absolute or relative access through upper levels of the directory tree is forbidden.\n* The same origin security policy in web browsers restricts data access to servers located in the same domain as the server hosting the client code, and prevents Javascript applications on websites from other domains sending AJAX requests directly to the VisiOmatic server.\n\nIf however data sharing with other domains is a desired feature, VisiOmatic implements the CORS mechanism to allow such requests from selected or all external websites.\n\n## Performance\n\nAlthough Python is not the fastest language for manipulating data, VisiOmatic is fairly efficient. Current server code is able to serve thousands of 256\u00d7256 JPEG tiles per second per CPU core. The output image stream from a single 16-core server under heavy load (tens of thousands of tile requests per second) can thus easily saturate a 1 Gbit/s connection without caching.\n\n## Portability\n\nThe server has been tested on the Linux, MacOS and Windows platforms. Note that presently only the Linux version can take advantage of multiple CPU cores, due to limitations with Python wrappers to low-level system libraries.\n\n## License\n\nVisiomatic is licensed under the [MIT License](https://raw.githubusercontent.com/astromatic/visiomatic/develop/LICENSE).\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2022 Emmanuel Bertin\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.",
"summary": "A web application for visualizing astronomical images",
"version": "3.0.0",
"project_urls": {
"Documentation": "https://astromatic.github.io/visiomatic",
"Homepage": "https://visiomatic.org",
"Repository": "https://github.com/astromatic/visiomatic"
},
"split_keywords": [
"astronomy",
" cfht",
" imaging"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dac65aee45970e19b70dddb73d37e28836fa82d3241783f8d5b830623f301ef0",
"md5": "429079a48bb5d54b9b84e101fccd2135",
"sha256": "b691961b7ebdb2dfebe681025976ce6389ac92cb6c48cdfbe46a6f616dc74209"
},
"downloads": -1,
"filename": "visiomatic-3.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "429079a48bb5d54b9b84e101fccd2135",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6336809,
"upload_time": "2024-07-04T11:50:14",
"upload_time_iso_8601": "2024-07-04T11:50:14.130719Z",
"url": "https://files.pythonhosted.org/packages/da/c6/5aee45970e19b70dddb73d37e28836fa82d3241783f8d5b830623f301ef0/visiomatic-3.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3aec5596cef33f2668c474d46716a66f9ae2475b879a7d7c23a8189a5c1b0352",
"md5": "f759bd9a1df161011e8320344e646a0d",
"sha256": "6cb890d8e5be2b7e9e643b6e9432b197e6ce1bbf9eee51dfd3e65ec71c28a894"
},
"downloads": -1,
"filename": "visiomatic-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "f759bd9a1df161011e8320344e646a0d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 6261177,
"upload_time": "2024-07-04T11:50:20",
"upload_time_iso_8601": "2024-07-04T11:50:20.258625Z",
"url": "https://files.pythonhosted.org/packages/3a/ec/5596cef33f2668c474d46716a66f9ae2475b879a7d7c23a8189a5c1b0352/visiomatic-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-04 11:50:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "astromatic",
"github_project": "visiomatic",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "visiomatic"
}
