API 参考

注意（私有元素）

此模块包含以下划线开头的“私有”类/函数。默认情况下，它们的详细信息不会包含在文档中。

完整包

ISD 读取器包

此包解析 ISD 文件夹中的 Description.xml 文件，并将相应的二进制图像数据转换为具有相应数据类型（uint8/16/32）的 NumPy 二维数组。

此包包含： - 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 是一个 NumPy 二维数组。

`BinaryFileNotFound`

Bases: Exception

如果在 ISD 文件夹中找不到指定的二进制文件，则会发生异常。

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

class BinaryFileNotFound(Exception):
    """
    如果在 ISD 文件夹中找不到指定的二进制文件，则会发生异常。
    """
    pass

`DescriptionNotFound`

Bases: Exception

如果在 ISD 文件夹中找不到 Description.xml 文件，则会发生异常。

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

class DescriptionNotFound(Exception):
    """
    如果在 ISD 文件夹中找不到 Description.xml 文件，则会发生异常。
    """
    pass

`InvalidChannel`

Bases: Exception

当指定的通道索引无效时，会发生异常。

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

class InvalidChannel(Exception):
    """
    当指定的通道索引无效时，会发生异常。
    """
    pass

`InvalidDataGate`

Bases: Exception

当指定的数据门索引无效时，会发生异常。

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

class InvalidDataGate(Exception):
    """
    当指定的数据门索引无效时，会发生异常。
    """
    pass

`IsdNotFound`

Bases: Exception

当指定的 ISD 文件夹不存在时，会发生异常。

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

class IsdNotFound(Exception):
    """
    当指定的 ISD 文件夹不存在时，会发生异常。
    """
    pass

`IsdReader`

代表整个 ISD 文件夹的根类此类是访问 ISD 采集数据集中所有通道、数据门和图像的主要入口点。换句话说，它是一个包含整个 ISD 数据的对象类。属性： path：要包含的 ISD 文件夹的路径 description_path：Description.xml 文件的路径（位于 ISD 文件夹下） logger：此对象的日志记录器实例

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

class IsdReader:
    """
    代表整个 ISD 文件夹的根类
    此类是访问 ISD 采集数据集中所有通道、数据门和图像的主要入口点。
    换句话说，它是一个包含整个 ISD 数据的对象类。
    属性：
      path：要包含的 ISD 文件夹的路径
      description_path：Description.xml 文件的路径（位于 ISD 文件夹下）
      logger：此对象的日志记录器实例
    """
# --------------------------------------------------------------------------------------------------------
    def __init__(self, *, isd_path: Union[str, Path], logger: Optional[logging.Logger] = None) -> None:
        """
        根据 ISD 文件夹参数初始化 IsdReader 对象。
        参数：
          isd_path：ISD 文件夹的路径（字符串或 pathlib.Path）。
          logger：可选的日志记录器实例。如果为 None，则使用默认日志记录器。
        异常：
          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 的字符串摘要。
        返回值：
          包含大小和可用通道数的字符串。
        """
        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 实例或列出所有频道。
        参数：
          ch：None 或指定的 ChChunk 编号
        返回值：
          如果 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 的方法
        参数：
          ch：通道号（1 为起始值）
          gate：数据门编号（1 为起始值）
          image_type：图像类型（缩写或全称）
          slice_no：切片编号（1 为起始值，默认值：1）
        返回值：
          找到符合指定条件的 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 实例或列出所有频道。参数： ch：None 或指定的 ChChunk 编号返回值：如果 ch 为 None，则返回可用频道编号列表；否则，返回指定的 ChChunk 或 None。

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

def GetCh(self, ch: Optional[int] = None):
    """
    获取 ChChunk 实例或列出所有频道。
    参数：
      ch：None 或指定的 ChChunk 编号
    返回值：
      如果 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 的方法参数： ch：通道号（1 为起始值） gate：数据门编号（1 为起始值） image_type：图像类型（缩写或全称） slice_no：切片编号（1 为起始值，默认值：1）返回值：找到符合指定条件的 ImageChunk 实例；否则，返回 None

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

def GetImage(self, *, ch: int, gate: int, image_type: str, slice_no: Optional[int] = 1) -> Optional[ImageChunk]:
    """
    直接检索 ImageChunk 的方法
    参数：
      ch：通道号（1 为起始值）
      gate：数据门编号（1 为起始值）
      image_type：图像类型（缩写或全称）
      slice_no：切片编号（1 为起始值，默认值：1）
    返回值：
      找到符合指定条件的 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 对象。参数： isd_path：ISD 文件夹的路径（字符串或 pathlib.Path）。 logger：可选的日志记录器实例。如果为 None，则使用默认日志记录器。异常： TypeError：如果 isd_path 不是字符串或 Path 类型。 IsdNotFound：如果 ISD 文件夹不存在。 DescriptionNotFound：如果在 ISD 文件夹中找不到 Description.xml 文件。

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

def __init__(self, *, isd_path: Union[str, Path], logger: Optional[logging.Logger] = None) -> None:
    """
    根据 ISD 文件夹参数初始化 IsdReader 对象。
    参数：
      isd_path：ISD 文件夹的路径（字符串或 pathlib.Path）。
      logger：可选的日志记录器实例。如果为 None，则使用默认日志记录器。
    异常：
      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 的字符串摘要。返回值：包含大小和可用通道数的字符串。

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

def __repr__(self) -> str:
    """
    此函数返回 IsdReader 的字符串摘要。
    返回值：
      包含大小和可用通道数的字符串。
    """
    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)}]"