pixano.core.gt_info

GtInfo(bbox_obj, bbox_visib, px_count_all, px_count_valid, px_count_visib, visib_fract)

Bases: PixanoType, BaseModel

GtInfo type

Attributes:

Name	Type	Description
bbox_obj	BBox	bbox_obj
bbox_visib	BBox	bbox_visib
px_count_all	int	px_count_all
px_count_valid	int	px_count_valid
px_count_visib	int	px_count_visib
visib_fract	float	visib_fract

Parameters:

Name	Type	Description	Default
bbox_obj	BBox	bbox_obj	required
bbox_visib	BBox	bbox_visib	required
px_count_all	int	px_count_all	required
px_count_valid	int	px_count_valid	required
px_count_visib	int	px_count_visib	required
visib_fract	float	visib_fract	required

Source code in pixano/core/gt_info.py

def __init__(
    self,
    bbox_obj: BBox,
    bbox_visib: BBox,
    px_count_all: int,
    px_count_valid: int,
    px_count_visib: int,
    visib_fract: float,
):
    """Initialize GtInfo

    Args:
        bbox_obj (BBox): bbox_obj
        bbox_visib (BBox): bbox_visib
        px_count_all (int): px_count_all
        px_count_valid (int): px_count_valid
        px_count_visib (int): px_count_visib
        visib_fract (float): visib_fract
    """

    # Define public attributes through Pydantic BaseModel
    super().__init__(
        bbox_obj=bbox_obj,
        bbox_visib=bbox_visib,
        px_count_all=px_count_all,
        px_count_valid=px_count_valid,
        px_count_visib=px_count_visib,
        visib_fract=visib_fract,
    )

to_struct() staticmethod

Return GtInfo type as PyArrow Struct

Returns:

Type	Description
StructType	Custom type corresponding PyArrow Struct

Source code in pixano/core/gt_info.py

@staticmethod
def to_struct() -> pa.StructType:
    """Return GtInfo type as PyArrow Struct

    Returns:
        pa.StructType: Custom type corresponding PyArrow Struct
    """

    return pa.struct(
        [
            pa.field("bbox_obj", BBoxType),
            pa.field("bbox_visib", BBoxType),
            pa.field("px_count_all", pa.int64()),
            pa.field("px_count_valid", pa.int64()),
            pa.field("px_count_visib", pa.int64()),
            pa.field("visib_fract", pa.float64()),
        ]
    )