Component

class glue.core.component.Component(data, units=None)[source]

Bases: object

Stores the actual, numerical information for a particular quantity

Data objects hold one or more components, accessed via ComponentIDs. All Components in a data set must have the same shape and number of dimensions

Parameters:
datandarray

The data to store.

unitsstr, optional

Unit label.

Notes

Instead of instantiating Components directly, consider using Component.autotyped(), which chooses a subclass most appropriate for the data type.

Attributes Summary

categorical

Whether or not the datatype is categorical.

data

The underlying ndarray

datetime

Whether or not or not the datatype is a date/time

ndim

The number of dimensions

numeric

Whether or not the datatype is numeric.

shape

Tuple of array dimensions

units

Methods Summary

autotyped(data[, units])

Automatically choose between Component and CategoricalComponent, based on the input data type.

jitter([method])

to_series(**kwargs)

Convert into a pandas.Series object.

Attributes Documentation

categorical[source]

Whether or not the datatype is categorical.

data[source]

The underlying ndarray

datetime[source]

Whether or not or not the datatype is a date/time

ndim[source]

The number of dimensions

numeric[source]

Whether or not the datatype is numeric.

shape[source]

Tuple of array dimensions

units[source]

Methods Documentation

classmethod autotyped(data, units=None)[source]

Automatically choose between Component and CategoricalComponent, based on the input data type.

Parameters:
dataarray-like

The data to pack into a Component.

unitsstr, optional

Unit description.

Returns:
Component (or subclass)
jitter(method=None)[source]
to_series(**kwargs)[source]

Convert into a pandas.Series object.

Parameters:
**kwargs

All kwargs are passed to the Series constructor.

Returns
——-
:class:`pandas.Series`