podpac.compositor.OrderedCompositor

class podpac.compositor.OrderedCompositor(**kwargs)[source]

Bases: podpac.core.compositor.compositor.BaseCompositor

Compositor that combines sources based on their order in self.sources.

The requested data is interpolated by the sources before being composited.

sources

Source nodes, in order of preference. Later sources are only used where earlier sources do not provide data.

Type

list

source_coordinates

Coordinates that make each source unique. Must the same size as sources and single-dimensional. Optional.

Type

podpac.Coordinates

interpolation

Interpolation definition for the data source. By default, the interpolation method is set to 'nearest' for all dimensions.

Type

str, dict, optional

Alternative Constructors

from_definition(definition)

Create podpac Node from a dictionary definition.

from_json(s)

Create podpac Node from a JSON definition.

Methods

__init__(**kwargs)

Do not overwrite me

composite(coordinates, data_arrays[, result])

Composites data_arrays in order that they appear.

create_output_array(coords[, data])

Initialize an output data array

eval(coordinates[, output])

Evaluates this nodes using the supplied coordinates.

eval_group(group)

Evaluate the node for each of the coordinates in the group.

find_coordinates()

Get the available coordinates for the Node.

from_url(url)

Create podpac Node from a WMS/WCS request.

get_cache(key[, coordinates])

Get cached data for this node.

has_cache(key[, coordinates])

Check for cached data for this node.

init()

Overwrite this method if a node needs to do any additional initialization after the standard initialization.

iteroutputs(coordinates)

Summary

load(path)

Create podpac Node from file.

put_cache(data, key[, coordinates, overwrite])

Cache data for this node.

rem_cache(key[, coordinates, mode])

Clear cached data for this node.

save(path)

Write node to file.

select_sources(coordinates)

Select and prepare sources based on requested coordinates.

trait_is_defined(name)

Attributes

attrs

List of node attributes

auto_outputs

A boolean (True, False) trait.

base_ref

Default reference/name in node definitions

cache_ctrl

A trait whose value must be an instance of a specified class.

cache_output

A boolean (True, False) trait.

definition

dims

An instance of a Python list.

dtype

A trait which allows any value.

force_eval

A boolean (True, False) trait.

hash

interpolation

json

json_pretty

output

A trait for unicode strings.

outputs

An instance of a Python list.

source_coordinates

A trait whose value must be an instance of a specified class.

sources

An instance of a Python list.

style

A trait whose value must be an instance of a specified class.

units

A trait for unicode strings.

Members

__init__(**kwargs)

Do not overwrite me

composite(coordinates, data_arrays, result=None)[source]

Composites data_arrays in order that they appear. Once a request contains no nans, the result is returned.

Parameters
  • coordinates (podpac.Coordinates) – The set of coordinates requested by a user. The Node will be evaluated using these coordinates.

  • data_arrays (generator) – Evaluated source data, in the same order as the sources.

  • result (podpac.UnitsDataArray, optional) – Default is None. Optional input array used to store the output data. When supplied, the node will not allocate its own memory for the output array. This array needs to have the correct dimensions, coordinates, and coordinate reference system.

Returns

Unit-aware xarray DataArray containing the results of the node evaluation. This composites the sources together until there are no nans or no more sources.

Return type

podpac.UnitsDataArray