Source code for pyvcad_attribute_resolver.modules.stratasys_radiomatrix

"""Stratasys RadioMatrix HU-to-volume-fractions conversion registrations."""

import pyvcad as pv

from pyvcad_attribute_resolver.registry import register_conversion

from .data import (
    MODE_RADIO_MATRIX_VERO,
    MODE_RADIO_MATRIX_VERO_TISSUE_MATRIX,
    MODE_VERO_TISSUE_MATRIX,
    SUPPORTED_MODES,
    SUPPORTED_KV,
    evaluate_stratasys_radiomatrix_fractions,
    hu_anchors,
    validate_kv,
    validate_mode,
)

OUT_OF_RANGE_HU_MARGIN = 1e-6


def _resolve_material_ids(
    material_defs,
    radio_matrix_material,
    vero_material,
    tissue_matrix_material,
):
    return (
        material_defs.id(radio_matrix_material),
        material_defs.id(vero_material),
        material_defs.id(tissue_matrix_material),
    )


def _converter_factory(
    kv,
    mode,
    radio_matrix_id,
    vero_id,
    tissue_matrix_id,
):
    mode = validate_mode(mode)
    anchors = hu_anchors(kv, mode)

    low_hu = (
        anchors["tissue_matrix"]
        if "tissue_matrix" in anchors
        else anchors["vero"]
    )
    high_hu = (
        anchors["radio_matrix"]
        if "radio_matrix" in anchors
        else anchors["vero"]
    )
    interior_hus = []
    if "tissue_matrix" in anchors and "radio_matrix" in anchors:
        interior_hus.append(anchors["vero"])

    def _volume_fraction_map(radio_fraction, vero_fraction, tissue_fraction):
        return {
            radio_matrix_id: radio_fraction,
            vero_id: vero_fraction,
            tissue_matrix_id: tissue_fraction,
        }

    def _lookup_entry(hu, is_valid=True, fractions=None):
        if fractions is None:
            fractions = evaluate_stratasys_radiomatrix_fractions(kv, hu, mode)
        entry = pv.LookupTableEntry(
            float(hu),
            _volume_fraction_map(*fractions),
        )
        entry.is_valid = is_valid
        return entry

    def _factory():
        low_fractions = evaluate_stratasys_radiomatrix_fractions(
            kv,
            low_hu,
            mode,
        )
        high_fractions = evaluate_stratasys_radiomatrix_fractions(
            kv,
            high_hu,
            mode,
        )
        entries = [
            _lookup_entry(
                low_hu - 2.0 * OUT_OF_RANGE_HU_MARGIN,
                is_valid=False,
            ),
            _lookup_entry(
                low_hu - OUT_OF_RANGE_HU_MARGIN,
                fractions=low_fractions,
            ),
            _lookup_entry(low_hu),
        ]
        for interior_hu in interior_hus:
            entries.append(_lookup_entry(interior_hu))
        entries.extend([
            _lookup_entry(high_hu),
            _lookup_entry(
                high_hu + OUT_OF_RANGE_HU_MARGIN,
                fractions=high_fractions,
            ),
            _lookup_entry(
                high_hu + 2.0 * OUT_OF_RANGE_HU_MARGIN,
                is_valid=False,
            ),
        ])

        return pv.LookupTableConverter(
            [pv.DefaultAttributes.HU],
            [pv.DefaultAttributes.VOLUME_FRACTIONS],
            entries,
            pv.InterpolationMode.LINEAR,
        )

    return _factory


[docs] def register_stratasys_radiomatrix_conversions( kv, material_defs=None, radio_matrix_material="RadioMatrix", vero_material="VeroBlack", tissue_matrix_material="TissueMatrix", mode=MODE_RADIO_MATRIX_VERO_TISSUE_MATRIX, ): """Register the Stratasys RadioMatrix HU-to-volume-fractions conversion. The selected ``kv`` value must be 100, 120, or 140. The selected ``mode`` controls whether both calibration curves are joined or only one calibration curve is used. By default this resolves material IDs from the bundled J750 material definitions and maps the RadioMatrix/Vero pair to ``RadioMatrix`` and ``VeroBlack``. Both material names can be overridden. Arguments: kv (int): CT tube voltage the scan was taken at: 100, 120 or 140. material_defs (MaterialDefs, optional): Material definitions to look the names up in. Defaults to ``pyvcad.j750_materials``. radio_matrix_material (str): Name of the RadioMatrix material. vero_material (str): Name of the Vero material. tissue_matrix_material (str): Name of the TissueMatrix material. mode (str): Which calibration curves to use: ``MODE_RADIO_MATRIX_VERO_TISSUE_MATRIX`` ("radio_matrix_vero_tissue_matrix", both joined), ``MODE_RADIO_MATRIX_VERO`` ("radio_matrix_vero") or ``MODE_VERO_TISSUE_MATRIX`` ("vero_tissue_matrix"). Raises: ValueError: If ``kv`` or ``mode`` is not supported. Example: >>> import pyvcad_attribute_resolver as par >>> par.register_stratasys_radiomatrix_conversions(120) """ kv = validate_kv(kv) mode = validate_mode(mode) if material_defs is None: material_defs = pv.j750_materials radio_matrix_id, vero_id, tissue_matrix_id = _resolve_material_ids( material_defs, radio_matrix_material, vero_material, tissue_matrix_material, ) register_conversion( source=pv.DefaultAttributes.HU, target=pv.DefaultAttributes.VOLUME_FRACTIONS, converter_factory=_converter_factory( kv, mode, radio_matrix_id, vero_id, tissue_matrix_id, ), name="stratasys_radiomatrix_hu_to_volume_fractions", priority=0, tags=[ "stratasys_radiomatrix", "stratasys_radiomatrix_{}kv".format(kv), "stratasys_radiomatrix_{}".format(mode), "material_inkjet", ], )
__all__ = [ "SUPPORTED_KV", "SUPPORTED_MODES", "OUT_OF_RANGE_HU_MARGIN", "MODE_RADIO_MATRIX_VERO_TISSUE_MATRIX", "MODE_RADIO_MATRIX_VERO", "MODE_VERO_TISSUE_MATRIX", "evaluate_stratasys_radiomatrix_fractions", "hu_anchors", "register_stratasys_radiomatrix_conversions", ]