podpac.algorithm.Algorithm

class podpac.algorithm.Algorithm(**kwargs)[source]

Bases: podpac.core.node.Node

Base class for algorithm and computation nodes.

Notes

Developers of new Algorithm nodes need to implement the algorithm method.

Methods

__init__(**kwargs)

Do not overwrite me

algorithm(inputs)

param inputs

Evaluated outputs of the input nodes. The keys are the attribute names.

create_output_array(coords[, data])

Initialize an output data array

eval(coordinates[, output])

Evalutes 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 native coordinates for the inputs to the Node.

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.

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

Cache data for this node.

rem_cache(key[, coordinates, mode])

Clear cached data for this node.

Attributes

base_definition

Base node definition.

base_ref

Default pipeline node reference/name in pipeline node definitions

cache_ctrl

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

cache_output

A boolean (True, False) trait.

cache_update

A boolean (True, False) trait.

definition

Full pipeline definition for this node.

dtype

A trait which allows any value.

hash

json

definition for this node in json format

json_pretty

pipeline

Create a pipeline node from this node

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

algorithm(inputs)[source]
Parameters

inputs (dict) – Evaluated outputs of the input nodes. The keys are the attribute names.

Raises

NotImplementedError – Description

property base_definition

Base node definition.

Returns

Extends base description by adding ‘inputs’

Return type

OrderedDict

eval(coordinates, output=None)[source]

Evalutes this nodes using the supplied coordinates.

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

  • output (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.

Return type

podpac.UnitsDataArray

find_coordinates()[source]

Get the available native coordinates for the inputs to the Node.

Returns

coords_list – list of available coordinates (Coordinate objects)

Return type

list