podpac.algorithm.Algorithm

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

Bases: podpac.core.algorithm.algorithm.BaseAlgorithm

Base class for computation nodes with a custom algorithm.

Notes

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

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

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.

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.

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.

trait_is_defined(name)

Attributes

attrs

List of node attributes

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.

cache_update

A boolean (True, False) trait.

definition

dtype

A trait which allows any value.

hash

inputs

json

json_pretty

output

A trait for unicode strings.

outputs

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

algorithm(inputs)[source]
Parameters

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

Raises

NotImplementedError – Description

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