podpac.compositor.OrderedCompositor

class podpac.compositor.OrderedCompositor(**kwargs: Any)

Bases: BaseCompositor

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

The sources should generally be interpolated before being composited (i.e. not raw datasources).

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

multithreading

Default is True. If True, will always evaluate the compositor in serial, ignoring any MULTITHREADING settings

Type:

bool, 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, attrs, ...])	Initialize an output data array
eval(coordinates, **kwargs)	Wraps the super Node.eval method in order to cache with the correct 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_name_params(name[, params])	Create podpac Node from a WMS/WCS request.
from_url(url)	Create podpac Node from a WMS/WCS request.
get_bounds([crs])	Get the full available coordinate bounds for the Node.
get_cache(key[, coordinates])	Get cached data for this node.
get_ui_spec([help_as_html])	Get spec of node attributes for building a ui
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[, _selector])	Summary
load(path)	Create podpac Node from file.
probe([lat, lon, time, alt, crs])	Evaluates every part of a node / pipeline at a point and records which nodes are actively being used.
put_cache(data, key[, coordinates, expires, ...])	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[, _selector])	Select and prepare sources based on requested coordinates.
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_is_defined(name)
trait_values(**metadata)	A dict of trait names and their values.

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	An enum whose value must be in a given sequence.
force_eval	A boolean (True, False) trait.
hash
json	Definition for this node in JSON format.
json_pretty	Definition for this node in JSON format, with indentation suitable for display.
multithreading	A boolean (True, False) trait.
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)

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

multithreading

A boolean (True, False) trait.