fiftyone.operators.registry

FiftyOne operator registry.

Copyright 2017-2024, Voxel51, Inc.

voxel51.com

Functions:

get_operator(operator_uri[, enabled])	Gets the operator with the given URI.
list_operators([enabled, type])	Returns all available operators.
operator_exists(operator_uri[, enabled])	Checks if the given operator exists.

Classes:

OperatorRegistry([enabled])

Operator registry.

fiftyone.operators.registry.get_operator(operator_uri, enabled=True)

Gets the operator with the given URI.

Parameters

• operator_uri – the operator URI

• enabled (True) – whether to include only enabled operators (True) or only disabled operators (False) or all operators (“all”)

Returns

an fiftyone.operators.Operator

Raises

ValueError – if the operator is not found

fiftyone.operators.registry.list_operators(enabled=True, type=None)

Returns all available operators.

Parameters

• enabled (True) – whether to include only enabled operators (True) or only disabled operators (False) or all operators (“all”)

• type (None) – whether to include only "panel" or "operator" type operators

Returns

a list of fiftyone.operators.Operator instances

fiftyone.operators.registry.operator_exists(operator_uri, enabled=True)

Checks if the given operator exists.

Parameters

• operator_uri – the operator URI

• enabled (True) – whether to include only enabled operators (True) or only disabled operators (False) or all operators (“all”)

Returns

True/False

class fiftyone.operators.registry.OperatorRegistry(enabled=True)

Bases: object

Operator registry.

enabled (True): whether to include only enabled operators (True) or

only disabled operators (False) or all operators (“all”)

Methods:

list_operators([include_builtin, type])	Lists the available FiftyOne operators.
list_errors()	Lists the errors that occurred during operator loading.
operator_exists(operator_uri)	Checks if the operator exists.
can_execute(operator_uri)	Whether the operator can be executed.
get_operator(operator_uri)	Retrieves an operator by its URI.

list_operators(include_builtin=True, type=None)

Lists the available FiftyOne operators.

Parameters

• include_builtin (True) – whether to include builtin operators

• type (None) – whether to include only "panel" or "operator" type operators

Returns

a list of fiftyone.operators.Operator instances

list_errors()

Lists the errors that occurred during operator loading.

Returns

a list of errors

operator_exists(operator_uri)

Checks if the operator exists.

Parameters

operator_uri – the URI of the operator

Returns

True/False

can_execute(operator_uri)

Whether the operator can be executed.

Parameters

operator_uri – the URI of the operator

Returns

True/False

get_operator(operator_uri)

Retrieves an operator by its URI.

Parameters

operator_uri – the URI of an operator

Returns

an fiftyone.operators.Operator, or None