Functions¶

	`buffer_param_spec` (name, nick, blurb, default_value, flags)
	`copyable_copy` (origin, copy)
	`op_POSC` (arg, out, resources, command_queue)
	`op_add` (arg1, arg2, out, resources, command_queue)
	`op_add2` (arg1, arg2, modifier, out, resources, command_queue)
	`op_deduction` (arg1, arg2, out, resources, command_queue)
	`op_deduction2` (arg1, arg2, modifier, out, resources, command_queue)
	`op_euclidean_distance` (arg1, arg2, resources, command_queue)
	`op_gradient_descent` (arg, out, resources, command_queue)
	`op_gradient_directions` (arg, magnitudes, out, resources, command_queue)
	`op_gradient_magnitudes` (arg, out, resources, command_queue)
	`op_inv` (arg, resources, command_queue)
	`op_l1_norm` (arg, resources, command_queue)
	`op_l2_norm` (arg, resources, command_queue)
	`op_mul` (arg1, arg2, out, resources, command_queue)
	`op_mul_rows` (arg1, arg2, out, offset, n, resources, command_queue)
	`op_set` (arg, value, resources, command_queue)
	`plugin_get_all_plugin_names` (manager, filename_regex, filename_pattern)
	`task_error_quark` ()

Details¶

Ufo.buffer_param_spec(name, nick, blurb, default_value, flags)¶

Parameters:

name (str) – canonical name of the property specified
nick (str) – nick name for the property specified
blurb (str) – description of the property specified
default_value (Ufo.Buffer) – default value for the property specified
flags (GObject.ParamFlags) – flags for the property specified

Returns:

a newly created parameter specification

see g_param_spec_internal() for details on property names.

Return type:

GObject.ParamSpec

Creates a new Ufo.BufferParamSpec instance specifying a #UFO_TYPE_BUFFER property.

Ufo.copyable_copy(origin, copy)¶

Parameters:

origin (object or None) – A source object that implements Ufo.Copyable interface.
copy (object or None) – A destination object that implements Ufo.Copyable interface.

Returns:

A copy of the origin object.

Return type:

Ufo.Copyable

Ufo.op_POSC(arg, out, resources, command_queue)¶

Parameters:

arg (Ufo.Buffer) – A Ufo.Buffer
out (Ufo.Buffer) – A Ufo.Buffer
resources (Ufo.Resources) – Ufo.Resources object
command_queue (object or None) – A valid cl_command_queue

Returns:

Event of the POSC operation

Return type:

object or None

Ufo.op_add(arg1, arg2, out, resources, command_queue)¶

Parameters:

arg1 (Ufo.Buffer) – A Ufo.Buffer
arg2 (Ufo.Buffer) – A Ufo.Buffer
out (Ufo.Buffer) – A Ufo.Buffer
resources (Ufo.Resources) – Ufo.Resources object
command_queue (object or None) – A valid cl_command_queue

Returns:

Event of the add operation

Return type:

object or None

out = arg1 + arg2

Ufo.op_add2(arg1, arg2, modifier, out, resources, command_queue)¶

Parameters:

arg1 (Ufo.Buffer) – A Ufo.Buffer
arg2 (Ufo.Buffer) – A Ufo.Buffer
modifier (float) – Scalar value
out (Ufo.Buffer) – A Ufo.Buffer
resources (Ufo.Resources) – Ufo.Resources object
command_queue (object or None) – A valid cl_command_queue

Returns:

Event of the add operation

Return type:

object or None

out = arg1 + modifier * arg2

Ufo.op_deduction(arg1, arg2, out, resources, command_queue)¶

Parameters:

arg1 (Ufo.Buffer) – A Ufo.Buffer
arg2 (Ufo.Buffer) – A Ufo.Buffer
out (Ufo.Buffer) – A Ufo.Buffer
resources (Ufo.Resources) – Ufo.Resources object
command_queue (object or None) – A valid cl_command_queue

Returns:

Event of the add operation

Return type:

object or None

out = arg1 - arg2

Ufo.op_deduction2(arg1, arg2, modifier, out, resources, command_queue)¶

Parameters:

arg1 (Ufo.Buffer) – A Ufo.Buffer
arg2 (Ufo.Buffer) – A Ufo.Buffer
modifier (float) – Scalar value
out (Ufo.Buffer) – A Ufo.Buffer
resources (Ufo.Resources) – Ufo.Resources object
command_queue (object or None) – A valid cl_command_queue

Returns:

Event of the add operation

Return type:

object or None

out = arg1 - modifier * arg2

Ufo.op_euclidean_distance(arg1, arg2, resources, command_queue)¶

Parameters:

arg1 (Ufo.Buffer) – A Ufo.Buffer
arg2 (Ufo.Buffer) – A Ufo.Buffer
resources (Ufo.Resources) – Ufo.Resources object
command_queue (object or None) – A valid cl_command_queue

Returns:

Euclidean distance between arg1 and arg2.

Return type:

float

Ufo.op_gradient_descent(arg, out, resources, command_queue)¶

Parameters:

arg (Ufo.Buffer) – A Ufo.Buffer
out (Ufo.Buffer) – A Ufo.Buffer
resources (Ufo.Resources) – Ufo.Resources object
command_queue (object or None) – A valid cl_command_queue

Returns:

Event of the POSC operation

Return type:

object or None

Ufo.op_gradient_directions(arg, magnitudes, out, resources, command_queue)¶

Parameters:

arg (Ufo.Buffer) – A Ufo.Buffer
magnitudes (Ufo.Buffer) – A Ufo.Buffer
out (Ufo.Buffer) – A Ufo.Buffer
resources (Ufo.Resources) – Ufo.Resources object
command_queue (object or None) – A valid cl_command_queue

Returns:

Event of the add operation

Return type:

object or None

Compute magnitude of gradients

Ufo.op_gradient_magnitudes(arg, out, resources, command_queue)¶

Parameters:

arg (Ufo.Buffer) – A Ufo.Buffer
out (Ufo.Buffer) – A Ufo.Buffer
resources (Ufo.Resources) – Ufo.Resources object
command_queue (object or None) – A valid cl_command_queue

Returns:

Event of the add operation

Return type:

object or None

Compute magnitude of gradients

Ufo.op_inv(arg, resources, command_queue)¶

Parameters:

arg (Ufo.Buffer) – A Ufo.Buffer
resources (Ufo.Resources) – Ufo.Resources object
command_queue (object or None) – A valid cl_command_queue

Returns:

Event of the invert operation

Return type:

object or None

Invert arg.

Ufo.op_l1_norm(arg, resources, command_queue)¶

Parameters:

arg (Ufo.Buffer) – A Ufo.Buffer
resources (Ufo.Resources) – Ufo.Resources object
command_queue (object or None) – A valid cl_command_queue

Returns:

L1 norm.

Return type:

float

Ufo.op_l2_norm(arg, resources, command_queue)¶

Parameters:

arg (Ufo.Buffer) – A Ufo.Buffer
resources (Ufo.Resources) – Ufo.Resources object
command_queue (object or None) – A valid cl_command_queue

Returns:

L2 norm.

Return type:

float

Ufo.op_mul(arg1, arg2, out, resources, command_queue)¶

Parameters:

arg1 (Ufo.Buffer) – A Ufo.Buffer
arg2 (Ufo.Buffer) – A Ufo.Buffer
out (Ufo.Buffer) – A Ufo.Buffer
resources (Ufo.Resources) – Ufo.Resources object
command_queue (object or None) – A valid cl_command_queue

Returns:

Event of the mul operation

Return type:

object or None

out = arg1 * arg2

Ufo.op_mul_rows(arg1, arg2, out, offset, n, resources, command_queue)¶

Parameters:

arg1 (Ufo.Buffer) – A Ufo.Buffer
arg2 (Ufo.Buffer) – A Ufo.Buffer
out (Ufo.Buffer) – A Ufo.Buffer
offset (int) – Offset
n (int) – n ?
resources (Ufo.Resources) – Ufo.Resources object
command_queue (object or None) – A valid cl_command_queue

Returns:

Event of the add operation

Return type:

object or None

out = arg1 - modifier * arg2

Ufo.op_set(arg, value, resources, command_queue)¶

Parameters:

arg (Ufo.Buffer) – A Ufo.Buffer
value (float) – Value to fill arg with
resources (Ufo.Resources) – Ufo.Resources object
command_queue (object or None) – A valid cl_command_queue

Returns:

Event of the set operation

Return type:

object or None

Fill a buffer with a value using OpenCL.

Ufo.plugin_get_all_plugin_names(manager, filename_regex, filename_pattern)¶

Parameters:

manager (Ufo.PluginManager) – A Ufo.PluginManager
filename_regex (GLib.Regex) – Regex for filenames
filename_pattern (str) – Pattern according with the files will be searched

Returns:

List of strings with filter names

Return type:

[str]

Return a list with potential plugin names that match shared objects in all search paths.

Ufo.task_error_quark()¶

Return type:: int