podpac.coordinates.StackedCoordinates

class podpac.coordinates.StackedCoordinates(**kwargs: Any)[source]

Bases: BaseCoordinates

Stacked coordinates.

StackedCoordinates contain coordinates from two or more different dimensions that are stacked together to form a list of points (rather than a grid). The underlying coordinates values are Coordinates1d objects of equal size. The name for the stacked coordinates combines the underlying dimensions with underscores, e.g. 'lat_lon' or 'lat_lon_time'.

When creating Coordinates, podpac automatically detects StackedCoordinates. The following Coordinates contain 3 stacked lat-lon coordinates and 2 time coordinates in a 3 x 2 grid:

>>> lat = [0, 1, 2]
>>> lon = [10, 20, 30]
>>> time = ['2018-01-01', '2018-01-02']
>>> podpac.Coordinates([[lat, lon], time], dims=['lat_lon', 'time'])
Coordinates
    lat_lon[lat]: ArrayCoordinates1d(lat): Bounds[0.0, 2.0], N[3]
    lat_lon[lon]: ArrayCoordinates1d(lon): Bounds[10.0, 30.0], N[3]
    time: ArrayCoordinates1d(time): Bounds[2018-01-01, 2018-01-02], N[2]

For convenience, you can also create uniformly-spaced stacked coordinates using clinspace:

>>> lat_lon = podpac.clinspace((0, 10), (2, 30), 3)
>>> time = ['2018-01-01', '2018-01-02']
>>> podpac.Coordinates([lat_lon, time], dims=['lat_lon', 'time'])
Coordinates
    lat_lon[lat]: ArrayCoordinates1d(lat): Bounds[0.0, 2.0], N[3]
    lat_lon[lon]: ArrayCoordinates1d(lon): Bounds[10.0, 30.0], N[3]
    time: ArrayCoordinates1d(time): Bounds[2018-01-01, 2018-01-02], N[2]

Parameters:

dims (tuple) – Tuple of dimension names.
name (str) – Stacked dimension name.
coords (dict-like) – xarray coordinates (container of coordinate arrays)
coordinates (pandas.MultiIndex) – MultiIndex of stacked coordinates values.

Alternative Constructors

`from_definition`(d)	Create StackedCoordinates from a stacked coordinates definition.
`from_xarray`(x, **kwargs)	Create 1d Coordinates from named xarray coordinates.

Methods

`__init__`(coords[, name, dims])	Initialize a multidimensional coords bject.
`copy`()	Make a copy of the stacked coordinates.
`flatten`()
`get_area_bounds`(boundary)	Get coordinate area bounds, including boundary information, for each unstacked dimension.
`issubset`(other)	Report whether other coordinates contains these coordinates.
`reshape`(newshape)
`select`(bounds[, outer, return_index])	Get the coordinate values that are within the given bounds in all dimensions.
`simplify`()
`trait_defaults`(names, *metadata)	Return a trait's default value or a dictionary of them
`trait_has_value`(name)	Returns True if the specified trait has a value.
`trait_values`(**metadata)	A `dict` of trait names and their values.
`transpose`(dims, *kwargs)	Transpose (re-order) the dimensions of the StackedCoordinates.
`unique`([return_index])	Remove duplicate stacked coordinate values.

Attributes

`bounds`	Dictionary of (low, high) coordinates bounds in each dimension
`coordinates`
`definition`	Serializable stacked coordinates definition.
`dims`	Tuple of dimension names.
`full_definition`	Serializable stacked coordinates definition, containing all properties.
`is_affine`
`name`	Stacked dimension name.
`ndim`	coordinates array ndim.
`shape`	Shape of the stacked coordinates.
`size`	Number of stacked coordinates.
`udims`	Tuple of unstacked dimension names, for compatibility.
`xcoords`	xarray coordinates (container of coordinate arrays)
`xdims`	Tuple of indexing dimensions used to create xarray DataArray.

Members:

__init__(coords, name=None, dims=None)[source]

Initialize a multidimensional coords bject.

Parameters:: coords (list, StackedCoordinates) – Coordinate values in a list, or a StackedCoordinates object to copy.