API Reference

注意（プライベート要素）

このモジュールには先頭にアンダースコアを含む「プライベート」なクラス/関数が存在します。既定ではそれらの詳細はドキュメントから除外されます。

パッケージ全体

ISD Readerパッケージ

ISDフォルダ内のDescription.xmlファイルを解析/対応するバイナリ画像データを適切なdtype（uint8/16/32）でNumPy2次元配列としてアクセス可能とする

このパッケージには以下が含まれる

IsdReader: ISDデータセットを読み込むためのメインエントリポイント、すなわちISDデータそのものを包括するオブジェクトクラス
各種エラー発生時の例外クラス

使用例

from isdreader import IsdReader isd = IsdReader(isd_path="/path/to/folder.isd") ch = isd.GetCh(1) dg = ch.GetDataGate(2) img = dg.GetImage("AP") arr = img.load_image()

ここでarrがNumPy2次元配列である

`BinaryFileNotFound`

Bases: Exception

ISDフォルダ内に指定されたバイナリファイルが見つからない場合に発生する例外

Source code in .build\ja\isdreader\isd_helper.py

class BinaryFileNotFound(Exception):
    """
    ISDフォルダ内に指定されたバイナリファイルが見つからない場合に発生する例外
    """
    pass

`DescriptionNotFound`

Bases: Exception

ISDフォルダ内にDescription.xmlが見つからない場合に発生する例外

Source code in .build\ja\isdreader\isd_helper.py

class DescriptionNotFound(Exception):
    """
    ISDフォルダ内にDescription.xmlが見つからない場合に発生する例外
    """
    pass

`InvalidChannel`

Bases: Exception

指定されたチャンネルインデックスが無効な場合に発生する例外

Source code in .build\ja\isdreader\isd_helper.py

class InvalidChannel(Exception):
    """
    指定されたチャンネルインデックスが無効な場合に発生する例外
    """
    pass

`InvalidDataGate`

Bases: Exception

指定されたデータゲートインデックスが無効な場合に発生する例外

Source code in .build\ja\isdreader\isd_helper.py

class InvalidDataGate(Exception):
    """
    指定されたデータゲートインデックスが無効な場合に発生する例外
    """
    pass

`IsdNotFound`

Bases: Exception

指定されたISDフォルダが存在しない場合に発生する例外

Source code in .build\ja\isdreader\isd_helper.py

class IsdNotFound(Exception):
    """
    指定されたISDフォルダが存在しない場合に発生する例外
    """
    pass

`IsdReader`

ISDフォルダ全体を現すルートクラスこのクラスはISD取得データセット内の全チャンネル、DataGate、および画像アクセスのメインエントリポイントであるすなわち、ISDデータ全体を包括するオブジェクトクラスとなる Attributes: path: 包括すべきISDフォルダへのパス description_path: Description.xmlファイルへのパス(ISD直下に固定) logger: このオブジェクト用のロガーインスタンス

Source code in .build\ja\isdreader\isd_root.py

class IsdReader:
    """
    ISDフォルダ全体を現すルートクラス
    このクラスはISD取得データセット内の全チャンネル、DataGate、および画像アクセス
    のメインエントリポイントである
    すなわち、ISDデータ全体を包括するオブジェクトクラスとなる
    Attributes:
      path: 包括すべきISDフォルダへのパス
      description_path: Description.xmlファイルへのパス(ISD直下に固定)
      logger: このオブジェクト用のロガーインスタンス
    """
# --------------------------------------------------------------------------------------------------------
    def __init__(self, *, isd_path: Union[str, Path], logger: Optional[logging.Logger] = None) -> None:
        """
        引数ISDフォルダからIsdReaderオブジェクトを初期化する
        Args:
          isd_path: ISDフォルダへのパス（文字列またはpathlib.Path）。
          logger: オプションのロガーインスタンス。Noneの場合はデフォルトロガー
        Raises:
          TypeError: isd_pathが文字列またはPathでない場合
          IsdNotFound: ISDフォルダが存在しない場合
          DescriptionNotFound: ISDフォルダ内にDescription.xmlが見つからない場合
        """
        if not isinstance(isd_path, (str, Path)):
            raise TypeError("isd_path must be str or pathlib.Path")

        self.path = Path(isd_path)
        if not self.path.exists() or not self.path.is_dir():
            raise IsdNotFound(f"ISD folder not found: {isd_path}")

        self.description_path = self.path / "Description.xml"
        if not self.description_path.exists():
            raise DescriptionNotFound(f"Description.xml not found in: {self.path}")

        tree = etree.parse(self.description_path)
        root = tree.getroot()
        isd_root = Path(self.description_path).parent

        self._scan_type = root.findtext("Info/ScanType")
        self._width_pixel = int(root.findtext("Info/WidthPixel") or 0)
        self._height_pixel = int(root.findtext("Info/HeightPixel") or 0)

        wp = root.find("Info/WidthPhysical")
        if wp is not None:
            try:
                self._width_physical = float(wp.text.strip())
            except Exception:
                self._width_physical = None
            self._width_physical_unit = wp.get("Unit")
        else:
            self._width_physical = None
            self._width_physical_unit = None

        hp = root.find("Info/HeightPhysical")
        if hp is not None:
            try:
                self._height_physical = float(hp.text.strip())
            except Exception:
                self._height_physical = None
            self._height_physical_unit = hp.get("Unit")
        else:
            self._height_physical = None
            self._height_physical_unit = None

        self._channels: List[ChChunk] = []
        for ch_elem in root.findall("Channel"):
            self._channels.append(ChChunk(root, ch_elem, isd_root, self._width_pixel or 0, self._height_pixel or 0))

        self._root_elem = root

        self.logger = logger or logging.getLogger(__name__)
# --------------------------------------------------------------------------------------------------------
    def __repr__(self) -> str:
        """
        このIsdReaderの文字列による概要を返す
        Returns:
          サイズと利用可能なチャンネルを含む文字列
        """
        parts: List[str] = []
        if self._width_pixel is not None and self._height_pixel is not None:
            parts.append(f"size={self._width_pixel}x{self._height_pixel}")
        chs = self.GetCh()
        if chs:
            parts.append(f"channels={','.join(str(int(c)) for c in chs)}")
        return f"IsdReader[{', '.join(parts)}]"
# --------------------------------------------------------------------------------------------------------
    def GetCh(self, ch: Optional[int] = None):
        """
        ChChunkインスタンスを取得、または全チャンネルをリストアップする
        Args:
          ch: None、或いは指定のChChunk番号
        Returns:
          chがNoneの場合は利用可能なチャンネル番号のリストアップ、それ以外の場合は指定のChChunkまたはNone
        """
        if ch is None:
            return [c._ch for c in self._channels if c._ch is not None]
        for c in self._channels:
            if c._ch == int(ch):
                return c
        return None
# --------------------------------------------------------------------------------------------------------
    def GetImage(self, *, ch: int, gate: int, image_type: str, slice_no: Optional[int] = 1) -> Optional[ImageChunk]:
        """
        ImageChunkを直接取得するメソッド
        Args:
          ch: チャンネル番号（1オリジン）
          gate: DataGate番号（1オリジン）
          image_type: 画像タイプ（省略形、フルネーム）
          slice_no: スライス番号（1オリジン、デフォルト: 1）
        Returns:
          指定された条件で見つかったImageChunkインスタンス、それ以外の場合はNone
        """
        chObj = self.GetCh(ch)
        if chObj is None:
            return None
        gateObj = chObj.GetDataGate(gate)
        if gateObj is None:
            return None
        imgObj = gateObj.GetImage(image_type, slice_no)
        return imgObj

`GetCh(ch=None)`

ChChunkインスタンスを取得、または全チャンネルをリストアップする Args: ch: None、或いは指定のChChunk番号 Returns: chがNoneの場合は利用可能なチャンネル番号のリストアップ、それ以外の場合は指定のChChunkまたはNone

Source code in .build\ja\isdreader\isd_root.py

def GetCh(self, ch: Optional[int] = None):
    """
    ChChunkインスタンスを取得、または全チャンネルをリストアップする
    Args:
      ch: None、或いは指定のChChunk番号
    Returns:
      chがNoneの場合は利用可能なチャンネル番号のリストアップ、それ以外の場合は指定のChChunkまたはNone
    """
    if ch is None:
        return [c._ch for c in self._channels if c._ch is not None]
    for c in self._channels:
        if c._ch == int(ch):
            return c
    return None

`GetImage(*, ch, gate, image_type, slice_no=1)`

ImageChunkを直接取得するメソッド Args: ch: チャンネル番号（1オリジン） gate: DataGate番号（1オリジン） image_type: 画像タイプ（省略形、フルネーム） slice_no: スライス番号（1オリジン、デフォルト: 1） Returns: 指定された条件で見つかったImageChunkインスタンス、それ以外の場合はNone

Source code in .build\ja\isdreader\isd_root.py

def GetImage(self, *, ch: int, gate: int, image_type: str, slice_no: Optional[int] = 1) -> Optional[ImageChunk]:
    """
    ImageChunkを直接取得するメソッド
    Args:
      ch: チャンネル番号（1オリジン）
      gate: DataGate番号（1オリジン）
      image_type: 画像タイプ（省略形、フルネーム）
      slice_no: スライス番号（1オリジン、デフォルト: 1）
    Returns:
      指定された条件で見つかったImageChunkインスタンス、それ以外の場合はNone
    """
    chObj = self.GetCh(ch)
    if chObj is None:
        return None
    gateObj = chObj.GetDataGate(gate)
    if gateObj is None:
        return None
    imgObj = gateObj.GetImage(image_type, slice_no)
    return imgObj

`init(*, isd_path, logger=None)`

引数ISDフォルダからIsdReaderオブジェクトを初期化する Args: isd_path: ISDフォルダへのパス（文字列またはpathlib.Path）。 logger: オプションのロガーインスタンス。Noneの場合はデフォルトロガー Raises: TypeError: isd_pathが文字列またはPathでない場合 IsdNotFound: ISDフォルダが存在しない場合 DescriptionNotFound: ISDフォルダ内にDescription.xmlが見つからない場合

Source code in .build\ja\isdreader\isd_root.py

def __init__(self, *, isd_path: Union[str, Path], logger: Optional[logging.Logger] = None) -> None:
    """
    引数ISDフォルダからIsdReaderオブジェクトを初期化する
    Args:
      isd_path: ISDフォルダへのパス（文字列またはpathlib.Path）。
      logger: オプションのロガーインスタンス。Noneの場合はデフォルトロガー
    Raises:
      TypeError: isd_pathが文字列またはPathでない場合
      IsdNotFound: ISDフォルダが存在しない場合
      DescriptionNotFound: ISDフォルダ内にDescription.xmlが見つからない場合
    """
    if not isinstance(isd_path, (str, Path)):
        raise TypeError("isd_path must be str or pathlib.Path")

    self.path = Path(isd_path)
    if not self.path.exists() or not self.path.is_dir():
        raise IsdNotFound(f"ISD folder not found: {isd_path}")

    self.description_path = self.path / "Description.xml"
    if not self.description_path.exists():
        raise DescriptionNotFound(f"Description.xml not found in: {self.path}")

    tree = etree.parse(self.description_path)
    root = tree.getroot()
    isd_root = Path(self.description_path).parent

    self._scan_type = root.findtext("Info/ScanType")
    self._width_pixel = int(root.findtext("Info/WidthPixel") or 0)
    self._height_pixel = int(root.findtext("Info/HeightPixel") or 0)

    wp = root.find("Info/WidthPhysical")
    if wp is not None:
        try:
            self._width_physical = float(wp.text.strip())
        except Exception:
            self._width_physical = None
        self._width_physical_unit = wp.get("Unit")
    else:
        self._width_physical = None
        self._width_physical_unit = None

    hp = root.find("Info/HeightPhysical")
    if hp is not None:
        try:
            self._height_physical = float(hp.text.strip())
        except Exception:
            self._height_physical = None
        self._height_physical_unit = hp.get("Unit")
    else:
        self._height_physical = None
        self._height_physical_unit = None

    self._channels: List[ChChunk] = []
    for ch_elem in root.findall("Channel"):
        self._channels.append(ChChunk(root, ch_elem, isd_root, self._width_pixel or 0, self._height_pixel or 0))

    self._root_elem = root

    self.logger = logger or logging.getLogger(__name__)

`repr()`

このIsdReaderの文字列による概要を返す Returns: サイズと利用可能なチャンネルを含む文字列

Source code in .build\ja\isdreader\isd_root.py

def __repr__(self) -> str:
    """
    このIsdReaderの文字列による概要を返す
    Returns:
      サイズと利用可能なチャンネルを含む文字列
    """
    parts: List[str] = []
    if self._width_pixel is not None and self._height_pixel is not None:
        parts.append(f"size={self._width_pixel}x{self._height_pixel}")
    chs = self.GetCh()
    if chs:
        parts.append(f"channels={','.join(str(int(c)) for c in chs)}")
    return f"IsdReader[{', '.join(parts)}]"