RegionArrowScalar

final class lsst.daf.butler.arrow_utils.RegionArrowScalar

Bases: ExtensionScalar

An Arrow scalar type for lsst.sphgeom.Region.

Use the standard as_py method to convert to an actual region.

Attributes Summary

is_valid	Holds a valid (non-null) value.
type	Data type of the Scalar object.
value	Return storage value as a scalar.

Methods Summary

as_py(self)	Return this scalar as a Python object.
cast(self[, target_type, safe, options, ...])	Cast scalar value to another data type.
equals(self, Scalar other)	Parameters:
from_storage(BaseExtensionType typ, value)	Construct ExtensionScalar from type and storage value.
validate(self, *[, full])	Perform validation checks.

Attributes Documentation

is_valid

Holds a valid (non-null) value.

type

Data type of the Scalar object.

value

Return storage value as a scalar.

Methods Documentation

as_py(self)

Return this scalar as a Python object.

cast(self, target_type=None, safe=None, options=None, memory_pool=None)

Cast scalar value to another data type.

See pyarrow.compute.cast() for usage.

Parameters:

target_typeDataType, default None

Type to cast scalar to.

safeboolean, default True

Whether to check for conversion errors such as overflow.

optionsCastOptions, default None

Additional checks pass by CastOptions

memory_poolMemoryPool, optional

memory pool to use for allocations during function execution.

Returns:

scalarA Scalar of the given target data type.

equals(self, Scalar other)

Parameters:

otherpyarrow.Scalar

Returns:

bool

static from_storage(BaseExtensionType typ, value)

Construct ExtensionScalar from type and storage value.

Parameters:

typDataType

The extension type for the result scalar.

valueobject

The storage value for the result scalar.

Returns:

ext_scalarExtensionScalar

validate(self, *, full=False)

Perform validation checks. An exception is raised if validation fails.

By default only cheap validation checks are run. Pass full=True for thorough validation checks (potentially O(n)).

Parameters:

fullbool, default False

If True, run expensive checks, otherwise cheap checks only.

Raises:

ArrowInvalid