podpac.algorithm.ExpandCoordinates

class podpac.algorithm.ExpandCoordinates(**kwargs: Any)

Bases: ModifyCoordinates

Evaluate a source node with expanded coordinates.

This is normally used in conjunction with a reduce operation to calculate, for example, the average temperature over the last month. While this is simple to do when evaluating a single node (just provide the coordinates), this functionality is needed for nodes buried deeper in a pipeline.

lat, lon, time, altList

Expansion parameters for the given dimension: The options are::

• [start_offset, end_offset, step] to expand uniformly around each input coordinate.

• [start_offset, end_offset] to expand using the available source coordinates around each input coordinate.

bounds_only: bool

Default is False. If True, will only expand the bounds of the overall coordinates request. Otherwise, it will expand around EACH coordinate in the request. For example, with bounds_only == True, and an expansion of 3 you may expand [5, 6, 8] to [2, 3, 4, 5, 6, 7, 8, 9, 10, 11], whereas with bounds_only == False, it becomes [[2, 5, 8], [3, 6, 9], [5, 8, 11]] (brackets added for clarity, they will be concatenated).

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
create_output_array(coords[, data, attrs, ...])	Initialize an output data array
eval(coordinates, **kwargs)	Evaluate the node at the given coordinates.
eval_group(group)	Evaluate the node for each of the coordinates in the group.
find_coordinates()	Get the available coordinates for the inputs to 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_modified_coordinates1d(coords, dim)	Returns the expanded coordinates for the requested dimension, depending on the expansion parameter for the given dimension.
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.
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.
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

alt	An instance of a Python list.
attrs	List of node attributes
base_ref	Default reference/name in node definitions
bounds_only	A boolean (True, False) trait.
cache_ctrl	A trait whose value must be an instance of a specified class.
cache_output	A boolean (True, False) trait.
coordinates_source
definition
dtype	An enum whose value must be in a given sequence.
force_eval	A boolean (True, False) trait.
hash
inputs
json	Definition for this node in JSON format.
json_pretty	Definition for this node in JSON format, with indentation suitable for display.
lat	An instance of a Python list.
lon	An instance of a Python list.
output	A trait for unicode strings.
outputs	An instance of a Python list.
source
style	A trait whose value must be an instance of a specified class.
substitute_eval_coords	A boolean (True, False) trait.
time	An instance of a Python list.
units	A trait for unicode strings.

Members:

__init__(**kwargs)

Do not overwrite me

bounds_only

A boolean (True, False) trait.

get_modified_coordinates1d(coords, dim)

Returns the expanded coordinates for the requested dimension, depending on the expansion parameter for the given dimension.

Parameters:

• coords (Coordinates) – The requested input coordinates

• dim (str) – Dimension to expand

Returns:

expanded – Expanded coordinates

Return type:

podpac.coordinates.Coordinates1d

substitute_eval_coords

A boolean (True, False) trait.