gblearn.reduce¶
Once the unique LAEs for a grain boundary collection have been calculated using SOAP and the similarity metric, we can generate the local environment representation by accumulating the fraction of each unique LAE within a given GB.
Functions
accumulate (gbc, U) |
Accumulates the total number of occurances of each type of LAE in the whole GB system. |
API Documentation¶
Once the unique LAEs for a grain boundary collection have been calculated using SOAP and the similarity metric, we can generate the local environment representation by accumulating the fraction of each unique LAE within a given GB.
-
gblearn.reduce.
accumulate
(gbc, U)[source] Accumulates the total number of occurances of each type of LAE in the whole GB system.
Parameters: - gbc (GrainBoundaryCollection) – to accumulate LAE presence across.
- U (OrderedDict) – collection of globally unique LAEs.
Returns: with (PID, EID) keys and values a list of all the other (PID, EID) LAE indices in the entire system.
Return type: