| Name | wassncplot JSON |
| Version |
2.5.3
JSON |
| download |
| home_page | None |
| Summary | WASSncplot is a small tool to plot NetCDF 3D data generated with WASS on top of the original image files. |
| upload_time | 2024-04-23 07:33:09 |
| maintainer | None |
| docs_url | None |
| author | Filippo Bergamasco |
| requires_python | >=3.9 |
| license | GPL3 |
| keywords |
wass
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# WASSncplot
WASSncplot is a small tool to plot NetCDF 3D data generated with
[WASS](http://www.dais.unive.it/wass) and [wassgridsurface](https://pypi.org/project/wassgridsurface/) on top of the original image files.
<img src="https://www.dais.unive.it/wass/files/00000249.jpg" width="100%" />
## Install
WASSncplot requires a Python 3.9 and can simply be installed via pip:
```
$ python -m pip install wassncplot
```
## Run wassncplot on a headless system
To use wassncplot while connected remotely via ssh, launch Xvfb first:
```
sudo Xvfb :1 -ac -screen 0 1280x720x24
```
and then set export the DISPLAY environment variable `export DISPLAY=:1` before running wassncplot.
## Usage
WASSncplot is a command-line tool. You can get a description of the available program
arguments with the following command:
```
wassncplot v. 2.2.1
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
Copyright (C) Filippo Bergamasco 2023
usage: wassncplot [-h] [-f FIRST_INDEX] [-l LAST_INDEX] [-s STEP_INDEX]
[-sd STEP_DATA_INDEX] [-b BASELINE] [--zmin ZMIN]
[--zmax ZMAX] [--alpha ALPHA] [--pxscale PXSCALE]
[--text_prefix TEXT_PREFIX] [--wireframe] [--upscale2x]
[--applymask] [--no-wireframe] [--no-textoverlay]
[--savexyz] [--create-texture] [--save-texture] [--saveimg]
[--ffmpeg] [--ffmpeg-delete-frames]
[--ffmpeg-fps FFMPEG_FPS]
ncfile out
positional arguments:
ncfile Input NetCDF4 file
out Output directory where the produced images will be
stored
optional arguments:
-h, --help show this help message and exit
-f FIRST_INDEX, --first_index FIRST_INDEX
First data index to process
-l LAST_INDEX, --last_index LAST_INDEX
Last data index to process (-1 to process all the
frames)
-s STEP_INDEX, --step_index STEP_INDEX
Sequence step
-sd STEP_DATA_INDEX, --step_data_index STEP_DATA_INDEX
Sequence data step
-b BASELINE, --baseline BASELINE
Baseline of the stereo system (use this option to
override the baseline value stored in the NetCDF file)
--zmin ZMIN Minimum 3D point elevation (used for colorbar limits)
--zmax ZMAX Maximum 3D point elevation (used for colorbar limits)
--alpha ALPHA Surface transparency [0..1] (default 0.5)
--pxscale PXSCALE A scale factor to apply between logical and physical
pixels in addition to the actual scale factor
determined by the backend. (default 1)
--text_prefix TEXT_PREFIX
Bottom overlay text prefix
--wireframe Render surface in wireframe (default)
--upscale2x Upscale the input image before rendering
--applymask Apply user-defined mask if available
--no-wireframe Render shaded surface
--no-textoverlay Add text overlay at the bottom of the frame
--savexyz Save mapping between image pixels and 3D coordinates
as numpy data file
--create-texture Compute sea surface radiance for each grid point and
store it into the input NetCDF file.
--save-texture Save each sea surface radiance texture to a png image
(data is also stored in the NetCDF)
--saveimg Save the undistorted image (without the superimposed
grid)
--ffmpeg Call ffmpeg to create a sequence video file
--ffmpeg-delete-frames
Delete the produced frames after running ffmpeg
--ffmpeg-fps FFMPEG_FPS
Sequence framerate
```
For example, the command:
```
$ python wassncplot.py ./wass_20140327_0910/3D/wass__20140327_091000.nc ./out
```
Will render the sequence stored in ```./wass_20140327_0910/3D/wass__20140327_091000.nc``` to the directory ```./out```.
## License
```
Copyright (C) 2019-2022 Filippo Bergamasco
wassncplot is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
WASS is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
```
Raw data
{
"_id": null,
"home_page": null,
"name": "wassncplot",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "WASS",
"author": "Filippo Bergamasco",
"author_email": "filippo.bergamasco@unive.it",
"download_url": "https://files.pythonhosted.org/packages/83/29/d223f973e5974a5199af0012347c2f896216422d83a67e301a5cd8e7eb71/wassncplot-2.5.3.tar.gz",
"platform": null,
"description": "# WASSncplot\n\nWASSncplot is a small tool to plot NetCDF 3D data generated with\n[WASS](http://www.dais.unive.it/wass) and [wassgridsurface](https://pypi.org/project/wassgridsurface/) on top of the original image files.\n\n<img src=\"https://www.dais.unive.it/wass/files/00000249.jpg\" width=\"100%\" />\n\n## Install\n\nWASSncplot requires a Python 3.9 and can simply be installed via pip:\n\n```\n$ python -m pip install wassncplot\n```\n\n\n## Run wassncplot on a headless system\n\nTo use wassncplot while connected remotely via ssh, launch Xvfb first:\n\n```\nsudo Xvfb :1 -ac -screen 0 1280x720x24 \n```\n\nand then set export the DISPLAY environment variable `export DISPLAY=:1` before running wassncplot.\n\n\n\n## Usage\n\nWASSncplot is a command-line tool. You can get a description of the available program\narguments with the following command: \n\n```\n wassncplot v. 2.2.1\n=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-\nCopyright (C) Filippo Bergamasco 2023 \n\nusage: wassncplot [-h] [-f FIRST_INDEX] [-l LAST_INDEX] [-s STEP_INDEX]\n [-sd STEP_DATA_INDEX] [-b BASELINE] [--zmin ZMIN]\n [--zmax ZMAX] [--alpha ALPHA] [--pxscale PXSCALE]\n [--text_prefix TEXT_PREFIX] [--wireframe] [--upscale2x]\n [--applymask] [--no-wireframe] [--no-textoverlay]\n [--savexyz] [--create-texture] [--save-texture] [--saveimg]\n [--ffmpeg] [--ffmpeg-delete-frames]\n [--ffmpeg-fps FFMPEG_FPS]\n ncfile out\n\npositional arguments:\n ncfile Input NetCDF4 file\n out Output directory where the produced images will be\n stored\n\noptional arguments:\n -h, --help show this help message and exit\n -f FIRST_INDEX, --first_index FIRST_INDEX\n First data index to process\n -l LAST_INDEX, --last_index LAST_INDEX\n Last data index to process (-1 to process all the\n frames)\n -s STEP_INDEX, --step_index STEP_INDEX\n Sequence step\n -sd STEP_DATA_INDEX, --step_data_index STEP_DATA_INDEX\n Sequence data step\n -b BASELINE, --baseline BASELINE\n Baseline of the stereo system (use this option to\n override the baseline value stored in the NetCDF file)\n --zmin ZMIN Minimum 3D point elevation (used for colorbar limits)\n --zmax ZMAX Maximum 3D point elevation (used for colorbar limits)\n --alpha ALPHA Surface transparency [0..1] (default 0.5)\n --pxscale PXSCALE A scale factor to apply between logical and physical\n pixels in addition to the actual scale factor\n determined by the backend. (default 1)\n --text_prefix TEXT_PREFIX\n Bottom overlay text prefix\n --wireframe Render surface in wireframe (default)\n --upscale2x Upscale the input image before rendering\n --applymask Apply user-defined mask if available\n --no-wireframe Render shaded surface\n --no-textoverlay Add text overlay at the bottom of the frame\n --savexyz Save mapping between image pixels and 3D coordinates\n as numpy data file\n --create-texture Compute sea surface radiance for each grid point and\n store it into the input NetCDF file.\n --save-texture Save each sea surface radiance texture to a png image\n (data is also stored in the NetCDF)\n --saveimg Save the undistorted image (without the superimposed\n grid)\n --ffmpeg Call ffmpeg to create a sequence video file\n --ffmpeg-delete-frames\n Delete the produced frames after running ffmpeg\n --ffmpeg-fps FFMPEG_FPS\n Sequence framerate\n```\n\n\nFor example, the command:\n\n```\n$ python wassncplot.py ./wass_20140327_0910/3D/wass__20140327_091000.nc ./out \n```\n\nWill render the sequence stored in ```./wass_20140327_0910/3D/wass__20140327_091000.nc``` to the directory ```./out```.\n\n\n## License\n\n```\nCopyright (C) 2019-2022 Filippo Bergamasco \n\nwassncplot is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nWASS is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program. If not, see <http://www.gnu.org/licenses/>.\n```\n",
"bugtrack_url": null,
"license": "GPL3",
"summary": "WASSncplot is a small tool to plot NetCDF 3D data generated with WASS on top of the original image files.",
"version": "2.5.3",
"project_urls": {
"repository": "https://github.com/fbergama/wassncplot"
},
"split_keywords": [
"wass"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4bf9d1d245810cb2424cea66db52b71d24da9c69e90744deba7050e0154413fd",
"md5": "0cd464564adc15901f6667804501423a",
"sha256": "fe87903025bd22a6d07ac921de215c206bebfa6f1b9bd754f0fef508063eeae1"
},
"downloads": -1,
"filename": "wassncplot-2.5.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0cd464564adc15901f6667804501423a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 13895,
"upload_time": "2024-04-23T07:33:07",
"upload_time_iso_8601": "2024-04-23T07:33:07.835455Z",
"url": "https://files.pythonhosted.org/packages/4b/f9/d1d245810cb2424cea66db52b71d24da9c69e90744deba7050e0154413fd/wassncplot-2.5.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8329d223f973e5974a5199af0012347c2f896216422d83a67e301a5cd8e7eb71",
"md5": "d719e5e392088a5aff6bb434fb6c054e",
"sha256": "4ad2929b5a66bfd9a31fe1f8fe7e352529344503f7665f0fbbf447c1d66db00c"
},
"downloads": -1,
"filename": "wassncplot-2.5.3.tar.gz",
"has_sig": false,
"md5_digest": "d719e5e392088a5aff6bb434fb6c054e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 13118,
"upload_time": "2024-04-23T07:33:09",
"upload_time_iso_8601": "2024-04-23T07:33:09.042507Z",
"url": "https://files.pythonhosted.org/packages/83/29/d223f973e5974a5199af0012347c2f896216422d83a67e301a5cd8e7eb71/wassncplot-2.5.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-23 07:33:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fbergama",
"github_project": "wassncplot",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "wassncplot"
}
