Metadata structure

The EBSD and EBSDMasterPattern classes store metadata in the metadata attribute provided by HyperSpy. While kikuchipy’s EBSD (ebsd_metadata()) and EBSDMasterPattern (ebsd_master_pattern_metadata()) metadata structures are based on HyperSpy’s metadata structure, they each include a node Acquisition_instrument.Sample.Phases to store phase information, and Acquisition_instrument.SEM.Detector.EBSD or Simulation.EBSD_master_pattern, respectively. The information in these nodes are written, along with the patterns, to file when saving an EBSD object in the kikuchipy h5ebsd format or an EBSDMasterPattern object in the HyperSpy HDF5 format.

├── Acquisition_instrument
│   └── SEM
│       ├── Detector
│       │   └── EBSD
│       │       ├── azimuth_angle [º]
│       │       ├── binning
│       │       ├── detector
│       │       ├── elevation_angle [º]
│       │       ├── exposure_time [s]
│       │       ├── frame_number
│       │       ├── frame_rate [1/s]
│       │       ├── gain [dB]
│       │       ├── grid_type
│       │       ├── manufacturer
│       │       ├── sample_tilt [º]
│       │       ├── scan_time [s]
│       │       ├── static_background (numpy.ndarray)
│       │       ├── version
│       │       ├── xpc
│       │       ├── ypc
│       │       └── zpc
│       ├── beam_energy [kV]
│       ├── magnification
│       ├── microscope
│       └── working_distance [mm]
├── Sample
│   └── Phases
│       └── 1
│           ├── atom_coordinates
│           │   └── 1
│           │       ├── atom
│           │       ├── coordinates (x0, y0, z0)
│           │       ├── debye_waller_factor [nm^2]
│           │       └── site_occupation
│           ├── formula
│           ├── info
│           ├── lattice_constants (a, b, c and alfa, beta, gamma) [nm and º]
│           ├── laue_group
│           ├── material_name
│           ├── point_group
│           ├── setting
│           ├── source
│           ├── space_group
│           └── symmetry
└── Simulation
    └── EBSD_master_pattern
        ├── BSE_simulation
        │   ├── depth_step [nm]
        │   ├── energy_step [keV]
        │   ├── incident_beam_energy [keV]
        │   ├── max_depth [nm]
        │   ├── min_beam_energy [keV]
        │   ├── mode
        │   ├── number_of_electrons
        │   ├── pixels_along_x
        │   └── sample_tilt [º]
        └── Master_pattern
            ├── Bethe_parameters
            │   ├── complete_cutoff
            │   ├── strong_beam_cutoff
            │   └── weak_beam_cutoff
            ├── projection
            ├── hemisphere
            └── smallest_interplanar_spacing [nm]

The utility function metadata_nodes() returns the node strings for the SEM, EBSD and EBSD_master_pattern nodes for convenience.

Note

If you regularly use information relevant to EBSD data not included in the metadata structure, you can request this in our issue tracker.

EBSD

This node contains information relevant for EBSD data. All parameters can be set with the method set_experimental_parameters(). An explanation of each parameter is given in the method’s docstring.

EBSD master pattern

This node contains information relevant for simulated EBSD master patterns. All parameters can be set with the method set_simulation_parameters(). An explanation of each parameter is given in the method’s docstring.

Phases

This node contains information relevant for EBSD scans or simulated patterns’ phases. All parameters can be set with the EBSD method set_phase_parameters() or the EBSDMasterPattern method set_phase_parameters(). An explanation of each parameter is given in the methods’ docstring.