Skip to content

Clean up documentation for Gaussian Splatting model #32

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.

Sign up for GitHub

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

Open
AxelHenningsson wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Clean up documentation for Gaussian Splatting model #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/_images/many_crystals_quartz.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/single_crystal_quartz.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/testing_rocking_curves.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
582 changes: 582 additions & 0 deletions docs/_sources/gaussian_model_theory.rst.txt
View file
Open in desktop

Large diffs are not rendered by default.

16 changes: 6 additions & 10 deletions docs/_sources/index.rst.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
.. toctree::
:maxdepth: 2
:caption: Contents:

.. include:: ../../README.rst

======================================
Expand Down Expand Up @@ -50,16 +46,16 @@ motion
:members:
:inherited-members:

templates
gaussian_crystal_model
======================================

.. automodule:: xrd_simulator.templates
:members:
:inherited-members:
.. automodule:: xrd_simulator.gaussian_crystal_model
:members:
:inherited-members:

laue
templates
======================================

.. automodule:: xrd_simulator.laue
.. automodule:: xrd_simulator.templates
:members:
:inherited-members:
626 changes: 626 additions & 0 deletions docs/gaussian_model_theory.html
View file
Open in desktop

Large diffs are not rendered by default.

48 changes: 39 additions & 9 deletions docs/genindex.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,12 @@ <h2 id="D">D</h2>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#xrd_simulator.detector.Detector">Detector (class in xrd_simulator.detector)</a>
</li>
<li><a href="index.html#xrd_simulator.polycrystal.Polycrystal.diffract">diffract() (xrd_simulator.polycrystal.Polycrystal method)</a>
<li><a href="index.html#xrd_simulator.gaussian_crystal_model.GaussianPolycrystal.diffract">diffract() (xrd_simulator.gaussian_crystal_model.GaussianPolycrystal method)</a>

<ul>
<li><a href="index.html#xrd_simulator.polycrystal.Polycrystal.diffract">(xrd_simulator.polycrystal.Polycrystal method)</a>
</li>
</ul></li>
<li><a href="index.html#xrd_simulator.mesh.TetraMesh.dof">dof (xrd_simulator.mesh.TetraMesh attribute)</a>
</li>
</ul></td>
Expand Down Expand Up @@ -190,9 +194,15 @@ <h2 id="G">G</h2>
<li><a href="index.html#xrd_simulator.detector.Detector.gaussian_kernel">gaussian_kernel (xrd_simulator.detector.Detector attribute)</a>
</li>
<li><a href="index.html#xrd_simulator.detector.Detector.gaussian_sigma">gaussian_sigma (xrd_simulator.detector.Detector attribute)</a>
</li>
<li><a href="index.html#xrd_simulator.beam.GaussianBeam">GaussianBeam (class in xrd_simulator.beam)</a>
</li>
<li><a href="index.html#xrd_simulator.gaussian_crystal_model.GaussianPolycrystal">GaussianPolycrystal (class in xrd_simulator.gaussian_crystal_model)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#xrd_simulator.gaussian_crystal_model.GaussianSubgrain">GaussianSubgrain (class in xrd_simulator.gaussian_crystal_model)</a>
</li>
<li><a href="index.html#xrd_simulator.mesh.TetraMesh.generate_mesh_from_levelset">generate_mesh_from_levelset() (xrd_simulator.mesh.TetraMesh class method)</a>
</li>
<li><a href="index.html#xrd_simulator.mesh.TetraMesh.generate_mesh_from_vertices">generate_mesh_from_vertices() (xrd_simulator.mesh.TetraMesh class method)</a>
Expand Down Expand Up @@ -256,6 +266,8 @@ <h2 id="M">M</h2>
<li><a href="index.html#xrd_simulator.polycrystal.Polycrystal.mesh_sample">mesh_sample (xrd_simulator.polycrystal.Polycrystal attribute)</a>
</li>
<li><a href="index.html#xrd_simulator.phase.Phase.miller_indices">miller_indices (xrd_simulator.phase.Phase attribute)</a>
</li>
<li><a href="index.html#xrd_simulator.gaussian_crystal_model.GaussianSubgrain.misorientation_tensor">misorientation_tensor (xrd_simulator.gaussian_crystal_model.GaussianSubgrain attribute)</a>
</li>
<li>
module
Expand All @@ -265,7 +277,7 @@ <h2 id="M">M</h2>
</li>
<li><a href="index.html#module-xrd_simulator.detector">xrd_simulator.detector</a>
</li>
<li><a href="index.html#module-xrd_simulator.laue">xrd_simulator.laue</a>
<li><a href="index.html#module-xrd_simulator.gaussian_crystal_model">xrd_simulator.gaussian_crystal_model</a>
</li>
<li><a href="index.html#module-xrd_simulator.mesh">xrd_simulator.mesh</a>
</li>
Expand Down Expand Up @@ -296,6 +308,8 @@ <h2 id="N">N</h2>
<h2 id="O">O</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#xrd_simulator.gaussian_crystal_model.GaussianSubgrain.orientation">orientation (xrd_simulator.gaussian_crystal_model.GaussianSubgrain attribute)</a>
</li>
<li><a href="index.html#xrd_simulator.polycrystal.Polycrystal.orientation_lab">orientation_lab (xrd_simulator.polycrystal.Polycrystal attribute)</a>
</li>
</ul></td>
Expand All @@ -315,6 +329,8 @@ <h2 id="P">P</h2>
<li><a href="index.html#xrd_simulator.detector.Detector.peaks_detector_intersection">peaks_detector_intersection() (xrd_simulator.detector.Detector method)</a>
</li>
<li><a href="index.html#xrd_simulator.phase.Phase">Phase (class in xrd_simulator.phase)</a>
</li>
<li><a href="index.html#xrd_simulator.gaussian_crystal_model.GaussianSubgrain.phase">phase (xrd_simulator.gaussian_crystal_model.GaussianSubgrain attribute)</a>
</li>
<li><a href="index.html#xrd_simulator.polycrystal.Polycrystal.phases">phases (xrd_simulator.polycrystal.Polycrystal attribute)</a>
</li>
Expand All @@ -333,6 +349,8 @@ <h2 id="P">P</h2>
<li><a href="index.html#xrd_simulator.polycrystal.Polycrystal">Polycrystal (class in xrd_simulator.polycrystal)</a>
</li>
<li><a href="index.html#xrd_simulator.templates.polycrystal_from_odf">polycrystal_from_odf() (in module xrd_simulator.templates)</a>
</li>
<li><a href="index.html#xrd_simulator.gaussian_crystal_model.GaussianSubgrain.position">position (xrd_simulator.gaussian_crystal_model.GaussianSubgrain attribute)</a>
</li>
</ul></td>
</tr></table>
Expand All @@ -341,17 +359,19 @@ <h2 id="R">R</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#xrd_simulator.detector.Detector.render">render() (xrd_simulator.detector.Detector method)</a>
</li>
<li><a href="index.html#xrd_simulator.detector.Detector.render_gaussian_splats">render_gaussian_splats() (xrd_simulator.detector.Detector method)</a>
</li>
<li><a href="index.html#xrd_simulator.motion.RigidBodyMotion">RigidBodyMotion (class in xrd_simulator.motion)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#xrd_simulator.mesh.TetraMesh.rotate">rotate() (xrd_simulator.mesh.TetraMesh method)</a>

<ul>
<li><a href="index.html#xrd_simulator.motion.RigidBodyMotion.rotate">(xrd_simulator.motion.RigidBodyMotion method)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#xrd_simulator.motion.RigidBodyMotion.rotation_angle">rotation_angle (xrd_simulator.motion.RigidBodyMotion attribute)</a>
</li>
<li><a href="index.html#xrd_simulator.motion.RigidBodyMotion.rotation_axis">rotation_axis (xrd_simulator.motion.RigidBodyMotion attribute)</a>
Expand All @@ -376,15 +396,21 @@ <h2 id="S">S</h2>
<li><a href="index.html#xrd_simulator.polycrystal.Polycrystal.save">(xrd_simulator.polycrystal.Polycrystal method)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#xrd_simulator.beam.Beam.set_beam_vertices">set_beam_vertices() (xrd_simulator.beam.Beam method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#xrd_simulator.phase.Phase.sgname">sgname (xrd_simulator.phase.Phase attribute)</a>
</li>
<li><a href="index.html#xrd_simulator.gaussian_crystal_model.GaussianSubgrain.shape_tensor">shape_tensor (xrd_simulator.gaussian_crystal_model.GaussianSubgrain attribute)</a>
</li>
<li><a href="index.html#xrd_simulator.gaussian_crystal_model.GaussianPolycrystal.splat_grainshapes">splat_grainshapes() (xrd_simulator.gaussian_crystal_model.GaussianPolycrystal method)</a>
</li>
<li><a href="index.html#xrd_simulator.polycrystal.Polycrystal.strain_lab">strain_lab (xrd_simulator.polycrystal.Polycrystal attribute)</a>
</li>
<li><a href="index.html#xrd_simulator.polycrystal.Polycrystal.strain_sample">strain_sample (xrd_simulator.polycrystal.Polycrystal attribute)</a>
</li>
<li><a href="index.html#xrd_simulator.gaussian_crystal_model.GaussianSubgrain.strain_tensor">strain_tensor (xrd_simulator.gaussian_crystal_model.GaussianSubgrain attribute)</a>
</li>
<li><a href="index.html#xrd_simulator.detector.Detector.structure_factor">structure_factor (xrd_simulator.detector.Detector attribute)</a>
</li>
Expand All @@ -398,8 +424,12 @@ <h2 id="T">T</h2>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#xrd_simulator.mesh.TetraMesh">TetraMesh (class in xrd_simulator.mesh)</a>
</li>
<li><a href="index.html#xrd_simulator.polycrystal.Polycrystal.transform">transform() (xrd_simulator.polycrystal.Polycrystal method)</a>
<li><a href="index.html#xrd_simulator.gaussian_crystal_model.GaussianPolycrystal.transform">transform() (xrd_simulator.gaussian_crystal_model.GaussianPolycrystal method)</a>

<ul>
<li><a href="index.html#xrd_simulator.polycrystal.Polycrystal.transform">(xrd_simulator.polycrystal.Polycrystal method)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#xrd_simulator.mesh.TetraMesh.translate">translate() (xrd_simulator.mesh.TetraMesh method)</a>
Expand Down Expand Up @@ -463,10 +493,10 @@ <h2 id="X">X</h2>
</li>
</ul></li>
<li>
xrd_simulator.laue
xrd_simulator.gaussian_crystal_model

<ul>
<li><a href="index.html#module-xrd_simulator.laue">module</a>
<li><a href="index.html#module-xrd_simulator.gaussian_crystal_model">module</a>
</li>
</ul></li>
<li>
Expand Down
Loading
Loading