holoviews.operation Package ¶

`operation` Package ¶

class holoviews.operation. threshold ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

Threshold a given Image whereby all values higher than a given level map to the specified high value and all values lower than that level map to the specified low value.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Threshold, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group assigned to the thresholded output.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param Number level ( allow_None=False, bounds=None, constant=False, default=0.5, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): The value at which the threshold is applied. Values lower than the threshold map to the ‘low’ value and values above map to the ‘high’ value.
param Number high ( allow_None=False, bounds=None, constant=False, default=1.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): The value given to elements greater than (or equal to) the threshold.
param Number low ( allow_None=False, bounds=None, constant=False, default=0.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): The value given to elements below the threshold.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.element.threshold'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.element.threshold'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.element.threshold'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.element.threshold'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

output_type ¶: alias of Image

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.element.threshold'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.element.threshold'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation. transform ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

Generic Operation to transform an input Image or RGBA element into an output Image. The transformation is defined by the supplied callable that accepts the data of the input Image (typically a numpy array) and returns the transformed data of the output Image.

This operator is extremely versatile; for instance, you could implement an alternative to the explicit threshold operator with:

operator=lambda x: np.clip(x, 0, 0.5)

Alternatively, you can implement a transform computing the 2D autocorrelation using the scipy library with:

operator=lambda x: scipy.signal.correlate2d(x, x)

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Transform, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group assigned to the result after applying the transform.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param Callable operator ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Function of one argument that transforms the data in the input Image to the data in the output Image. By default, acts as the identity function such that the output matches the input.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.element.transform'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.element.transform'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.element.transform'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.element.transform'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

output_type ¶: alias of Image

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.element.transform'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.element.transform'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation. factory ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

Simple operation that constructs any element that accepts some other element as input. For instance, RGB and HSV elements can be created from overlays of Image elements.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Operation, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group string used to identify the output of the Operation. By default this should match the operation name.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param Parameter output_type ( allow_None=False, constant=False, default=<class ‘holoviews.element.raster.RGB’>, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The output type of the factor operation. By default, if three overlaid Images elements are supplied, the corresponding RGB element will be returned.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.element.factory'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.element.factory'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.element.factory'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.element.factory'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

output_type ¶: alias of RGB

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.element.factory'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.element.factory'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation. Operation ( **params ) [source] ¶

Bases: param.parameterized.ParameterizedFunction

An Operation process an Element or HoloMap at the level of individual elements or overlays. If a holomap is passed in as input, a processed holomap is returned as output where the individual elements have been transformed accordingly. An Operation may turn overlays in new elements or vice versa.

An Operation can be set to be dynamic, which will return a DynamicMap with a callback that will apply the operation dynamically. An Operation may also supply a list of Stream classes on a streams parameter, which can allow dynamic control over the parameters on the operation.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Operation, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group string used to identify the output of the Operation. By default this should match the operation name.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.core.operation.Operation'>) ¶

classmethod get_overlay_bounds ( overlay ) [source] ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

classmethod get_overlay_label ( overlay , default_label='' ) [source] ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.core.operation.Operation'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.core.operation.Operation'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.core.operation.Operation'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) [source] ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

classmethod search ( element , pattern ) [source] ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.core.operation.Operation'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.core.operation.Operation'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation. operation ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

The most generic operation that wraps any callable into an Operation. The callable needs to accept an HoloViews component and a key (that may be ignored) and must return a new HoloViews component.

This class may be useful for turning a HoloViews method into an operation to define as compositor operation. For instance, the following definition:

operation.instance(op=lambda x, k: x.collapse(np.subtract))

Could be used to implement a collapse operation to subtracts the data between Rasters in an Overlay.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Operation, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group assigned to the result after having applied the operator.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param Parameter output_type ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The output element type which may be None to disable type checking. May be used to declare useful information to other code in HoloViews e.g required for tab-completion support of operations registered with compositors.
param Callable op ( allow_None=False, constant=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The operation used to generate a new HoloViews object returned by the operation. By default, the identity operation is applied.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.element.operation'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.element.operation'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.element.operation'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.element.operation'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.element.operation'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.element.operation'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation. collapse ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

Given an overlay of Element types, collapse into single Element object using supplied function. Collapsing aggregates over the key dimensions of each object applying the supplied fn to each group.

This is an example of an Operation that does not involve any Raster types.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Operation, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group string used to identify the output of the Operation. By default this should match the operation name.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param Callable fn ( allow_None=False, constant=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The function that is used to collapse the curve y-values for each x-value.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

fn ( a , axis=None , dtype=None , out=None , keepdims=<class 'numpy._globals._NoValue'> ) ¶

Compute the arithmetic mean along the specified axis.

Returns the average of the array elements. The average is taken over the flattened array by default, otherwise over the specified axis. float64 intermediate and return values are used for integer inputs.

a : array_like

Array containing numbers whose mean is desired. If a is not an array, a conversion is attempted.

axis : None or int or tuple of ints, optional

Axis or axes along which the means are computed. The default is to compute the mean of the flattened array.

If this is a tuple of ints, a mean is performed over multiple axes, instead of a single axis or all the axes as before.

dtype : data-type, optional

Type to use in computing the mean. For integer inputs, the default is float64 ; for floating point inputs, it is the same as the input dtype.

out : ndarray, optional

Alternate output array in which to place the result. The default is


             
              None

; if provided, it must have the same shape as the expected output, but the type will be cast if necessary. See doc.ufuncs for details.

keepdims : bool, optional

If this is set to True, the axes which are reduced are left in the result as dimensions with size one. With this option, the result will broadcast correctly against the original arr .

If the default value is passed, then keepdims will not be passed through to the mean method of sub-classes of ndarray , however any non-default value will be. If the sub-classes sum method does not implement keepdims any exceptions will be raised.

m : ndarray, see dtype parameter above: If out=None , returns a new array containing the mean values, otherwise a reference to the output array is returned.

average : Weighted average std, var, nanmean, nanstd, nanvar

The arithmetic mean is the sum of the elements along the axis divided by the number of elements.

Note that for floating-point input, the mean is computed using the same precision the input has. Depending on the input data, this can cause the results to be inaccurate, especially for float32 (see example below). Specifying a higher-precision accumulator using the dtype keyword can alleviate this issue.

            >>> a = np.array([[1, 2], [3, 4]])
>>> np.mean(a)
2.5
>>> np.mean(a, axis=0)
array([ 2.,  3.])
>>> np.mean(a, axis=1)
array([ 1.5,  3.5])

           

In single precision, mean can be inaccurate:

            >>> a = np.zeros((2, 512*512), dtype=np.float32)
>>> a[0, :] = 1.0
>>> a[1, :] = 0.1
>>> np.mean(a)
0.546875

           

Computing the mean in float64 is more accurate:

            >>> np.mean(a, dtype=np.float64)
0.55000000074505806

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.element.collapse'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.element.collapse'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.element.collapse'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.element.collapse'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.element.collapse'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.element.collapse'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation. interpolate_curve ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

Resamples a Curve using the defined interpolation method, e.g. to represent changes in y-values as steps.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Operation, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group string used to identify the output of the Operation. By default this should match the operation name.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param ObjectSelector interpolation ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=steps-mid, instantiate=False, objects=[‘steps-pre’, ‘steps-mid’, ‘steps-post’, ‘linear’], pickle_default_value=True, precedence=None, readonly=False ): Controls the transition point of the step along the x-axis.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.element.interpolate_curve'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.element.interpolate_curve'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.element.interpolate_curve'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.element.interpolate_curve'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.element.interpolate_curve'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.element.interpolate_curve'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation. decimate ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

Decimates any column based Element to a specified number of random rows if the current view defined by the x_range and y_range contains more than max_samples. By default the operation returns a DynamicMap with a RangeXY stream allowing dynamic downsampling.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Operation, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group string used to identify the output of the Operation. By default this should match the operation name.
param Boolean dynamic ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Enables dynamic processing by default.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): By default, the link_inputs parameter is set to True so that when applying shade, backends that support linked streams update RangeXY streams on the inputs of the shade operation.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[<class ‘holoviews.streams.RangeXY’>], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param Integer max_samples ( allow_None=False, bounds=None, constant=False, default=5000, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Maximum number of samples to display at the same time.
param Integer random_seed ( allow_None=False, bounds=None, constant=False, default=42, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Seed used to initialize randomization.
param NumericTuple x_range ( allow_None=True, constant=False, default=None, instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False ): The x_range as a tuple of min and max x-value. Auto-ranges if set to None.
param NumericTuple y_range ( allow_None=True, constant=False, default=None, instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False ): The x_range as a tuple of min and max y-value. Auto-ranges if set to None.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.element.decimate'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.element.decimate'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.element.decimate'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.element.decimate'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.element.decimate'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.element.decimate'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation. image_overlay ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

Operation to build a overlay of images to a specification from a subset of the required elements.

This is useful for reordering the elements of an overlay, duplicating layers of an overlay or creating blank image elements in the appropriate positions.

For instance, image_overlay may build a three layered input suitable for the RGB factory operation even if supplied with one or two of the required channels (creating blank channels for the missing elements).

Note that if there is any ambiguity regarding the match, the strongest match will be used. In the case of a tie in match strength, the first layer in the input is used. One successful match is always required.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Transform, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group assigned to the resulting overlay.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param String spec ( allow_None=False, basestring=<class ‘str’>, constant=False, default=, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Specification of the output Overlay structure. For instance: Image.R * Image.G * Image.B Will ensure an overlay of this structure is created even if (for instance) only (Image.R * Image.B) is supplied. Elements in the input overlay that match are placed in the appropriate positions and unavailable specification elements are created with the specified fill group.

param Number fill ( allow_None=False, bounds=None, constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )

param Tuple default_range ( allow_None=False, constant=False, default=(0, 1), instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False ): The default range that will be set on the value_dimension of any automatically created blank image elements.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.element.image_overlay'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.element.image_overlay'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.element.image_overlay'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.element.image_overlay'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

output_type ¶: alias of Overlay

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.element.image_overlay'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.element.image_overlay'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation. gradient ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

Compute the gradient plot of the supplied Image.

If the Image value dimension is cyclic, the smallest step is taken considered the cyclic range

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Gradient, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group assigned to the output gradient matrix.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.element.gradient'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.element.gradient'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.element.gradient'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.element.gradient'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

output_type ¶: alias of Image

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.element.gradient'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.element.gradient'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation. contours ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

Given a Image with a single channel, annotate it with contour lines for a given set of contour levels.

The return is an NdOverlay with a Contours layer for each given level, overlaid on top of the input Image.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Level, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group assigned to the output contours.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param ClassSelector levels ( allow_None=False, constant=False, default=10, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): A list of scalar values used to specify the contour levels.
param Boolean filled ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Whether to generate filled contours
param Boolean overlaid ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Whether to overlay the contour on the supplied Element.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.element.contours'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.element.contours'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.element.contours'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.element.contours'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

output_type ¶: alias of Overlay

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.element.contours'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.element.contours'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation. histogram ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

Returns a Histogram of the input element data, binned into num_bins over the bin_range (if specified) along the specified dimension.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Operation, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group string used to identify the output of the Operation. By default this should match the operation name.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param NumericTuple bin_range ( allow_None=True, constant=False, default=None, instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False ): Specifies the range within which to compute the bins.
param String dimension ( allow_None=False, basestring=<class ‘str’>, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Along which dimension of the Element to compute the histogram.
param String frequency_label ( allow_None=False, basestring=<class ‘str’>, constant=False, default={dim} Frequency, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Format string defining the label of the frequency dimension of the Histogram.
param ClassSelector groupby ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Defines a dimension to group the Histogram returning an NdOverlay of Histograms.
param Boolean individually ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Specifies whether the histogram will be rescaled for each Element in a UniformNdMapping.
param Boolean log ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Whether to use base 10 logarithmic samples for the bin edges.
param Boolean mean_weighted ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Whether the weighted frequencies are averaged.
param ObjectSelector normed ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=True, instantiate=False, objects=[True, False, ‘integral’, ‘height’], pickle_default_value=True, precedence=None, readonly=False ): Controls normalization behavior. If True or ‘integral’ , then density=True is passed to np.histogram, and the distribution is normalized such that the integral is unity. If False , then the frequencies will be raw counts. If ‘height’ , then the frequencies are normalized such that the max bin height is unity.
param Boolean nonzero ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Whether to use only nonzero values when computing the histogram
param Integer num_bins ( allow_None=False, bounds=None, constant=False, default=20, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Number of bins in the histogram .
param String weight_dimension ( allow_None=False, basestring=<class ‘str’>, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Name of the dimension the weighting should be drawn from
param String style_prefix ( allow_None=None, basestring=<class ‘str’>, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Used for setting a common style for histograms in a HoloMap or AdjointLayout.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.element.histogram'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.element.histogram'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.element.histogram'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.element.histogram'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.element.histogram'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.element.histogram'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation. categorical_aggregate2d ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

Generates a gridded Dataset of 2D aggregate arrays indexed by the first two dimensions of the passed Element, turning all remaining dimensions into value dimensions. The key dimensions of the gridded array are treated as categorical indices. Useful for data indexed by two independent categorical variables such as a table of population values indexed by country and year. Data that is indexed by continuous dimensions should be binned before aggregation. The aggregation will retain the global sorting order of both dimensions.

>> table = Table([(‘USA’, 2000, 282.2), (‘UK’, 2005, 58.89)],: kdims=[‘Country’, ‘Year’], vdims=[‘Population’])

>> categorical_aggregate2d(table) Dataset({‘Country’: [‘USA’, ‘UK’], ‘Year’: [2000, 2005],

‘Population’: [[ 282.2 , np.NaN], [np.NaN, 58.89]]},

kdims=[‘Country’, ‘Year’], vdims=[‘Population’])

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Operation, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group string used to identify the output of the Operation. By default this should match the operation name.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param List datatype ( allow_None=False, bounds=(0, None), constant=False, default=[‘xarray’, ‘grid’], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): The grid interface types to use when constructing the gridded Dataset.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.element.util.categorical_aggregate2d'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.element.util.categorical_aggregate2d'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.element.util.categorical_aggregate2d'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.element.util.categorical_aggregate2d'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.element.util.categorical_aggregate2d'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.element.util.categorical_aggregate2d'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation. convolve ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

Apply a convolution to an overlay using the top layer as the kernel for convolving the bottom layer. Both Image elements in the input overlay should have a single value dimension.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Convolution, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group assigned to the convolved output.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param NumericTuple kernel_roi ( allow_None=False, constant=False, default=(0, 0, 0, 0), instantiate=False, length=4, pickle_default_value=True, precedence=None, readonly=False ): A 2-dimensional slice of the kernel layer to use in the convolution in lbrt (left, bottom, right, top) format. By default, no slicing is applied.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.element.convolve'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.element.convolve'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.element.convolve'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.element.convolve'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

output_type ¶: alias of Image

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.element.convolve'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.element.convolve'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation. chain ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

Defining an Operation chain is an easy way to define a new Operation from a series of existing ones. The argument is a list of Operation (or Operation instances) that are called in sequence to generate the returned element.

chain(operations=[gradient, threshold.instance(level=2)])

This operation can accept an Image instance and would first compute the gradient before thresholding the result at a level of 2.0.

Instances are only required when arguments need to be passed to individual operations so the resulting object is a function over a single argument.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Chain, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group assigned to the result after having applied the chain.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param Parameter output_type ( allow_None=False, constant=False, default=<class ‘holoviews.element.raster.Image’>, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The output type of the chain operation. Must be supplied if the chain is to be used as a channel operation.
param List operations ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): A list of Operations (or Operation instances) that are applied on the input from left to right..

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.element.chain'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.element.chain'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.element.chain'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.element.chain'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

output_type ¶: alias of Image

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.element.chain'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.element.chain'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation. Compositor ( pattern , operation , group , mode , transfer_options=False , transfer_parameters=False , output_type=None , **kwargs ) [source] ¶

Bases: param.parameterized.Parameterized

A Compositor is a way of specifying an operation to be automatically applied to Overlays that match a specified pattern upon display.

Any Operation that takes an Overlay as input may be used to define a compositor.

For instance, a compositor may be defined to automatically display three overlaid monochrome matrices as an RGB image as long as the values names of those matrices match ‘R’, ‘G’ and ‘B’.

param ObjectSelector mode ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=data, instantiate=False, objects=[‘data’, ‘display’], pickle_default_value=True, precedence=None, readonly=False ): The mode of the Compositor object which may be either ‘data’ or ‘display’.
param Parameter operation ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The Operation to apply when collapsing overlays.
param String pattern ( allow_None=False, basestring=<class ‘str’>, constant=False, default=, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The overlay pattern to be processed. An overlay pattern is a sequence of elements specified by dotted paths separated by * . For instance the following pattern specifies three overlayed matrices with values of ‘RedChannel’, ‘GreenChannel’ and ‘BlueChannel’ respectively: ‘Image.RedChannel * Image.GreenChannel * Image.BlueChannel. This pattern specification could then be associated with the RGB operation that returns a single RGB matrix for display.
param String group ( allow_None=True, basestring=<class ‘str’>, constant=False, default=, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group identifier for the output of this particular compositor
param Dict kwargs ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Optional set of parameters to pass to the operation.
param Boolean transfer_options ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Whether to transfer the options from the input to the output.
param Boolean transfer_parameters ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Whether to transfer plot options which match to the operation.

apply ( value , input_ranges , backend=None ) [source] ¶: Apply the compositor on the input with the given input ranges.

classmethod collapse ( holomap , ranges=None , mode='data' ) [source] ¶: Given a map of Overlays, apply all applicable compositors.

classmethod collapse_element ( overlay , ranges=None , mode='data' , backend=None ) [source] ¶: Finds any applicable compositor and applies it.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.core.options.Compositor'>) ¶

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.core.options.Compositor'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.core.options.Compositor'>) ¶

classmethod map ( obj , mode='data' , backend=None ) [source] ¶: Applies compositor operations to any HoloViews element or container using the map method.

match_level ( overlay ) [source] ¶

Given an overlay, return the match level and applicable slice of the overall overlay. The level an integer if there is a match or None if there is no match.

The level integer is the number of matching components. Higher values indicate a stronger match.

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

output_type ¶: Returns the operation output_type unless explicitly overridden in the kwargs.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix=' ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: (Experimental) Pretty printed representation that may be evaluated with eval. See pprint() function for more details.

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

script_repr ( imports=[] , prefix=' ' ) ¶: Variant of __repr__ designed for generating a runnable script.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.core.options.Compositor'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.core.options.Compositor'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

classmethod strongest_match ( overlay , mode ) [source] ¶

Returns the single strongest matching compositor operation given an overlay. If no matches are found, None is returned.

The best match is defined as the compositor operation with the highest match value as returned by the match_level method.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

`datashader` Module ¶

class holoviews.operation.datashader. ResamplingOperation ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

Abstract baseclass for resampling operations

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Operation, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group string used to identify the output of the Operation. By default this should match the operation name.
param Boolean dynamic ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Enables dynamic processing by default.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): By default, the link_inputs parameter is set to True so that when applying shade, backends that support linked streams update RangeXY streams on the inputs of the shade operation. Disable when you do not want the resulting plot to be interactive, e.g. when trying to display an interactive plot a second time.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[<class ‘holoviews.streams.PlotSize’>, <class ‘holoviews.streams.RangeXY’>], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param Boolean expand ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Whether the x_range and y_range should be allowed to expand beyond the extent of the data. Setting this value to True is useful for the case where you want to ensure a certain size of output grid, e.g. if you are doing masking or other arithmetic on the grids. A value of False ensures that the grid is only just as large as it needs to be to contain the data, which will be faster and use less memory if the resulting aggregate is being overlaid on a much larger background.
param Integer height ( allow_None=False, bounds=None, constant=False, default=400, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): The height of the output image in pixels.
param Integer width ( allow_None=False, bounds=None, constant=False, default=400, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): The width of the output image in pixels.
param NumericTuple x_range ( allow_None=True, constant=False, default=None, instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False ): The x_range as a tuple of min and max x-value. Auto-ranges if set to None.
param NumericTuple y_range ( allow_None=True, constant=False, default=None, instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False ): The x_range as a tuple of min and max y-value. Auto-ranges if set to None.
param Number x_sampling ( allow_None=True, bounds=None, constant=False, default=None, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Specifies the smallest allowed sampling interval along the y-axis.
param Number y_sampling ( allow_None=True, bounds=None, constant=False, default=None, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Specifies the smallest allowed sampling interval along the y-axis.
param ClassSelector target ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): A target Image which defines the desired x_range, y_range, width and height.
param ClassSelector element_type ( allow_None=False, constant=False, default=<class ‘holoviews.element.raster.Image’>, instantiate=False, is_instance=False, pickle_default_value=True, precedence=None, readonly=False ): The type of the returned Elements, must be a 2D Dataset type.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

element_type ¶: alias of Image

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.datashader.ResamplingOperation'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.datashader.ResamplingOperation'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.datashader.ResamplingOperation'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.datashader.ResamplingOperation'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.datashader.ResamplingOperation'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.datashader.ResamplingOperation'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation.datashader. aggregate ( **params ) [source] ¶

Bases: holoviews.operation.datashader.ResamplingOperation

aggregate implements 2D binning for any valid HoloViews Element type using datashader. I.e., this operation turns a HoloViews Element or overlay of Elements into an hv.Image or an overlay of hv.Images by rasterizing it, which provides a fixed-sized representation independent of the original dataset size.

By default it will simply count the number of values in each bin but other aggregators can be supplied implementing mean, max, min and other reduction operations.

The bins of the aggregate are defined by the width and height and the x_range and y_range. If x_sampling or y_sampling are supplied the operation will ensure that a bin is no smaller than the minimum sampling distance by reducing the width and height when zoomed in beyond the minimum sampling distance.

By default, the PlotSize stream is applied when this operation is used dynamically, which means that the height and width will automatically be set to match the inner dimensions of the linked plot.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Operation, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group string used to identify the output of the Operation. By default this should match the operation name.
param Boolean dynamic ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Enables dynamic processing by default.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): By default, the link_inputs parameter is set to True so that when applying shade, backends that support linked streams update RangeXY streams on the inputs of the shade operation. Disable when you do not want the resulting plot to be interactive, e.g. when trying to display an interactive plot a second time.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[<class ‘holoviews.streams.PlotSize’>, <class ‘holoviews.streams.RangeXY’>], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param Boolean expand ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Whether the x_range and y_range should be allowed to expand beyond the extent of the data. Setting this value to True is useful for the case where you want to ensure a certain size of output grid, e.g. if you are doing masking or other arithmetic on the grids. A value of False ensures that the grid is only just as large as it needs to be to contain the data, which will be faster and use less memory if the resulting aggregate is being overlaid on a much larger background.
param Integer height ( allow_None=False, bounds=None, constant=False, default=400, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): The height of the output image in pixels.
param Integer width ( allow_None=False, bounds=None, constant=False, default=400, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): The width of the output image in pixels.
param NumericTuple x_range ( allow_None=True, constant=False, default=None, instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False ): The x_range as a tuple of min and max x-value. Auto-ranges if set to None.
param NumericTuple y_range ( allow_None=True, constant=False, default=None, instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False ): The x_range as a tuple of min and max y-value. Auto-ranges if set to None.
param Number x_sampling ( allow_None=True, bounds=None, constant=False, default=None, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Specifies the smallest allowed sampling interval along the y-axis.
param Number y_sampling ( allow_None=True, bounds=None, constant=False, default=None, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Specifies the smallest allowed sampling interval along the y-axis.
param ClassSelector target ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): A target Image which defines the desired x_range, y_range, width and height.
param ClassSelector element_type ( allow_None=False, constant=False, default=<class ‘holoviews.element.raster.Image’>, instantiate=False, is_instance=False, pickle_default_value=True, precedence=None, readonly=False ): The type of the returned Elements, must be a 2D Dataset type.

param ClassSelector aggregator ( allow_None=False, constant=False, default=<datashader.reductions.count object at 0x7ff40c512e10>, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

element_type ¶: alias of Image

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.datashader.aggregate'>) ¶

classmethod get_agg_data ( obj , category=None ) [source] ¶: Reduces any Overlay or NdOverlay of Elements into a single xarray Dataset that can be aggregated.

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.datashader.aggregate'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.datashader.aggregate'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.datashader.aggregate'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.datashader.aggregate'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.datashader.aggregate'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation.datashader. bundle_graph ( **params ) [source] ¶

Bases: holoviews.operation.datashader._connect_edges , datashader.bundling.hammer_bundle

Iteratively group edges and return as paths suitable for datashading.

Breaks each edge into a path with multiple line segments, and iteratively curves this path to bundle edges into groups.

param String x ( allow_None=False, basestring=<class ‘str’>, constant=False, default=x, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Column name for each node’s x coordinate.
param String y ( allow_None=False, basestring=<class ‘str’>, constant=False, default=y, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Column name for each node’s y coordinate.
param String source ( allow_None=False, basestring=<class ‘str’>, constant=False, default=source, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Column name for each edge’s source.
param String target ( allow_None=False, basestring=<class ‘str’>, constant=False, default=target, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Column name for each edge’s target.
param String weight ( allow_None=True, basestring=<class ‘str’>, constant=False, default=weight, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Column name for each edge weight. If None, weights are ignored.
param Boolean include_edge_id ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Include edge IDs in bundled dataframe
param Number initial_bandwidth ( allow_None=False, bounds=(0.0, None), constant=False, default=0.05, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Initial value of the bandwidth….
param Number decay ( allow_None=False, bounds=(0.0, 1.0), constant=False, default=0.7, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Rate of decay in the bandwidth value, with 1.0 indicating no decay.
param Integer iterations ( allow_None=False, bounds=(1, None), constant=False, default=4, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Number of passes for the smoothing algorithm
param Integer batch_size ( allow_None=False, bounds=(1, None), constant=False, default=20000, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Number of edges to process together
param Number tension ( allow_None=False, bounds=(0, None), constant=False, default=0.3, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=-0.5, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Exponential smoothing factor to use when smoothing
param Integer accuracy ( allow_None=False, bounds=(1, None), constant=False, default=500, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=-0.5, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Number of entries in table for…
param Integer advect_iterations ( allow_None=False, bounds=(0, None), constant=False, default=50, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=-0.5, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Number of iterations to move edges along gradients
param Number min_segment_length ( allow_None=False, bounds=(0, None), constant=False, default=0.008, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=-0.5, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Minimum length (in data space?) for an edge segment
param Number max_segment_length ( allow_None=False, bounds=(0, None), constant=False, default=0.016, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=-0.5, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Maximum length (in data space?) for an edge segment
param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Operation, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group string used to identify the output of the Operation. By default this should match the operation name.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param Boolean split ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Determines whether bundled edges will be split into individual edges or concatenated with NaN separators.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.datashader.bundle_graph'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.datashader.bundle_graph'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.datashader.bundle_graph'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.datashader.bundle_graph'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.datashader.bundle_graph'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.datashader.bundle_graph'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation.datashader. datashade ( **params ) [source] ¶

Bases: holoviews.operation.datashader.aggregate , holoviews.operation.datashader.shade

Applies the aggregate and shade operations, aggregating all elements in the supplied object and then applying normalization and colormapping the aggregated data returning RGB elements.

See aggregate and shade operations for more details.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Operation, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group string used to identify the output of the Operation. By default this should match the operation name.
param Boolean dynamic ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Enables dynamic processing by default.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): By default, the link_inputs parameter is set to True so that when applying shade, backends that support linked streams update RangeXY streams on the inputs of the shade operation. Disable when you do not want the resulting plot to be interactive, e.g. when trying to display an interactive plot a second time.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[<class ‘holoviews.streams.PlotSize’>, <class ‘holoviews.streams.RangeXY’>], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param ClassSelector cmap ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Iterable or callable which returns colors as hex colors or web color names (as defined by datashader), to be used for the colormap of single-layer datashader output. Callable type must allow mapping colors between 0 and 1. The default value of None reverts to Datashader’s default colormap.
param ClassSelector color_key ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Iterable or callable which returns colors as hex colors, to be used for the color key of categorical datashader output. Callable type must allow mapping colors between 0 and 1.
param ClassSelector normalization ( allow_None=False, constant=False, default=eq_hist, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): The normalization operation applied before colormapping. Valid options include ‘linear’, ‘log’, ‘eq_hist’, ‘cbrt’, and any valid transfer function that accepts data, mask, nbins arguments.
param NumericTuple clims ( allow_None=True, constant=False, default=None, instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False ): Min and max data values to use for colormap interpolation, when wishing to override autoranging.
param Boolean expand ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Whether the x_range and y_range should be allowed to expand beyond the extent of the data. Setting this value to True is useful for the case where you want to ensure a certain size of output grid, e.g. if you are doing masking or other arithmetic on the grids. A value of False ensures that the grid is only just as large as it needs to be to contain the data, which will be faster and use less memory if the resulting aggregate is being overlaid on a much larger background.
param Integer height ( allow_None=False, bounds=None, constant=False, default=400, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): The height of the output image in pixels.
param Integer width ( allow_None=False, bounds=None, constant=False, default=400, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): The width of the output image in pixels.
param NumericTuple x_range ( allow_None=True, constant=False, default=None, instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False ): The x_range as a tuple of min and max x-value. Auto-ranges if set to None.
param NumericTuple y_range ( allow_None=True, constant=False, default=None, instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False ): The x_range as a tuple of min and max y-value. Auto-ranges if set to None.
param Number x_sampling ( allow_None=True, bounds=None, constant=False, default=None, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Specifies the smallest allowed sampling interval along the y-axis.
param Number y_sampling ( allow_None=True, bounds=None, constant=False, default=None, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Specifies the smallest allowed sampling interval along the y-axis.
param ClassSelector target ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): A target Image which defines the desired x_range, y_range, width and height.
param ClassSelector element_type ( allow_None=False, constant=False, default=<class ‘holoviews.element.raster.Image’>, instantiate=False, is_instance=False, pickle_default_value=True, precedence=None, readonly=False ): The type of the returned Elements, must be a 2D Dataset type.

concatenate ( overlay ) ¶: Concatenates an NdOverlay of Image types into a single 3D xarray Dataset.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

element_type ¶: alias of Image

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.datashader.datashade'>) ¶

get_agg_data ( obj , category=None ) ¶: Reduces any Overlay or NdOverlay of Elements into a single xarray Dataset that can be aggregated.

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.datashader.datashade'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.datashader.datashade'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.datashader.datashade'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

rgb2hex ( rgb ) ¶: Convert RGB(A) tuple to hex.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.datashader.datashade'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.datashader.datashade'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

uint32_to_uint8 ( img ) ¶: Cast uint32 RGB image to 4 uint8 channels.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation.datashader. directly_connect_edges ( **params ) [source] ¶

Bases: holoviews.operation.datashader._connect_edges , datashader.bundling.directly_connect_edges

Given a Graph object will directly connect all nodes.

param String x ( allow_None=False, basestring=<class ‘str’>, constant=False, default=x, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Column name for each node’s x coordinate.
param String y ( allow_None=False, basestring=<class ‘str’>, constant=False, default=y, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Column name for each node’s y coordinate.
param String source ( allow_None=False, basestring=<class ‘str’>, constant=False, default=source, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Column name for each edge’s source.
param String target ( allow_None=False, basestring=<class ‘str’>, constant=False, default=target, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Column name for each edge’s target.
param String weight ( allow_None=True, basestring=<class ‘str’>, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Column name for each edge weight. If None, weights are ignored.
param Boolean include_edge_id ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Include edge IDs in bundled dataframe
param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Operation, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group string used to identify the output of the Operation. By default this should match the operation name.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param Boolean split ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Determines whether bundled edges will be split into individual edges or concatenated with NaN separators.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.datashader.directly_connect_edges'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.datashader.directly_connect_edges'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.datashader.directly_connect_edges'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.datashader.directly_connect_edges'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.datashader.directly_connect_edges'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.datashader.directly_connect_edges'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation.datashader. dynspread ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

Spreading expands each pixel in an Image based Element a certain number of pixels on all sides according to a given shape, merging pixels using a specified compositing operator. This can be useful to make sparse plots more visible. Dynamic spreading determines how many pixels to spread based on a density heuristic.

See the datashader documentation for more detail:

http://datashader.readthedocs.io/en/latest/api.html#datashader.transfer_functions.dynspread

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Operation, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group string used to identify the output of the Operation. By default this should match the operation name.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): By default, the link_inputs parameter is set to True so that when applying dynspread, backends that support linked streams update RangeXY streams on the inputs of the dynspread operation. Disable when you do not want the resulting plot to be interactive, e.g. when trying to display an interactive plot a second time.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param ObjectSelector how ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=source, instantiate=False, objects=[‘source’, ‘over’, ‘saturate’, ‘add’], pickle_default_value=True, precedence=None, readonly=False ): The name of the compositing operator to use when combining pixels.
param Integer max_px ( allow_None=False, bounds=None, constant=False, default=3, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Maximum number of pixels to spread on all sides.
param ObjectSelector shape ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=circle, instantiate=False, objects=[‘circle’, ‘square’], pickle_default_value=True, precedence=None, readonly=False ): The shape to spread by. Options are ‘circle’ [default] or ‘square’.
param Number threshold ( allow_None=False, bounds=(0, 1), constant=False, default=0.5, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): When spreading, determines how far to spread. Spreading starts at 1 pixel, and stops when the fraction of adjacent non-empty pixels reaches this threshold. Higher values give more spreading, up to the max_px allowed.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.datashader.dynspread'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.datashader.dynspread'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.datashader.dynspread'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.datashader.dynspread'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.datashader.dynspread'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.datashader.dynspread'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation.datashader. regrid ( **params ) [source] ¶

Bases: holoviews.operation.datashader.ResamplingOperation

regrid allows resampling a HoloViews Image type using specified up- and downsampling functions defined using the aggregator and interpolation parameters respectively. By default upsampling is disabled to avoid unnecessarily upscaling an image that has to be sent to the browser. Also disables expanding the image beyond its original bounds avoiding unneccessarily padding the output array with nan values.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Operation, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group string used to identify the output of the Operation. By default this should match the operation name.
param Boolean dynamic ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Enables dynamic processing by default.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): By default, the link_inputs parameter is set to True so that when applying shade, backends that support linked streams update RangeXY streams on the inputs of the shade operation. Disable when you do not want the resulting plot to be interactive, e.g. when trying to display an interactive plot a second time.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[<class ‘holoviews.streams.PlotSize’>, <class ‘holoviews.streams.RangeXY’>], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param Boolean expand ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Whether the x_range and y_range should be allowed to expand beyond the extent of the data. Setting this value to True is useful for the case where you want to ensure a certain size of output grid, e.g. if you are doing masking or other arithmetic on the grids. A value of False ensures that the grid is only just as large as it needs to be to contain the data, which will be faster and use less memory if the resulting aggregate is being overlaid on a much larger background.
param Integer height ( allow_None=False, bounds=None, constant=False, default=400, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): The height of the output image in pixels.
param Integer width ( allow_None=False, bounds=None, constant=False, default=400, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): The width of the output image in pixels.
param NumericTuple x_range ( allow_None=True, constant=False, default=None, instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False ): The x_range as a tuple of min and max x-value. Auto-ranges if set to None.
param NumericTuple y_range ( allow_None=True, constant=False, default=None, instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False ): The x_range as a tuple of min and max y-value. Auto-ranges if set to None.
param Number x_sampling ( allow_None=True, bounds=None, constant=False, default=None, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Specifies the smallest allowed sampling interval along the y-axis.
param Number y_sampling ( allow_None=True, bounds=None, constant=False, default=None, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Specifies the smallest allowed sampling interval along the y-axis.
param ClassSelector target ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): A target Image which defines the desired x_range, y_range, width and height.
param ClassSelector element_type ( allow_None=False, constant=False, default=<class ‘holoviews.element.raster.Image’>, instantiate=False, is_instance=False, pickle_default_value=True, precedence=None, readonly=False ): The type of the returned Elements, must be a 2D Dataset type.
param ObjectSelector aggregator ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=mean, instantiate=False, objects=[‘first’, ‘last’, ‘mean’, ‘mode’, ‘std’, ‘var’, ‘min’, ‘max’], pickle_default_value=True, precedence=None, readonly=False ): Aggregation method.
param ObjectSelector interpolation ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=nearest, instantiate=False, objects=[‘linear’, ‘nearest’], pickle_default_value=True, precedence=None, readonly=False ): Interpolation method
param Boolean upsample ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Whether to allow upsampling if the source array is smaller than the requested array. Setting this value to True will enable upsampling using the interpolation method, when the requested width and height are larger than what is available on the source grid. If upsampling is disabled (the default) the width and height are clipped to what is available on the source array.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

element_type ¶: alias of Image

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.datashader.regrid'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.datashader.regrid'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.datashader.regrid'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.datashader.regrid'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.datashader.regrid'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.datashader.regrid'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation.datashader. shade ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

shade applies a normalization function followed by colormapping to an Image or NdOverlay of Images, returning an RGB Element. The data must be in the form of a 2D or 3D DataArray, but NdOverlays of 2D Images will be automatically converted to a 3D array.

In the 2D case data is normalized and colormapped, while a 3D array representing categorical aggregates will be supplied a color key for each category. The colormap (cmap) may be supplied as an Iterable or a Callable.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Operation, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group string used to identify the output of the Operation. By default this should match the operation name.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): By default, the link_inputs parameter is set to True so that when applying shade, backends that support linked streams update RangeXY streams on the inputs of the shade operation. Disable when you do not want the resulting plot to be interactive, e.g. when trying to display an interactive plot a second time.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param ClassSelector cmap ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Iterable or callable which returns colors as hex colors or web color names (as defined by datashader), to be used for the colormap of single-layer datashader output. Callable type must allow mapping colors between 0 and 1. The default value of None reverts to Datashader’s default colormap.
param ClassSelector color_key ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Iterable or callable which returns colors as hex colors, to be used for the color key of categorical datashader output. Callable type must allow mapping colors between 0 and 1.
param ClassSelector normalization ( allow_None=False, constant=False, default=eq_hist, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): The normalization operation applied before colormapping. Valid options include ‘linear’, ‘log’, ‘eq_hist’, ‘cbrt’, and any valid transfer function that accepts data, mask, nbins arguments.
param NumericTuple clims ( allow_None=True, constant=False, default=None, instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False ): Min and max data values to use for colormap interpolation, when wishing to override autoranging.

classmethod concatenate ( overlay ) [source] ¶: Concatenates an NdOverlay of Image types into a single 3D xarray Dataset.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.datashader.shade'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.datashader.shade'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.datashader.shade'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.datashader.shade'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

classmethod rgb2hex ( rgb ) [source] ¶: Convert RGB(A) tuple to hex.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.datashader.shade'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.datashader.shade'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

classmethod uint32_to_uint8 ( img ) [source] ¶: Cast uint32 RGB image to 4 uint8 channels.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

holoviews.operation.datashader. split_dataframe ( path_df ) [source] ¶: Splits a dataframe of paths separated by NaNs into individual dataframes.

class holoviews.operation.datashader. stack ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

The stack operation allows compositing multiple RGB Elements using the defined compositing operator.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Operation, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group string used to identify the output of the Operation. By default this should match the operation name.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param ObjectSelector compositor ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=over, instantiate=False, objects=[‘add’, ‘over’, ‘saturate’, ‘source’], pickle_default_value=True, precedence=None, readonly=False ): Defines how the compositing operation combines the images

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.datashader.stack'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.datashader.stack'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.datashader.stack'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.datashader.stack'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.datashader.stack'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.datashader.stack'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

`element` Module ¶

Collection of either extremely generic or simple Operation examples.

class holoviews.operation.element. chain ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

chain(operations=[gradient, threshold.instance(level=2)])

This operation can accept an Image instance and would first compute the gradient before thresholding the result at a level of 2.0.

Instances are only required when arguments need to be passed to individual operations so the resulting object is a function over a single argument.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Chain, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group assigned to the result after having applied the chain.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param Parameter output_type ( allow_None=False, constant=False, default=<class ‘holoviews.element.raster.Image’>, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The output type of the chain operation. Must be supplied if the chain is to be used as a channel operation.
param List operations ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): A list of Operations (or Operation instances) that are applied on the input from left to right..

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.element.chain'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.element.chain'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.element.chain'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.element.chain'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

output_type ¶: alias of Image

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.element.chain'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.element.chain'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation.element. collapse ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

Given an overlay of Element types, collapse into single Element object using supplied function. Collapsing aggregates over the key dimensions of each object applying the supplied fn to each group.

This is an example of an Operation that does not involve any Raster types.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Operation, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group string used to identify the output of the Operation. By default this should match the operation name.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param Callable fn ( allow_None=False, constant=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The function that is used to collapse the curve y-values for each x-value.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

fn ( a , axis=None , dtype=None , out=None , keepdims=<class 'numpy._globals._NoValue'> ) ¶

Compute the arithmetic mean along the specified axis.

a : array_like

Array containing numbers whose mean is desired. If a is not an array, a conversion is attempted.

axis : None or int or tuple of ints, optional

Axis or axes along which the means are computed. The default is to compute the mean of the flattened array.

If this is a tuple of ints, a mean is performed over multiple axes, instead of a single axis or all the axes as before.

dtype : data-type, optional

Type to use in computing the mean. For integer inputs, the default is float64 ; for floating point inputs, it is the same as the input dtype.

out : ndarray, optional

Alternate output array in which to place the result. The default is


             
              None

; if provided, it must have the same shape as the expected output, but the type will be cast if necessary. See doc.ufuncs for details.

keepdims : bool, optional

If this is set to True, the axes which are reduced are left in the result as dimensions with size one. With this option, the result will broadcast correctly against the original arr .

m : ndarray, see dtype parameter above: If out=None , returns a new array containing the mean values, otherwise a reference to the output array is returned.

average : Weighted average std, var, nanmean, nanstd, nanvar

The arithmetic mean is the sum of the elements along the axis divided by the number of elements.

            >>> a = np.array([[1, 2], [3, 4]])
>>> np.mean(a)
2.5
>>> np.mean(a, axis=0)
array([ 2.,  3.])
>>> np.mean(a, axis=1)
array([ 1.5,  3.5])

           

In single precision, mean can be inaccurate:

            >>> a = np.zeros((2, 512*512), dtype=np.float32)
>>> a[0, :] = 1.0
>>> a[1, :] = 0.1
>>> np.mean(a)
0.546875

           

Computing the mean in float64 is more accurate:

            >>> np.mean(a, dtype=np.float64)
0.55000000074505806

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.element.collapse'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.element.collapse'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.element.collapse'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.element.collapse'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.element.collapse'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.element.collapse'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation.element. contours ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

Given a Image with a single channel, annotate it with contour lines for a given set of contour levels.

The return is an NdOverlay with a Contours layer for each given level, overlaid on top of the input Image.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Level, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group assigned to the output contours.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param ClassSelector levels ( allow_None=False, constant=False, default=10, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): A list of scalar values used to specify the contour levels.
param Boolean filled ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Whether to generate filled contours
param Boolean overlaid ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Whether to overlay the contour on the supplied Element.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.element.contours'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.element.contours'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.element.contours'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.element.contours'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

output_type ¶: alias of Overlay

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.element.contours'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.element.contours'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation.element. convolve ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

Apply a convolution to an overlay using the top layer as the kernel for convolving the bottom layer. Both Image elements in the input overlay should have a single value dimension.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Convolution, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group assigned to the convolved output.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param NumericTuple kernel_roi ( allow_None=False, constant=False, default=(0, 0, 0, 0), instantiate=False, length=4, pickle_default_value=True, precedence=None, readonly=False ): A 2-dimensional slice of the kernel layer to use in the convolution in lbrt (left, bottom, right, top) format. By default, no slicing is applied.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.element.convolve'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.element.convolve'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.element.convolve'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.element.convolve'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

output_type ¶: alias of Image

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.element.convolve'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.element.convolve'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation.element. decimate ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Operation, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group string used to identify the output of the Operation. By default this should match the operation name.
param Boolean dynamic ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Enables dynamic processing by default.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): By default, the link_inputs parameter is set to True so that when applying shade, backends that support linked streams update RangeXY streams on the inputs of the shade operation.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[<class ‘holoviews.streams.RangeXY’>], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param Integer max_samples ( allow_None=False, bounds=None, constant=False, default=5000, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Maximum number of samples to display at the same time.
param Integer random_seed ( allow_None=False, bounds=None, constant=False, default=42, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Seed used to initialize randomization.
param NumericTuple x_range ( allow_None=True, constant=False, default=None, instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False ): The x_range as a tuple of min and max x-value. Auto-ranges if set to None.
param NumericTuple y_range ( allow_None=True, constant=False, default=None, instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False ): The x_range as a tuple of min and max y-value. Auto-ranges if set to None.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.element.decimate'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.element.decimate'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.element.decimate'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.element.decimate'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.element.decimate'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.element.decimate'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation.element. factory ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

Simple operation that constructs any element that accepts some other element as input. For instance, RGB and HSV elements can be created from overlays of Image elements.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Operation, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group string used to identify the output of the Operation. By default this should match the operation name.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param Parameter output_type ( allow_None=False, constant=False, default=<class ‘holoviews.element.raster.RGB’>, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The output type of the factor operation. By default, if three overlaid Images elements are supplied, the corresponding RGB element will be returned.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.element.factory'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.element.factory'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.element.factory'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.element.factory'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

output_type ¶: alias of RGB

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.element.factory'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.element.factory'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation.element. gradient ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

Compute the gradient plot of the supplied Image.

If the Image value dimension is cyclic, the smallest step is taken considered the cyclic range

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Gradient, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group assigned to the output gradient matrix.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.element.gradient'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.element.gradient'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.element.gradient'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.element.gradient'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

output_type ¶: alias of Image

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.element.gradient'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.element.gradient'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation.element. gridmatrix ( **params ) [source] ¶

Bases: param.parameterized.ParameterizedFunction

The gridmatrix operation takes an Element or HoloMap of Elements as input and creates a GridMatrix object, which plots each dimension in the Element against each other dimension. This provides a very useful overview of high-dimensional data and is inspired by pandas and seaborn scatter_matrix implementations.

param Parameter chart_type ( allow_None=False, constant=False, default=<class ‘holoviews.element.chart.Scatter’>, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The Element type used to display bivariate distributions of the data.
param Parameter diagonal_type ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The Element type along the diagonal, may be a Histogram or any other plot type which can visualize a univariate distribution. This parameter overrides diagonal_operation.
param Parameter diagonal_operation ( allow_None=False, constant=False, default=<class ‘holoviews.operation.element.histogram’>, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The operation applied along the diagonal, may be a histogram-operation or any other function which returns a viewable element.
param List overlay_dims ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): If a HoloMap is supplied this will allow overlaying one or more of it’s key dimensions.

chart_type ¶: alias of Scatter

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

diagonal_operation ¶: alias of histogram

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.element.gridmatrix'>) ¶

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.element.gridmatrix'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.element.gridmatrix'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.element.gridmatrix'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.element.gridmatrix'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.element.gridmatrix'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation.element. histogram ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

Returns a Histogram of the input element data, binned into num_bins over the bin_range (if specified) along the specified dimension.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Operation, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group string used to identify the output of the Operation. By default this should match the operation name.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param NumericTuple bin_range ( allow_None=True, constant=False, default=None, instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False ): Specifies the range within which to compute the bins.
param String dimension ( allow_None=False, basestring=<class ‘str’>, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Along which dimension of the Element to compute the histogram.
param String frequency_label ( allow_None=False, basestring=<class ‘str’>, constant=False, default={dim} Frequency, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Format string defining the label of the frequency dimension of the Histogram.
param ClassSelector groupby ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Defines a dimension to group the Histogram returning an NdOverlay of Histograms.
param Boolean individually ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Specifies whether the histogram will be rescaled for each Element in a UniformNdMapping.
param Boolean log ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Whether to use base 10 logarithmic samples for the bin edges.
param Boolean mean_weighted ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Whether the weighted frequencies are averaged.
param ObjectSelector normed ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=True, instantiate=False, objects=[True, False, ‘integral’, ‘height’], pickle_default_value=True, precedence=None, readonly=False ): Controls normalization behavior. If True or ‘integral’ , then density=True is passed to np.histogram, and the distribution is normalized such that the integral is unity. If False , then the frequencies will be raw counts. If ‘height’ , then the frequencies are normalized such that the max bin height is unity.
param Boolean nonzero ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Whether to use only nonzero values when computing the histogram
param Integer num_bins ( allow_None=False, bounds=None, constant=False, default=20, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Number of bins in the histogram .
param String weight_dimension ( allow_None=False, basestring=<class ‘str’>, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Name of the dimension the weighting should be drawn from
param String style_prefix ( allow_None=None, basestring=<class ‘str’>, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Used for setting a common style for histograms in a HoloMap or AdjointLayout.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.element.histogram'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.element.histogram'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.element.histogram'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.element.histogram'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.element.histogram'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.element.histogram'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation.element. image_overlay ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

Operation to build a overlay of images to a specification from a subset of the required elements.

This is useful for reordering the elements of an overlay, duplicating layers of an overlay or creating blank image elements in the appropriate positions.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Transform, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group assigned to the resulting overlay.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param String spec ( allow_None=False, basestring=<class ‘str’>, constant=False, default=, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Specification of the output Overlay structure. For instance: Image.R * Image.G * Image.B Will ensure an overlay of this structure is created even if (for instance) only (Image.R * Image.B) is supplied. Elements in the input overlay that match are placed in the appropriate positions and unavailable specification elements are created with the specified fill group.

param Tuple default_range ( allow_None=False, constant=False, default=(0, 1), instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False ): The default range that will be set on the value_dimension of any automatically created blank image elements.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.element.image_overlay'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.element.image_overlay'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.element.image_overlay'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.element.image_overlay'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

output_type ¶: alias of Overlay

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.element.image_overlay'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.element.image_overlay'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation.element. interpolate_curve ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

Resamples a Curve using the defined interpolation method, e.g. to represent changes in y-values as steps.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Operation, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group string used to identify the output of the Operation. By default this should match the operation name.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param ObjectSelector interpolation ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=steps-mid, instantiate=False, objects=[‘steps-pre’, ‘steps-mid’, ‘steps-post’, ‘linear’], pickle_default_value=True, precedence=None, readonly=False ): Controls the transition point of the step along the x-axis.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.element.interpolate_curve'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.element.interpolate_curve'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.element.interpolate_curve'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.element.interpolate_curve'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.element.interpolate_curve'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.element.interpolate_curve'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation.element. operation ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

The most generic operation that wraps any callable into an Operation. The callable needs to accept an HoloViews component and a key (that may be ignored) and must return a new HoloViews component.

This class may be useful for turning a HoloViews method into an operation to define as compositor operation. For instance, the following definition:

operation.instance(op=lambda x, k: x.collapse(np.subtract))

Could be used to implement a collapse operation to subtracts the data between Rasters in an Overlay.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Operation, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group assigned to the result after having applied the operator.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param Parameter output_type ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The output element type which may be None to disable type checking. May be used to declare useful information to other code in HoloViews e.g required for tab-completion support of operations registered with compositors.
param Callable op ( allow_None=False, constant=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The operation used to generate a new HoloViews object returned by the operation. By default, the identity operation is applied.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.element.operation'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.element.operation'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.element.operation'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.element.operation'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.element.operation'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.element.operation'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation.element. threshold ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

Threshold a given Image whereby all values higher than a given level map to the specified high value and all values lower than that level map to the specified low value.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Threshold, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group assigned to the thresholded output.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param Number level ( allow_None=False, bounds=None, constant=False, default=0.5, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): The value at which the threshold is applied. Values lower than the threshold map to the ‘low’ value and values above map to the ‘high’ value.
param Number high ( allow_None=False, bounds=None, constant=False, default=1.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): The value given to elements greater than (or equal to) the threshold.
param Number low ( allow_None=False, bounds=None, constant=False, default=0.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): The value given to elements below the threshold.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.element.threshold'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.element.threshold'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.element.threshold'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.element.threshold'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

output_type ¶: alias of Image

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.element.threshold'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.element.threshold'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation.element. transform ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

This operator is extremely versatile; for instance, you could implement an alternative to the explicit threshold operator with:

operator=lambda x: np.clip(x, 0, 0.5)

Alternatively, you can implement a transform computing the 2D autocorrelation using the scipy library with:

operator=lambda x: scipy.signal.correlate2d(x, x)

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Transform, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group assigned to the result after applying the transform.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param Callable operator ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Function of one argument that transforms the data in the input Image to the data in the output Image. By default, acts as the identity function such that the output matches the input.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.element.transform'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.element.transform'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.element.transform'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.element.transform'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

output_type ¶: alias of Image

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.element.transform'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.element.transform'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

`normalization` Module ¶

Data normalization operations.

Normalizing input data into a valid range is a common operation and often required before further processing. The semantics of normalization are dependent on the element type being normalized making it difficult to provide a general and consistent interface.

The Normalization class is used to define such an interface and subclasses are used to implement the appropriate normalization operations per element type. Unlike display normalization, data normalizations result in transformations to the stored data within each element.

class holoviews.operation.normalization. Normalization ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

Base class for all normalization operation.

This class standardizes how normalization is specified using the ranges and keys parameter. The ranges parameter is designed to be very flexible, allowing a concise description for simple normalization while allowing complex key- and element- specific normalization to also be specified.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Operation, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group string used to identify the output of the Operation. By default this should match the operation name.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param Boolean data_range ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Whether normalization is allowed to use the minimum and maximum values of the existing data to infer an appropriate range
param ClassSelector ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): The simplest value of this parameter is None to skip all normalization. The next simplest value is an empty dictionary to only applies normalization to Dimensions with explicitly declared ranges. The next most common specification is a dictionary of values and tuple ranges. The value keys are the names of the dimensions to be normalized and the tuple ranges are of form (lower-bound, upper-bound). For instance, you could specify: {‘Height’:(0, 200), ‘z’:(0,1)} In this case, any element with a ‘Height’ or ‘z’ dimension (or both) will be normalized to the supplied ranges. Finally, element-specific normalization may also be specified by supplying a match tuple of form (<type>, <group>, <label>). A 1- or 2-tuple may be supplied by omitting the <group>, <label> or just the <label> components respectively. This tuple key then uses the dictionary value-range specification described above. For instance, you could normalize only the Image elements of group pattern using: {(‘Image’,’Pattern’):{‘Height’:(0, 200), ‘z’:(0,1)}}) Key-wise normalization is possible for all these formats by supplying a list of such dictionary specification that will then be zipped with the keys parameter (if specified).
param List keys ( allow_None=True, bounds=(0, None), constant=False, default=None, instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): If supplied, this list of keys is zipped with the supplied list of ranges. These keys are used to supply key specific normalization for HoloMaps containing matching key values, enabling per-element normalization.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.normalization.Normalization'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_ranges ( element , key ) [source] ¶: Method to get the appropriate normalization range dictionary given a key and element.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.normalization.Normalization'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.normalization.Normalization'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.normalization.Normalization'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.normalization.Normalization'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.normalization.Normalization'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation.normalization. raster_normalization ( **params ) [source] ¶

Bases: holoviews.operation.normalization.Normalization

Normalizes elements of type Raster.

For Raster elements containing (NxM) data, this will normalize the array/matrix into the specified range if value_dimension matches a key in the ranges dictionary.

For elements containing (NxMxD) data, the (NxM) components of the third dimensional are normalized independently if the corresponding value dimensions are selected by the ranges dictionary.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Operation, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group string used to identify the output of the Operation. By default this should match the operation name.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param Boolean data_range ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Whether normalization is allowed to use the minimum and maximum values of the existing data to infer an appropriate range
param ClassSelector ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): The simplest value of this parameter is None to skip all normalization. The next simplest value is an empty dictionary to only applies normalization to Dimensions with explicitly declared ranges. The next most common specification is a dictionary of values and tuple ranges. The value keys are the names of the dimensions to be normalized and the tuple ranges are of form (lower-bound, upper-bound). For instance, you could specify: {‘Height’:(0, 200), ‘z’:(0,1)} In this case, any element with a ‘Height’ or ‘z’ dimension (or both) will be normalized to the supplied ranges. Finally, element-specific normalization may also be specified by supplying a match tuple of form (<type>, <group>, <label>). A 1- or 2-tuple may be supplied by omitting the <group>, <label> or just the <label> components respectively. This tuple key then uses the dictionary value-range specification described above. For instance, you could normalize only the Image elements of group pattern using: {(‘Image’,’Pattern’):{‘Height’:(0, 200), ‘z’:(0,1)}}) Key-wise normalization is possible for all these formats by supplying a list of such dictionary specification that will then be zipped with the keys parameter (if specified).
param List keys ( allow_None=True, bounds=(0, None), constant=False, default=None, instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): If supplied, this list of keys is zipped with the supplied list of ranges. These keys are used to supply key specific normalization for HoloMaps containing matching key values, enabling per-element normalization.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.normalization.raster_normalization'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_ranges ( element , key ) ¶: Method to get the appropriate normalization range dictionary given a key and element.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.normalization.raster_normalization'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.normalization.raster_normalization'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.normalization.raster_normalization'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.normalization.raster_normalization'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.normalization.raster_normalization'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

`stats` Module ¶

class holoviews.operation.stats. bivariate_kde ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

Computes a 2D kernel density estimate (KDE) of the first two dimensions in the input data. Kernel density estimation is a non-parametric way to estimate the probability density function of a random variable.

The KDE works by placing 2D Gaussian kernel at each sample with the supplied bandwidth. These kernels are then summed to produce the density estimate. By default a good bandwidth is determined using the bw_method but it may be overridden by an explicit value.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Operation, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group string used to identify the output of the Operation. By default this should match the operation name.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param Boolean contours ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Whether to compute contours from the KDE, determines whether to return an Image or Contours/Polygons.
param ObjectSelector bw_method ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=scott, instantiate=False, objects=[‘scott’, ‘silverman’], pickle_default_value=True, precedence=None, readonly=False ): Method of automatically determining KDE bandwidth
param Number bandwidth ( allow_None=True, bounds=None, constant=False, default=None, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Allows supplying explicit bandwidth value rather than relying on scott or silverman method.
param Number cut ( allow_None=False, bounds=None, constant=False, default=3, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Draw the estimate to cut * bw from the extreme data points.
param Boolean filled ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Controls whether to return filled or unfilled contours.
param Integer n_samples ( allow_None=False, bounds=None, constant=False, default=100, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Number of samples to compute the KDE over.
param NumericTuple x_range ( allow_None=True, constant=False, default=None, instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False ): The x_range as a tuple of min and max x-value. Auto-ranges if set to None.
param NumericTuple y_range ( allow_None=True, constant=False, default=None, instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False ): The x_range as a tuple of min and max y-value. Auto-ranges if set to None.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.stats.bivariate_kde'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.stats.bivariate_kde'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.stats.bivariate_kde'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.stats.bivariate_kde'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.stats.bivariate_kde'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.stats.bivariate_kde'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation.stats. univariate_kde ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

Computes a 1D kernel density estimate (KDE) along the supplied dimension. Kernel density estimation is a non-parametric way to estimate the probability density function of a random variable.

The KDE works by placing a Gaussian kernel at each sample with the supplied bandwidth. These kernels are then summed to produce the density estimate. By default a good bandwidth is determined using the bw_method but it may be overridden by an explicit value.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Operation, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group string used to identify the output of the Operation. By default this should match the operation name.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param ObjectSelector bw_method ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=scott, instantiate=False, objects=[‘scott’, ‘silverman’], pickle_default_value=True, precedence=None, readonly=False ): Method of automatically determining KDE bandwidth
param Number bandwidth ( allow_None=True, bounds=None, constant=False, default=None, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Allows supplying explicit bandwidth value rather than relying on scott or silverman method.
param Number cut ( allow_None=False, bounds=None, constant=False, default=3, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Draw the estimate to cut * bw from the extreme data points.
param NumericTuple bin_range ( allow_None=True, constant=False, default=None, instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False ): Specifies the range within which to compute the KDE.
param String dimension ( allow_None=False, basestring=<class ‘str’>, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Along which dimension of the Element to compute the KDE.
param Boolean filled ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Controls whether to return filled or unfilled KDE.
param Integer n_samples ( allow_None=False, bounds=None, constant=False, default=100, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Number of samples to compute the KDE over.
param ClassSelector groupby ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Defines a dimension to group the Histogram returning an NdOverlay of Histograms.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.stats.univariate_kde'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.stats.univariate_kde'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.stats.univariate_kde'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.stats.univariate_kde'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.stats.univariate_kde'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.stats.univariate_kde'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

`timeseries` Module ¶

class holoviews.operation.timeseries. RollingBase ( **params ) [source] ¶

Bases: param.parameterized.Parameterized

Parameters shared between rolling and rolling_outlier_std .

param Boolean center ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Whether to set the x-coordinate at the center or right edge of the window.
param Integer min_periods ( allow_None=True, bounds=None, constant=False, default=None, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Minimum number of observations in window required to have a value (otherwise result is NaN).
param Integer rolling_window ( allow_None=False, bounds=None, constant=False, default=10, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): The window size over which to operate.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.timeseries.RollingBase'>) ¶

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.timeseries.RollingBase'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.timeseries.RollingBase'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix=' ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: (Experimental) Pretty printed representation that may be evaluated with eval. See pprint() function for more details.

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

script_repr ( imports=[] , prefix=' ' ) ¶: Variant of __repr__ designed for generating a runnable script.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.timeseries.RollingBase'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.timeseries.RollingBase'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation.timeseries. resample ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation

Resamples a timeseries of dates with a frequency and function.

param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Operation, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group string used to identify the output of the Operation. By default this should match the operation name.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param ObjectSelector closed ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=None, instantiate=False, objects=[‘left’, ‘right’], pickle_default_value=True, precedence=None, readonly=False ): Which side of bin interval is closed
param Callable function ( allow_None=False, constant=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Function for computing new values out of existing ones.
param ObjectSelector label ( allow_None=None, check_on_set=False, compute_default_fn=None, constant=False, default=right, instantiate=False, objects=[], pickle_default_value=True, precedence=None, readonly=False ): The bin edge to label the bin with.
param String rule ( allow_None=False, basestring=<class ‘str’>, constant=False, default=D, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): A string representing the time interval over which to apply the resampling

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.timeseries.resample'>) ¶

function ( a , axis=None , dtype=None , out=None , keepdims=<class 'numpy._globals._NoValue'> ) ¶

Compute the arithmetic mean along the specified axis.

a : array_like

Array containing numbers whose mean is desired. If a is not an array, a conversion is attempted.

axis : None or int or tuple of ints, optional

Axis or axes along which the means are computed. The default is to compute the mean of the flattened array.

If this is a tuple of ints, a mean is performed over multiple axes, instead of a single axis or all the axes as before.

dtype : data-type, optional

Type to use in computing the mean. For integer inputs, the default is float64 ; for floating point inputs, it is the same as the input dtype.

out : ndarray, optional

Alternate output array in which to place the result. The default is


             
              None

; if provided, it must have the same shape as the expected output, but the type will be cast if necessary. See doc.ufuncs for details.

keepdims : bool, optional

If this is set to True, the axes which are reduced are left in the result as dimensions with size one. With this option, the result will broadcast correctly against the original arr .

m : ndarray, see dtype parameter above: If out=None , returns a new array containing the mean values, otherwise a reference to the output array is returned.

average : Weighted average std, var, nanmean, nanstd, nanvar

The arithmetic mean is the sum of the elements along the axis divided by the number of elements.

            >>> a = np.array([[1, 2], [3, 4]])
>>> np.mean(a)
2.5
>>> np.mean(a, axis=0)
array([ 2.,  3.])
>>> np.mean(a, axis=1)
array([ 1.5,  3.5])

           

In single precision, mean can be inaccurate:

            >>> a = np.zeros((2, 512*512), dtype=np.float32)
>>> a[0, :] = 1.0
>>> a[1, :] = 0.1
>>> np.mean(a)
0.546875

           

Computing the mean in float64 is more accurate:

            >>> np.mean(a, dtype=np.float64)
0.55000000074505806

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.timeseries.resample'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.timeseries.resample'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.timeseries.resample'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.timeseries.resample'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.timeseries.resample'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation.timeseries. rolling ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation , holoviews.operation.timeseries.RollingBase

Applies a function over a rolling window.

param Boolean center ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Whether to set the x-coordinate at the center or right edge of the window.
param Integer min_periods ( allow_None=True, bounds=None, constant=False, default=None, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Minimum number of observations in window required to have a value (otherwise result is NaN).
param Integer rolling_window ( allow_None=False, bounds=None, constant=False, default=10, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): The window size over which to operate.
param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Operation, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group string used to identify the output of the Operation. By default this should match the operation name.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param ObjectSelector window_type ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=None, instantiate=False, objects=[‘boxcar’, ‘triang’, ‘blackman’, ‘hamming’, ‘bartlett’, ‘parzen’, ‘bohman’, ‘blackmanharris’, ‘nuttall’, ‘barthann’, ‘kaiser’, ‘gaussian’, ‘general_gaussian’, ‘slepian’], pickle_default_value=True, precedence=None, readonly=False ): The shape of the window to apply
param Callable function ( allow_None=False, constant=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The function to apply over the rolling window.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.timeseries.rolling'>) ¶

function ( a , axis=None , dtype=None , out=None , keepdims=<class 'numpy._globals._NoValue'> ) ¶

Compute the arithmetic mean along the specified axis.

a : array_like

Array containing numbers whose mean is desired. If a is not an array, a conversion is attempted.

axis : None or int or tuple of ints, optional

Axis or axes along which the means are computed. The default is to compute the mean of the flattened array.

If this is a tuple of ints, a mean is performed over multiple axes, instead of a single axis or all the axes as before.

dtype : data-type, optional

Type to use in computing the mean. For integer inputs, the default is float64 ; for floating point inputs, it is the same as the input dtype.

out : ndarray, optional

Alternate output array in which to place the result. The default is


             
              None

; if provided, it must have the same shape as the expected output, but the type will be cast if necessary. See doc.ufuncs for details.

keepdims : bool, optional

If this is set to True, the axes which are reduced are left in the result as dimensions with size one. With this option, the result will broadcast correctly against the original arr .

m : ndarray, see dtype parameter above: If out=None , returns a new array containing the mean values, otherwise a reference to the output array is returned.

average : Weighted average std, var, nanmean, nanstd, nanvar

The arithmetic mean is the sum of the elements along the axis divided by the number of elements.

            >>> a = np.array([[1, 2], [3, 4]])
>>> np.mean(a)
2.5
>>> np.mean(a, axis=0)
array([ 2.,  3.])
>>> np.mean(a, axis=1)
array([ 1.5,  3.5])

           

In single precision, mean can be inaccurate:

            >>> a = np.zeros((2, 512*512), dtype=np.float32)
>>> a[0, :] = 1.0
>>> a[1, :] = 0.1
>>> np.mean(a)
0.546875

           

Computing the mean in float64 is more accurate:

            >>> np.mean(a, dtype=np.float64)
0.55000000074505806

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.timeseries.rolling'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.timeseries.rolling'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.timeseries.rolling'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.timeseries.rolling'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.timeseries.rolling'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.operation.timeseries. rolling_outlier_std ( **params ) [source] ¶

Bases: holoviews.core.operation.Operation , holoviews.operation.timeseries.RollingBase

Detect outliers using the standard deviation within a rolling window.

Outliers are the array elements outside sigma standard deviations from the smoothed trend line, as calculated from the trend line residuals.

The rolling window is controlled by parameters shared with the rolling operation via the base class RollingBase, to make it simpler to use the same settings for both.

param Boolean center ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): Whether to set the x-coordinate at the center or right edge of the window.
param Integer min_periods ( allow_None=True, bounds=None, constant=False, default=None, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Minimum number of observations in window required to have a value (otherwise result is NaN).
param Integer rolling_window ( allow_None=False, bounds=None, constant=False, default=10, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): The window size over which to operate.
param String group ( allow_None=False, basestring=<class ‘str’>, constant=False, default=Operation, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): The group string used to identify the output of the Operation. By default this should match the operation name.
param ObjectSelector dynamic ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=default, instantiate=False, objects=[‘default’, True, False], pickle_default_value=True, precedence=None, readonly=False ): Whether the operation should be applied dynamically when a specific frame is requested, specified as a Boolean. If set to ‘default’ the mode will be determined based on the input type, i.e. if the data is a DynamicMap it will stay dynamic.
param ClassSelector input_ranges ( allow_None=True, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False ): Ranges to be used for input normalization (if applicable) in a format appropriate for the Normalization.ranges parameter. By default, no normalization is applied. If key-wise normalization is required, a 2-tuple may be supplied where the first component is a Normalization.ranges list and the second component is Normalization.keys.
param Boolean link_inputs ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False ): If the operation is dynamic, whether or not linked streams should be transferred from the operation inputs for backends that support linked streams. For example if an operation is applied to a DynamicMap with an RangeXY, this switch determines whether the corresponding visualization should update this stream with range changes originating from the newly generated axes.
param List streams ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False ): List of streams that are applied if dynamic=True, allowing for dynamic interaction with the plot.
param Number sigma ( allow_None=False, bounds=None, constant=False, default=2.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> ): Minimum sigma before a value is considered an outlier.

debug ( msg , *args , **kw ) ¶

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( ) ¶

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = functools.partial(<function Parameterized.force_new_dynamic_value>, <class 'holoviews.operation.timeseries.rolling_outlier_std'>) ¶

get_overlay_bounds ( overlay ) ¶: Returns the extents if all the elements of an overlay agree on a consistent extents, otherwise raises an exception.

get_overlay_label ( overlay , default_label='' ) ¶: Returns a label if all the elements of an overlay agree on a consistent label, otherwise returns the default label.

get_param_values ( onlychanged=False ) ¶

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = functools.partial(<function Parameterized.get_value_generator>, <class 'holoviews.operation.timeseries.rolling_outlier_std'>) ¶

inspect_value = functools.partial(<function Parameterized.inspect_value>, <class 'holoviews.operation.timeseries.rolling_outlier_std'>) ¶

instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.operation.timeseries.rolling_outlier_std'>) ¶

message ( msg , *args , **kw ) ¶

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None ) ¶

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix='\n ' , unknown_value='<?>' , qualify=False , separator='' ) ¶: Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

print_param_defaults ( ) ¶: Print the default values of all cls’s Parameters.

print_param_values ( ) ¶: Print the values of all this object’s Parameters.

process_element ( element , key , **params ) ¶: The process_element method allows a single element to be operated on given an externally supplied key.

script_repr ( imports=[] , prefix=' ' ) ¶: Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

search ( element , pattern ) ¶

Helper method that returns a list of elements that match the given path pattern of form {type}.{group}.{label}.

The input may be a Layout, an Overlay type or a single Element.

set_default ( param_name , value ) ¶

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = functools.partial(<function Parameterized.set_dynamic_time_fn>, <class 'holoviews.operation.timeseries.rolling_outlier_std'>) ¶

set_param = functools.partial(<function Parameterized.set_param>, <class 'holoviews.operation.timeseries.rolling_outlier_std'>) ¶

state_pop ( ) ¶

Restore the most recently saved state.

See state_push() for more details.

state_push ( ) ¶

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

verbose ( msg , *args , **kw ) ¶

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw ) ¶

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

holoviews.operation Package ¶

operation Package ¶

datashader Module ¶

element Module ¶

normalization Module ¶

stats Module ¶

timeseries Module ¶

`operation` Package ¶

`datashader` Module ¶

`element` Module ¶

`normalization` Module ¶

`stats` Module ¶

`timeseries` Module ¶