IntervalField

IntervalField(raw=None, unit=None, number_type=None, *, source_fields=None)

Semantic field storing intervals with shared axis metadata.

Parameters

Name	Type	Description	Default
raw	StructField | None	Struct field containing start and end coordinate structs.	None
unit	TimeUnit | str | None	Common endpoint unit.	None
number_type	NumberType | str | None	Common endpoint number type.	None
source_fields	str | dict[str, Any] | None	Optional blueprint source-field declaration.	None

Attributes

Name	Description
domain	Return the temporal domain implied by the unit.
duration	Return the vectorized duration field.
end	Return the vectorized end-coordinate field.
number_type	Return the common endpoint number type.
semantic_type	Return the paired scalar semantic type.
start	Return the vectorized start-coordinate field.
unit	Return the common endpoint unit.

Methods

Name	Description
from_field	Build an interval field from an Arrow or raw field source.
from_intervals	Build an interval field from scalar intervals.
metadata_dict	Return semantic type and shared axis metadata.

from_field

IntervalField.from_field(
    source,
    *,
    unit=None,
    number_type=None,
    name='interval',
)

Build an interval field from an Arrow or raw field source.

Parameters

Name	Type	Description	Default
source	pa.Array | pa.ChunkedArray | StructField | pa.Field | tuple[pa.Array | None, pa.Field]	Supported Arrow field representation.	required
unit	TimeUnit | str | None	Common endpoint unit override.	None
number_type	NumberType | str | None	Common endpoint number type override.	None
name	str	Field name for a bare array.	'interval'

Returns

Name	Type	Description
	IntervalField	A live or blueprint interval field.

from_intervals

IntervalField.from_intervals(
    intervals,
    *,
    unit=None,
    number_type=None,
    name='interval',
)

Build an interval field from scalar intervals.

Parameters

Name	Type	Description	Default
intervals	Sequence[Interval | None]	Interval values, optionally containing null rows.	required
unit	TimeUnit | str | None	Shared unit override, required for an empty/all-null input.	None
number_type	NumberType | str | None	Shared number type override, required for an empty/all-null input.	None
name	str	Arrow field name.	'interval'

Returns

Name	Type	Description
	IntervalField	A live interval field.

Raises

Name	Type	Description
	ValueError	If non-null intervals do not share one metadata triple.

metadata_dict

IntervalField.metadata_dict()

Return semantic type and shared axis metadata.