Skip to main content
Ctrl+K
ewoksid16a 0.2.0
  • API documentation
  • GitLab
  • pypi
  • API documentation
  • GitLab
  • pypi

Section Navigation

  • ewoksid16a
    • ewoksid16a.tasks
      • ewoksid16a.tasks.common
        • ewoksid16a.tasks.common.dataportal
        • ewoksid16a.tasks.common.masterfile
        • ewoksid16a.tasks.common.utils
      • ewoksid16a.tasks.fluo
        • ewoksid16a.tasks.fluo.fitreport
        • ewoksid16a.tasks.fluo.fscan_regrid
        • ewoksid16a.tasks.fluo.helpers
        • ewoksid16a.tasks.fluo.norm_it
        • ewoksid16a.tasks.fluo.patch_config
        • ewoksid16a.tasks.fluo.spectral_regrid
        • ewoksid16a.tasks.fluo.strip_background
        • ewoksid16a.tasks.fluo.sumspectrumfit
        • ewoksid16a.tasks.fluo.weight
      • ewoksid16a.tasks.fluotomo
        • ewoksid16a.tasks.fluotomo.gallery
        • ewoksid16a.tasks.fluotomo.nxtomo
        • ewoksid16a.tasks.fluotomo.nxtomo_sinogram
      • ewoksid16a.tasks.tomo
        • ewoksid16a.tasks.tomo.extract_randdisp
        • ewoksid16a.tasks.tomo.nxtomo
    • ewoksid16a.tests
      • ewoksid16a.tests.test_dummy
        • ewoksid16a.tests.test_dummy.test_todo
  • API documentation
  • ewoksid16a
  • ewoksid16a.tasks
  • ewoksid16a.tasks.fluotomo
  • ewoksid16a.tasks.fluotomo.gallery
  • ewoksid16a.tasks.fluotomo.gallery.AnimatedWebP

ewoksid16a.tasks.fluotomo.gallery.AnimatedWebP#

class ewoksid16a.tasks.fluotomo.gallery.AnimatedWebP(inputs=None, varinfo=None, node_id=None, node_attrs=None, execinfo=None, profile_directory=None)[source]#

Bases: Task

Export an animated WebP file from a nx-fluotomo

Parameters:
  • inputs (Optional[Mapping])

  • varinfo (Optional[dict])

  • node_id (Union[str, int, tuple, None])

  • node_attrs (Optional[dict])

  • execinfo (Optional[dict])

  • profile_directory (Optional[dict])

MISSING_DATA = <MISSING_DATA>#
assert_ready_to_execute()#
bin_stack(img, bin_y=2, bin_x=2)[source]#
cancel()#

Function called when a task is cancelled. To be implemented by the derived classes

property cancelled: bool#

Return True if the task has been cancelled by the user

classmethod class_nonce()#
classmethod class_nonce_data()#
classmethod class_registry_name()#
Return type:

Optional[str]

cleanup_references()#

Removes all references to the inputs. Side effect: fixes the uhash of the task and outputs

property done: bool#

Completed (with or without exception)

property exception: Exception | None#
execute(force_rerun=False, raise_on_error=True, cleanup_references=False)#
Parameters:
  • force_rerun (Optional[bool])

  • raise_on_error (Optional[bool])

  • cleanup_references (Optional[bool])

property failed: bool#

Completed with exception

fix_uhash()#

Fix the uhash when it is derived from the uhash data.

get_input_uhashes()#
get_input_value(key, default=<MISSING_DATA>)#
Parameters:

default (Any)

Return type:

Any

get_input_values()#
get_named_input_values()#
get_output_transfer_data()#

The values are either DataUri or Variable

get_output_uhashes()#
get_output_value(key, default=<MISSING_DATA>)#
Parameters:

default (Any)

Return type:

Any

get_output_values()#
get_positional_input_values()#
classmethod get_subclass(registry_name, _second_attempt=False)#

Retrieving a derived class

classmethod get_subclass_names()#
Return type:

List[str]

classmethod get_subclasses()#
get_uhash_init(serialize=False)#
classmethod input_model()#
Return type:

Optional[Type[BaseInputModel]]

classmethod input_names()#
Return type:

Set[str]

property input_uhashes#
property input_values#

DEPRECATED

property input_variables: VariableContainer#
property inputs: ReadOnlyVariableContainerNamespace#
instance_nonce()#
classmethod instantiate(registry_name, **kw)#

Factory method for instantiating a derived class.

Parameters:
  • registry_name (str) – for example “tasklib.tasks.MyTask” or “MyTask”

  • **kw – Task constructor arguments

Returns Task:

property is_ready_to_execute#
property job_id: str | None#
property label: str#
property missing_inputs: VariableContainerMissingNamespace#
property missing_outputs: VariableContainerMissingNamespace#
property n_positional_inputs: int#
classmethod n_required_positional_inputs()#
Return type:

int

property named_input_values#

DEPRECATED

property node_id: str | int | tuple#
property npositional_inputs#

DEPRECATED

classmethod optional_input_names()#
Return type:

Set[str]

property output_metadata: dict | None#
classmethod output_model()#
Return type:

Optional[Type[BaseOutputModel]]

classmethod output_names()#
Return type:

Set[str]

property output_transfer_data#

DEPRECATED

property output_uhashes#

DEPRECATED

property output_values#

DEPRECATED

property output_variables: VariableContainer#
property outputs: VariableContainerNamespace#
property positional_input_values#

DEPRECATED

classmethod required_input_names()#
Return type:

Set[str]

reset_state()#
run()[source]#

To be implemented by the derived classes

set_uhash_init(pre_uhash=None, instance_nonce=None)#
Parameters:
  • pre_uhash (Union[str, bytes, UniversalHash, HasUhash, None])

  • instance_nonce (Optional[Any])

property succeeded: bool#

Completed without exception and with output values

property task_identifier: str#
property uhash: UniversalHash | None#
uhash_randomize()#
undo_fix_uhash()#
undo_randomize()#
property workflow_id: str | None#

previous

ewoksid16a.tasks.fluotomo.gallery

next

ewoksid16a.tasks.fluotomo.nxtomo

On this page
  • AnimatedWebP
    • AnimatedWebP.MISSING_DATA
    • AnimatedWebP.assert_ready_to_execute()
    • AnimatedWebP.bin_stack()
    • AnimatedWebP.cancel()
    • AnimatedWebP.cancelled
    • AnimatedWebP.class_nonce()
    • AnimatedWebP.class_nonce_data()
    • AnimatedWebP.class_registry_name()
    • AnimatedWebP.cleanup_references()
    • AnimatedWebP.done
    • AnimatedWebP.exception
    • AnimatedWebP.execute()
    • AnimatedWebP.failed
    • AnimatedWebP.fix_uhash()
    • AnimatedWebP.get_input_uhashes()
    • AnimatedWebP.get_input_value()
    • AnimatedWebP.get_input_values()
    • AnimatedWebP.get_named_input_values()
    • AnimatedWebP.get_output_transfer_data()
    • AnimatedWebP.get_output_uhashes()
    • AnimatedWebP.get_output_value()
    • AnimatedWebP.get_output_values()
    • AnimatedWebP.get_positional_input_values()
    • AnimatedWebP.get_subclass()
    • AnimatedWebP.get_subclass_names()
    • AnimatedWebP.get_subclasses()
    • AnimatedWebP.get_uhash_init()
    • AnimatedWebP.input_model()
    • AnimatedWebP.input_names()
    • AnimatedWebP.input_uhashes
    • AnimatedWebP.input_values
    • AnimatedWebP.input_variables
    • AnimatedWebP.inputs
    • AnimatedWebP.instance_nonce()
    • AnimatedWebP.instantiate()
    • AnimatedWebP.is_ready_to_execute
    • AnimatedWebP.job_id
    • AnimatedWebP.label
    • AnimatedWebP.missing_inputs
    • AnimatedWebP.missing_outputs
    • AnimatedWebP.n_positional_inputs
    • AnimatedWebP.n_required_positional_inputs()
    • AnimatedWebP.named_input_values
    • AnimatedWebP.node_id
    • AnimatedWebP.npositional_inputs
    • AnimatedWebP.optional_input_names()
    • AnimatedWebP.output_metadata
    • AnimatedWebP.output_model()
    • AnimatedWebP.output_names()
    • AnimatedWebP.output_transfer_data
    • AnimatedWebP.output_uhashes
    • AnimatedWebP.output_values
    • AnimatedWebP.output_variables
    • AnimatedWebP.outputs
    • AnimatedWebP.positional_input_values
    • AnimatedWebP.required_input_names()
    • AnimatedWebP.reset_state()
    • AnimatedWebP.run()
    • AnimatedWebP.set_uhash_init()
    • AnimatedWebP.succeeded
    • AnimatedWebP.task_identifier
    • AnimatedWebP.uhash
    • AnimatedWebP.uhash_randomize()
    • AnimatedWebP.undo_fix_uhash()
    • AnimatedWebP.undo_randomize()
    • AnimatedWebP.workflow_id

This Page

  • Show Source

© Copyright 2021-2025, ESRF.

ewoksid16a