Source code for geoh5py.objects.label

#  Copyright (c) 2024 Mira Geoscience Ltd.
#  This file is part of geoh5py.
#  geoh5py is free software: you can redistribute it and/or modify
#  it under the terms of the GNU Lesser General Public License as published by
#  the Free Software Foundation, either version 3 of the License, or
#  (at your option) any later version.
#  geoh5py is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  GNU Lesser General Public License for more details.
#  You should have received a copy of the GNU Lesser General Public License
#  along with geoh5py.  If not, see <>.

from __future__ import annotations

import uuid
import warnings
from typing import TYPE_CHECKING

from .object_base import ObjectBase, ObjectType

    from numpy import ndarray

[docs] class Label(ObjectBase): """ Label object for annotation in viewport. .. warning:: Not yet implemented. """ __TYPE_UID = uuid.UUID( fields=(0xE79F449D, 0x74E3, 0x4598, 0x9C, 0x9C, 0x351A28B8B69E) ) def __init__(self, object_type: ObjectType, **kwargs): # TODO self.target_position = None self.label_position = None super().__init__(object_type, **kwargs)
[docs] @classmethod def default_type_uid(cls) -> uuid.UUID: return cls.__TYPE_UID
[docs] def copy( self, parent=None, copy_children: bool = True, clear_cache: bool = False, mask: ndarray | None = None, **kwargs, ): """ Function to copy an entity to a different parent entity. :param parent: Target parent to copy the entity under. Copied to current :obj:`~geoh5py.shared.entity.Entity.parent` if None. :param copy_children: (Optional) Create copies of all children entities along with it. :param clear_cache: Clear array attributes after copy. :param mask: (Optional) Indices of vertices to copy. :param kwargs: Additional keyword arguments. :return: New copy of the input entity. """ if mask is not None: warnings.warn("Masking is not supported for Label objects.") new_entity = super().copy( parent=parent, copy_children=copy_children, clear_cache=clear_cache, **kwargs, ) return new_entity
@property def extent(self): """ Geography bounding box of the object. """ return None
[docs] def mask_by_extent(self, extent: ndarray, inverse: bool = False) -> None: """ Sub-class extension of :func:`~geoh5py.shared.entity.Entity.mask_by_extent`. """ return None