ELEV_ORBITS_AND_SHADOWS-Python3
This is a package for Python 3.10, loaded with [OpenCV 4.10](https://pypi.org/project/opencv-python/) and [Imageio 2.36](https://pypi.org/project/imageio/), to plot orbits in Euclidean Reissner-Nordstrom (ERN) and Bertotti-Robinson (BR) spacetimes, as well as to drow (animated) shadows of the former, by backward ray-tracing. A classical (Lorentzian) Reissner-Nordstrom ray-tracer is included for comparison with the usual Lorentzian world.
The code is an analogue of the package ``knds_orbits_and_shadows`` (https://pypi.org/project/knds-orbits-and-shadows/) for classical Kerr-Newman-(anti) de Sitter black holes.
---------------------------------------------------------------------------------------------------
To install the package, simply run
``pip install elev_orbits_and_shadows``
Next, the package may be imported using
``import elev``
The user might also download the file `examples.py` from the github page to test the modules. It uses all the functions of the programs, so it should be a good indicator of the sanity of the package. It is divided in three parts: the first one tests the orbit and shadow display, the second one creates four gif files named `comet_*.gif` depicting animated orbits and the third one creates the folders `figureLorentzian_gif` and `figureEuclidean_gif`, containing gif files, that represent the shadow of a Lorentzian (resp. Euclidean) Reissner-Nordstrom spacetime, with a background celestial sphere that moves diagonally. The full execution takes about one minute and a half on a 12-core 2.60 GHz CPU with 16 Go of RAM.
---------------------------------------------------------------------------------------------------
Description of the main functions of the package:
- The function ``orbit`` computes the trajectory of a test particle in an Euclidean or Lorentzian Reissner-Nordstrom (RN) spacetime.
The synthax is
``Vecc=elev.orbit(Type,Mass,Charge,Tau,N,IniConds,lim)``
where `Type` is a string taking two values; if set to `"Lorentzian"`, then a classical RN spacetime is considered, while a Euclidean one is taken when `Type` is set to `"Euclidean"`. Next, `Mass` is the mass and `Charge` is the charge of the central body, appearing in the RN line element. The variable `Tau` is the maximal value of the Euclidean time at which the trajectory is computed and `N` is the number of discretization points. The vector `IniConds` records the initial datum of the geodesic, in Schwarzschild coordinates (and geometric units `G=c=1`), `IniConds=(r0,theta0,phi0,\dot{r}0,\dot{theta}0,\dot{phi}0)`. Finally, the variable `lim` denotes the maximal radius at which the orbit is drawn.
The output is a vector `Vecc` containing the position `(r,theta,phi)` (in geometric units `G=c=1`) of the trajectory at each node `k*Tau/N` (`0<k<n`) of the discretization.
- The function ``orbit_BR`` computes the trajectory of a test particle in a BR spacetime.
The synthax is
``Vecc=elev.orbit_BR(epsilon,Charge,mass,charge,Tau,N,IniConds,lim)``
where `epsilon` is the signature of the metric (`epsilon=1` in the Euclidean case, and `epsilon=-1` in the Lorentzian case), `Charge` is the constant `Q` of the spacetime, while `mass` and `charge` are the parameters `m,q` of the metric. The rest of the variables and the output have the same description and meaning as for the function orbit described above.
- The function ``shadow`` draws the shadow of an RN spacetime, with a standard image (jpeg, png...).
The synthax is
``elev.shadow(Type,Mass,Charge,v,Image)``
where `Type`, `Mass` and `Charge` are the parameters of the metric (in geometric units) and `v` is the velocity of the particle when hitting the eye of the observer, considered as being the velocity at infinity. In the `Type="Lorentzian"` case, if the velocity `v` is set to `v<1` (resp. `v=1`, `v>1`), then a timelike (resp. null, spacelike) geodesic is drawn in the spacetime
The variable ``Image`` is a string formed with the name (with extension) of the picture to transform (the file should be in the same folder as the .py files). The picture is encoded as a `(Nx,Ny,3)` hypermatrix using the library ``cv2``.
The output is the computed picture, as an (internal) matplotlib figure.
- The function ``deflection`` depicts the total deflection angle of orbits coming from infinity, to the eye of an observer, for an RN spacetime.
The synthax is
``elev.deflection(Type,Mass,Charge,v,N)``
where, again, `Type`, `Mass` and `Charge` are the parameters of the metric (in geometric units) and `v` is the velocity of the orbit hitting the observer, again viewed is the velocity at infinity. The variable `N` is the resolution of the desired picture.
The output is a matplotlib figure showing the deflections on an `N x N` image, along with a colorbar: the color of a pixel represents the value of the total deflection angle of the corresponding orbit.
- The gif creating routine consists of four functions ``shadow4gif``, ``make_gif``, ``DatFile4gif`` and ``make_gif_with_DatFile`` that are designed to create gif files depicting the shadow of a black hole with a moving celestial sphere.
The first function ``shadow4gif`` is an non-display analogue of the program shadow described above; this is an auxiliary function. It is called as ``shadow4gif(Type,Mass,Charge,v,Image_matrix)``, with `Type,Mass,Charge,v` as above. The variable `Image_matrix` is a hypermatrix of size `(Nx,Ny,3)` containing the BGR values of pixels of an image with resolution `(Nx,Ny)`.
The main function ``make_gif`` has synthax
``elev.make_gif(Nimages,Name,Image,Resol,Shifts,Direction,FPS,Type,Mass,Charge,v)``
with `Type,Mass,Charge,v` as before.
The variable `Nimages` is the number of images for the gif animation.
The variable `Name` (a string) is the name of the folder that will be created by the program and containing the gif file.
The variable `Image` is the background image to use for the celestial sphere, as above.
The variable `Resol` is a list with two integers representing the desired resolution for the gif.
The variable `Shifts` is a list with three entries: the first two correspond to the respective horizontal and vertical shifts (in number of pixels) defining the corner of the starting image. The third entry is a coefficient defining the frame rate of the animation, in number of pixels (i.e. at each step, the portion of the image is shifted by this number of pixels: the higher this number, the lower the frame rate.)
The variable `Direction` can take eight values: when set to `"h+"` (resp. to `"h-"`, `"v+"`, `"v-"`, `"d1+"`, `"d1-"`, `"d2+"`, `"d2-"`) the screen moves horizontally from left to right (resp. horizontally from right to left, vertically from bottom to top, vertically from top to bottom, diagonally from bottom-left to top-right, diagonally from top-right to bottom-left, diagonally from top-left to bottom-right, diagonally from bottom-right to top-left). Please note that it is the screen (celestial sphere) that moves, and not the camera: this is important when the black hole is not spherically symmetric.
The variable `FPS` defines the number of frames per second for the gif animation.
The output is a gif file, created in the new folder `Name_gif`.
The other two functions are made to create several gifs out of a single set of data, allowing to call the heavy function shadow only once.
More precisely, the function ``DatFile4gif`` is called as
``elev.DatFile4gif(Resol,Type,Mass,Charge,v)``
with each variable having the same meaning as above. The program creates the new folder `dat_files` (if it doesn't exist already) and puts there a .dat file, named `file_Resol_Type_Mass_Charge_v.dat`. This file contains all the variables needed to create any gif that could be made using a command of the form ``make_gif(-,-,-,Resol,-,-,-,Type,Mass,Charge,v)``. Basically, the program stores the hypermatrix obtained with the function ``shadow4gif``, applied to a specific hypermatrix `Image_matrix` of the appropriate size, encoded as a permutation of its pixels. The same permutation can then be applied to any other image of the same size, without having to call ``shadow`` again.
The other function ``make_gif_with_DatFile`` has the same synthax and output as ``make_gif``. But instead of calling the program ``shadow``, this function looks for a .dat file with appropriate parameters inside the folder `dat_files` to render the images. If no such file is found, an error is returned and the user should first use the function ``DatFile4gif`` to create it.
---------------------------------------------------------------------------------------------------
For more details on the equations and modelization, the reader is refered to the article by the author, available at https://link.springer.com/article/10.1140/epjc/s10052-024-12719-4
For any question, suggestion, commentary, remark, the user is invited to contact the author by email at arthur.garnier[at]math[dot]cnrs[dot]fr.
Raw data
{
"_id": null,
"home_page": "https://github.com/arthur-garnier/euclidean_orbits_and_shadows",
"name": "elev-orbits-and-shadows",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "python, euclidean spacetime, instanton, reissner-nordstrom, bertotti-robinson, schwarzschild, black hole, orbit, black hole shadowing, spacetime shadowing, backward ray-tracing, gif",
"author": "Arthur Garnier",
"author_email": "<arthur.garnier@math.cnrs.fr>",
"download_url": "https://files.pythonhosted.org/packages/fd/af/dd2b62ecbba87a49f4f8b4fdac7e73f8cd4718c1e8ac8895e7daa7ac2245/elev_orbits_and_shadows-1.1.tar.gz",
"platform": null,
"description": " ELEV_ORBITS_AND_SHADOWS-Python3\n\nThis is a package for Python 3.10, loaded with [OpenCV 4.10](https://pypi.org/project/opencv-python/) and [Imageio 2.36](https://pypi.org/project/imageio/), to plot orbits in Euclidean Reissner-Nordstrom (ERN) and Bertotti-Robinson (BR) spacetimes, as well as to drow (animated) shadows of the former, by backward ray-tracing. A classical (Lorentzian) Reissner-Nordstrom ray-tracer is included for comparison with the usual Lorentzian world.\n\nThe code is an analogue of the package ``knds_orbits_and_shadows`` (https://pypi.org/project/knds-orbits-and-shadows/) for classical Kerr-Newman-(anti) de Sitter black holes.\n\n---------------------------------------------------------------------------------------------------\n\nTo install the package, simply run \n\n``pip install elev_orbits_and_shadows``\n\nNext, the package may be imported using\n\n``import elev``\n\nThe user might also download the file `examples.py` from the github page to test the modules. It uses all the functions of the programs, so it should be a good indicator of the sanity of the package. It is divided in three parts: the first one tests the orbit and shadow display, the second one creates four gif files named `comet_*.gif` depicting animated orbits and the third one creates the folders `figureLorentzian_gif` and `figureEuclidean_gif`, containing gif files, that represent the shadow of a Lorentzian (resp. Euclidean) Reissner-Nordstrom spacetime, with a background celestial sphere that moves diagonally. The full execution takes about one minute and a half on a 12-core 2.60 GHz CPU with 16 Go of RAM.\n\n---------------------------------------------------------------------------------------------------\n\nDescription of the main functions of the package:\n\n\n\n- The function ``orbit`` computes the trajectory of a test particle in an Euclidean or Lorentzian Reissner-Nordstrom (RN) spacetime.\n\nThe synthax is\n\n``Vecc=elev.orbit(Type,Mass,Charge,Tau,N,IniConds,lim)``\n\nwhere `Type` is a string taking two values; if set to `\"Lorentzian\"`, then a classical RN spacetime is considered, while a Euclidean one is taken when `Type` is set to `\"Euclidean\"`. Next, `Mass` is the mass and `Charge` is the charge of the central body, appearing in the RN line element. The variable `Tau` is the maximal value of the Euclidean time at which the trajectory is computed and `N` is the number of discretization points. The vector `IniConds` records the initial datum of the geodesic, in Schwarzschild coordinates (and geometric units `G=c=1`), `IniConds=(r0,theta0,phi0,\\dot{r}0,\\dot{theta}0,\\dot{phi}0)`. Finally, the variable `lim` denotes the maximal radius at which the orbit is drawn.\n\nThe output is a vector `Vecc` containing the position `(r,theta,phi)` (in geometric units `G=c=1`) of the trajectory at each node `k*Tau/N` (`0<k<n`) of the discretization.\n\n\n\n- The function ``orbit_BR`` computes the trajectory of a test particle in a BR spacetime.\n\nThe synthax is\n\n``Vecc=elev.orbit_BR(epsilon,Charge,mass,charge,Tau,N,IniConds,lim)``\n\nwhere `epsilon` is the signature of the metric (`epsilon=1` in the Euclidean case, and `epsilon=-1` in the Lorentzian case), `Charge` is the constant `Q` of the spacetime, while `mass` and `charge` are the parameters `m,q` of the metric. The rest of the variables and the output have the same description and meaning as for the function orbit described above.\n\n\n\n- The function ``shadow`` draws the shadow of an RN spacetime, with a standard image (jpeg, png...).\n\nThe synthax is\n\n``elev.shadow(Type,Mass,Charge,v,Image)``\n\nwhere `Type`, `Mass` and `Charge` are the parameters of the metric (in geometric units) and `v` is the velocity of the particle when hitting the eye of the observer, considered as being the velocity at infinity. In the `Type=\"Lorentzian\"` case, if the velocity `v` is set to `v<1` (resp. `v=1`, `v>1`), then a timelike (resp. null, spacelike) geodesic is drawn in the spacetime\nThe variable ``Image`` is a string formed with the name (with extension) of the picture to transform (the file should be in the same folder as the .py files). The picture is encoded as a `(Nx,Ny,3)` hypermatrix using the library ``cv2``.\n\nThe output is the computed picture, as an (internal) matplotlib figure.\n\n\n\n- The function ``deflection`` depicts the total deflection angle of orbits coming from infinity, to the eye of an observer, for an RN spacetime.\n\nThe synthax is\n\n``elev.deflection(Type,Mass,Charge,v,N)``\n\nwhere, again, `Type`, `Mass` and `Charge` are the parameters of the metric (in geometric units) and `v` is the velocity of the orbit hitting the observer, again viewed is the velocity at infinity. The variable `N` is the resolution of the desired picture.\n\nThe output is a matplotlib figure showing the deflections on an `N x N` image, along with a colorbar: the color of a pixel represents the value of the total deflection angle of the corresponding orbit.\n\n\n\n- The gif creating routine consists of four functions ``shadow4gif``, ``make_gif``, ``DatFile4gif`` and ``make_gif_with_DatFile`` that are designed to create gif files depicting the shadow of a black hole with a moving celestial sphere.\n\nThe first function ``shadow4gif`` is an non-display analogue of the program shadow described above; this is an auxiliary function. It is called as ``shadow4gif(Type,Mass,Charge,v,Image_matrix)``, with `Type,Mass,Charge,v` as above. The variable `Image_matrix` is a hypermatrix of size `(Nx,Ny,3)` containing the BGR values of pixels of an image with resolution `(Nx,Ny)`.\nThe main function ``make_gif`` has synthax\n\n``elev.make_gif(Nimages,Name,Image,Resol,Shifts,Direction,FPS,Type,Mass,Charge,v)``\n\nwith `Type,Mass,Charge,v` as before.\nThe variable `Nimages` is the number of images for the gif animation.\nThe variable `Name` (a string) is the name of the folder that will be created by the program and containing the gif file.\nThe variable `Image` is the background image to use for the celestial sphere, as above.\nThe variable `Resol` is a list with two integers representing the desired resolution for the gif.\nThe variable `Shifts` is a list with three entries: the first two correspond to the respective horizontal and vertical shifts (in number of pixels) defining the corner of the starting image. The third entry is a coefficient defining the frame rate of the animation, in number of pixels (i.e. at each step, the portion of the image is shifted by this number of pixels: the higher this number, the lower the frame rate.)\nThe variable `Direction` can take eight values: when set to `\"h+\"` (resp. to `\"h-\"`, `\"v+\"`, `\"v-\"`, `\"d1+\"`, `\"d1-\"`, `\"d2+\"`, `\"d2-\"`) the screen moves horizontally from left to right (resp. horizontally from right to left, vertically from bottom to top, vertically from top to bottom, diagonally from bottom-left to top-right, diagonally from top-right to bottom-left, diagonally from top-left to bottom-right, diagonally from bottom-right to top-left). Please note that it is the screen (celestial sphere) that moves, and not the camera: this is important when the black hole is not spherically symmetric.\nThe variable `FPS` defines the number of frames per second for the gif animation.\n\nThe output is a gif file, created in the new folder `Name_gif`.\n\n\nThe other two functions are made to create several gifs out of a single set of data, allowing to call the heavy function shadow only once.\nMore precisely, the function ``DatFile4gif`` is called as\n\n``elev.DatFile4gif(Resol,Type,Mass,Charge,v)``\n\nwith each variable having the same meaning as above. The program creates the new folder `dat_files` (if it doesn't exist already) and puts there a .dat file, named `file_Resol_Type_Mass_Charge_v.dat`. This file contains all the variables needed to create any gif that could be made using a command of the form ``make_gif(-,-,-,Resol,-,-,-,Type,Mass,Charge,v)``. Basically, the program stores the hypermatrix obtained with the function ``shadow4gif``, applied to a specific hypermatrix `Image_matrix` of the appropriate size, encoded as a permutation of its pixels. The same permutation can then be applied to any other image of the same size, without having to call ``shadow`` again.\nThe other function ``make_gif_with_DatFile`` has the same synthax and output as ``make_gif``. But instead of calling the program ``shadow``, this function looks for a .dat file with appropriate parameters inside the folder `dat_files` to render the images. If no such file is found, an error is returned and the user should first use the function ``DatFile4gif`` to create it.\n\n\n\n---------------------------------------------------------------------------------------------------\n\nFor more details on the equations and modelization, the reader is refered to the article by the author, available at https://link.springer.com/article/10.1140/epjc/s10052-024-12719-4\nFor any question, suggestion, commentary, remark, the user is invited to contact the author by email at arthur.garnier[at]math[dot]cnrs[dot]fr.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Python3 package drawing orbits and shadows of Euclidean and Lorentzian electro-vacuum (elev) spacetimes",
"version": "1.1",
"project_urls": {
"Homepage": "https://github.com/arthur-garnier/euclidean_orbits_and_shadows"
},
"split_keywords": [
"python",
" euclidean spacetime",
" instanton",
" reissner-nordstrom",
" bertotti-robinson",
" schwarzschild",
" black hole",
" orbit",
" black hole shadowing",
" spacetime shadowing",
" backward ray-tracing",
" gif"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6278d20caad01a1c3b95a8afeef57c035a76f804fe80ffb989cf8deb160109a7",
"md5": "af8e8c13dcd087025caad7d04a3c8334",
"sha256": "67606c094eb559bf59f6ea1685e25f1e9357a24c436efe732a66392927107111"
},
"downloads": -1,
"filename": "elev_orbits_and_shadows-1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "af8e8c13dcd087025caad7d04a3c8334",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 24054,
"upload_time": "2024-10-23T16:47:58",
"upload_time_iso_8601": "2024-10-23T16:47:58.587538Z",
"url": "https://files.pythonhosted.org/packages/62/78/d20caad01a1c3b95a8afeef57c035a76f804fe80ffb989cf8deb160109a7/elev_orbits_and_shadows-1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fdafdd2b62ecbba87a49f4f8b4fdac7e73f8cd4718c1e8ac8895e7daa7ac2245",
"md5": "f869a56cf2157ad255b91d2e7f77242f",
"sha256": "caa65cc75b080f4c1c221d374a5fcbe1034ea75c5ad8d4a7ab3197a4443cadee"
},
"downloads": -1,
"filename": "elev_orbits_and_shadows-1.1.tar.gz",
"has_sig": false,
"md5_digest": "f869a56cf2157ad255b91d2e7f77242f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 27597,
"upload_time": "2024-10-23T16:48:00",
"upload_time_iso_8601": "2024-10-23T16:48:00.846379Z",
"url": "https://files.pythonhosted.org/packages/fd/af/dd2b62ecbba87a49f4f8b4fdac7e73f8cd4718c1e8ac8895e7daa7ac2245/elev_orbits_and_shadows-1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-23 16:48:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "arthur-garnier",
"github_project": "euclidean_orbits_and_shadows",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "elev-orbits-and-shadows"
}
JSON
