Skip to content

Commit 86ae57a

Browse files
committed
Add Particle Analysis Documentation
1 parent 3bb6060 commit 86ae57a

1 file changed

Lines changed: 40 additions & 1 deletion

File tree

docs/particle_analysis.rst

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,43 @@
22

33
*****************
44
Particle Analysis
5-
*****************
5+
*****************
6+
7+
Once you have chosen your segmentation parameters and successfully prepared a prameters object you can use this to perform Particle Analysis.
8+
9+
.. code-block:: python
10+
11+
>>> import hyperspy.api as hs
12+
>>> data = hs.load('ParticleSpy/Data/JEOL HAADF Image.dm4')
13+
>>> params = ps.parameters()
14+
>>> params.load()
15+
>>> particles = ps.ParticleAnalysis(data, params)
16+
17+
Particle Analysis will run the segmentation on your data and calculate a number of parameters for each particle.
18+
19+
The calculated parameters include:
20+
- Area
21+
- Equivalent circular diameter
22+
- Major and minor axes lengths
23+
- Circularity
24+
- Eccentricity
25+
- Total particle intensity
26+
- Zone axis (if atomic resolution images of fcc structure, looking to expand this!)
27+
28+
.. code-block:: python
29+
30+
>>> #Syntax for accessing particle properties.
31+
>>> particles.list[0].properties['area']
32+
33+
In addition, Particle Analysis will also segment and process EDS data if given as an additional dataset in the data list.
34+
35+
Particle Analysis can do the following processing on EDS data:
36+
- Obtain the EDS spectrum of each particle.
37+
- Obtain elemental maps of each particle.
38+
- Get the composition of each particle if k-factors or zeta-factors are supplied in the parameters object.
39+
40+
.. code-block:: python
41+
42+
>>> params = ps.parameters.load()
43+
>>> params.generate_eds(eds_method='CL',elements=['Pt','Au'],factors=[1.7,1.9],store_maps=False)
44+
>>> particles = ps.ParticleAnalysis(data, params)

0 commit comments

Comments
 (0)