"""Dataclass helpers for 3D IMAGE / RVE feature bookkeeping."""
import numpy as np
from dataclasses import dataclass, field
from scipy.ndimage import generate_binary_structure
[docs]
@dataclass(frozen=False)
class part_cntr_CLS:
"""Partitioning controls: connectivity and binary structuring element."""
connectivity: int
bstruct: any = field(init=False)
def __post_init__(self):
"""Generate the binary structuring element from ``connectivity``."""
self.bstruct = generate_binary_structure(3, self.connectivity)
[docs]
@dataclass(frozen=False)
class ids_counts_CLS:
"""Guidance to set-up the feature names.
<<< Please restrict featuire names to only from below options:
grain, subgrain,ptwin i.e. primary twin, stwin i.e.
secondary twin, pag for prior austenitic grain, pck for packets in
Martensitic steels (FMS), blk for blocks in FMS, sblk for sub
blocks in FMS, l for laths in FMS >>>
"""
f: str # feature name
"""Cells (C)"""
c: np.array = field(init=False) # C IDs. np.array of np.int32
n_c: int = field(init=False) # C count
v_c: dict = field(init=False) # C vox IDs. @ c
nv_c: dict = field(init=False) # C voxel count. @ c
"""Cell boundaries: CB"""
cb: np.array = field(init=False) # CB IDs. np.array of np.int32
n_cb: int = field(init=False) # CB count.
v_cb: dict = field(init=False) # CB vox IDs. @c: np.array of np.int32
nv_cb: dict = field(init=False) # CB vox count. @c: int
"""CB segments (CBS)"""
cbs: dict = field(init=False) # CBS IDs. @c: list of int
n_cbs: dict = field(init=False) # CBS count. @c: list of int
v_cbs: dict = field(init=False) # CBS vox IDs. @c: np.array of np.int32
nv_cbs: dict = field(init=False) # CBS vox count. @c: list of int
"""CBS edges (CBSE)"""
cbse: dict = field(init=False) # CBSE IDs. @c: list of int
n_cbse: dict = field(init=False) # CBSE count. @c: list of int
v_cbse: dict = field(init=False) # CBSE vox IDs. @c: np.array of np.int32
nv_cbse: dict = field(init=False) # CBSE vox count. @c: list of int
"""CBSE points (CBSEP)"""
cbsep: dict = field(init=False) # CBSEP IDs. @c: list of int
n_cbsep: dict = field(init=False) # CBSEP count. @c
v_cbsep: dict = field(init=False) # CBSEP vox IDs. @c: np.array of np.int32
nv_cbsep: dict = field(init=False) # CBSEP vox count. @c: list of int
"""CBSE inflection vert (CBSEV)"""
cbsev: dict = field(init=False) # CBSEV IDs. @c: list of int
n_cbsev: dict = field(init=False) # CBSEV count. @c - int
v_cbsev: dict = field(init=False) # CBSEV vox IDs. @c: np.array of np.int32
nv_cbsev: dict = field(init=False) # CBSEV vox count. @c: list if int
"""CBSE junc. pnts (CBSEJ)"""
cbsej: dict = field(init=False) # CBSEJ IDs. @c - list of int
n_cbsej: dict = field(init=False) # CBSEJ count. @c - list of int
v_cbsej: dict = field(init=False) # CBSEJ vox IDs. @c: np.array of np.int32
nv_cbsej: dict = field(init=False) # CBSEJ vox count. @c: list of int
[docs]
@dataclass(frozen=False)
class ids_CLS:
"""
Feature ID stores for voxels, cells, and GB hierarchy (global numbering).
Holds global CBS / edge / junction-point ID arrays used with
:class:`ids_counts_CLS` hierarchical counts.
"""
v: np.array = field(init=False) # Voxel IDs
# Cell IDs
# Cell boundary (CB) IDs
# CB segment IDs, local @ cid
# CBS edge IDs, local @ cid
# CBSE Junc pnt IDs, lcl @ cid
cbsG: np.array = field(init=False) # CB segment IDs, global numbering
cbseG: np.array = field(init=False) # CBS edge IDs, global numbering
cbsejG: np.array = field(init=False) # CBSE Junc pnt IDs, glb nmbrng
def __repr__(self):
"""Return a compact ID-object summary string."""
return f"UPXO.IMG.3D - IDs object. {id(self)}"
[docs]
@dataclass(frozen=False)
class vox_CLS:
"""
Single-voxel geometry for an RVE (edge length ``l`` in micrometres).
``vol`` is ``l³`` in cubic micrometres.
"""
l: float
@property
def vol(self) -> float:
"""Voxel volume (``l³``) in cubic micrometres."""
return self.l**3
[docs]
@dataclass(frozen=False)
class rve_CLS:
"""
Rectangular voxel RVE: ``nx``×``ny``×``nz`` and attached :class:`vox_CLS`.
After init, ``n`` is total voxels and ``vol`` is physical domain volume.
"""
nx: int
ny: int
nz: int
vox: any
n: int = field(init=False)
vol: float = field(init=False)
def __post_init__(self):
"""Compute ``n`` (total voxel count) and ``vol`` (domain volume) after dataclass init."""
self.n = self.get_n()
self.vol = self.set_vol()
[docs]
def set_n(self) -> float:
"""Return total number of voxels (``nx * ny * nz``)."""
return self.nx*self.ny*self.nz
[docs]
def set_vol(self) -> float:
"""Return total domain volume in cubic micrometres."""
return self.n*(self.vox.l**3)