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

Path/Line Integrated Diagnostic (Abstract classes + interferometer implementation) #1123

Open
wants to merge 89 commits into
base: main
Choose a base branch
from

Conversation

pheuer
Copy link
Member

@pheuer pheuer commented Apr 23, 2021

This PR introduces a new abstract class "PathIntegratedDiagnostic" to the diagnostics module. This class abstracts the source/grid/detector geometry already used in SyntheticProtonRadiography. I've refactored the SyntheticProtonRadiograph module to be a subclass of the new class, but there are no API changes.

This PR also introuduces a subclass of PathIntegratedDiagnostic, LineIntegratedDiagnostic, which represents the case where the integration paths are straight lines. Given a grid object, this class can line-integrate through any quantity on the grid along any arbitrary straight line of sight. The quantity integrated is given by a "_integrand" method, which can be in turn be calculated using any combination of the quantities on the grid. Different diagnostics with non-trivial response functions (like proton radiography) can be implemented by just replacing this _integrand in subclasses.

This module could has many applications (x-ray radiography, linear-regime charged particle radiography, etc.), but for a start I've implemented a very basic interferometry function. Given a 1 mm radius sphere of constant density 3e19 cm^-3, the following is the predicted interferogram with a 263 nm probe beam

interferogram

The documentation still needs some work (I'll write one notebook explaining the interferometry subclass and another showing how to create and use custom subclasses). But I'm ready for comments on the basic structure of the LineIntegratedDiagnostic class!

…neIntegratedDiagnostic_Class

Updating brach from upstream to include grids.py
@pheuer
Copy link
Member Author

pheuer commented May 14, 2021

Thanks for the help, documentation wizard @rocco8773 !

Copy link
Member

@StanczakDominik StanczakDominik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All right, this looks great to me and I could see it being merged - unless @rocco8773 wants to take another sweep, since this falls under diagnostics? (if no, just hit merge!)

Also, is it just me, or does this look like the Batman logo?

@pheuer
Copy link
Member Author

pheuer commented May 18, 2021

Great! I don't see the batman logo even if I squint really really hard...I think you might need some sleep @StanczakDominik ;)

@StanczakDominik StanczakDominik mentioned this pull request May 26, 2021
@rocco8773 rocco8773 added this to the 0.7.0 milestone Jul 13, 2021
@rocco8773 rocco8773 self-assigned this Jul 13, 2021
@pheuer pheuer moved this from In progress to Awaiting Review in HEDP Diagnostics Jul 19, 2021
@rocco8773 rocco8773 modified the milestones: 0.7.0, 0.8.0 Aug 24, 2021
@rocco8773 rocco8773 added the status: ready for review PRs that are ready for code review label Mar 21, 2022
@rocco8773 rocco8773 modified the milestones: 0.8.0, 0.9.0 Jun 28, 2022
@namurphy namurphy removed this from the 0.9.0 milestone Oct 27, 2022
@namurphy namurphy added the status: dormant PRs that are stalled label May 26, 2023
@namurphy namurphy added this to the Future milestone Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
notebooks Related to example Jupyter notebooks in docs/examples/ plasmapy.diagnostics Related to the plasmapy.diagnostics subpackage plasmapy.plasma Related to the plasmapy.plasma subpackage status: dormant PRs that are stalled status: ready for review PRs that are ready for code review
Projects
HEDP Diagnostics
Awaiting Review
Development

Successfully merging this pull request may close these issues.

None yet

4 participants