camacq.plugins package

Handle plugins.

camacq.plugins.get_plugins()

Return a dict of plugin modules.

async camacq.plugins.setup_module(center, config)

Set up the plugins package.

Parameters:

• center (Center instance) – The Center instance.

• config (dict) – The config dict.

Subpackages

• camacq.plugins.api package
  • Api
    • Api.name
    • Api.send()
    • Api.send_many()
    • Api.start_imaging()
    • Api.stop_imaging()
  • CommandEvent
    • CommandEvent.command
    • CommandEvent.data
    • CommandEvent.event_type
  • ImageEvent
    • ImageEvent.channel_id
    • ImageEvent.data
    • ImageEvent.event_type
    • ImageEvent.field_x
    • ImageEvent.field_y
    • ImageEvent.path
    • ImageEvent.plate_name
    • ImageEvent.well_x
    • ImageEvent.well_y
    • ImageEvent.z_slice_id
  • StartCommandEvent
    • StartCommandEvent.command
    • StartCommandEvent.data
    • StartCommandEvent.event_type
  • StopCommandEvent
    • StopCommandEvent.command
    • StopCommandEvent.data
    • StopCommandEvent.event_type
  • register_api()
  • setup_module()
  • validate_commands()
• camacq.plugins.automations package
  • ActionSequence
    • ActionSequence.delay()
  • Automation
    • Automation.disable()
    • Automation.enable()
    • Automation.trigger()
  • TemplateAction
    • TemplateAction.render()
  • make_checker()
  • setup_module()
  • template_check()
  • Submodules
  • camacq.plugins.automations.event module
    • handle_trigger()
• camacq.plugins.leica package
  • LeicaApi
    • LeicaApi.name
    • LeicaApi.receive()
    • LeicaApi.send()
    • LeicaApi.send_many()
    • LeicaApi.start_imaging()
    • LeicaApi.start_listen()
    • LeicaApi.stop_imaging()
  • LeicaCommandEvent
    • LeicaCommandEvent.command
    • LeicaCommandEvent.data
    • LeicaCommandEvent.event_type
  • LeicaImageEvent
    • LeicaImageEvent.channel_id
    • LeicaImageEvent.data
    • LeicaImageEvent.event_type
    • LeicaImageEvent.field_x
    • LeicaImageEvent.field_y
    • LeicaImageEvent.job_id
    • LeicaImageEvent.path
    • LeicaImageEvent.plate_name
    • LeicaImageEvent.well_x
    • LeicaImageEvent.well_y
    • LeicaImageEvent.z_slice_id
  • LeicaStartCommandEvent
    • LeicaStartCommandEvent.command
    • LeicaStartCommandEvent.data
    • LeicaStartCommandEvent.event_type
  • LeicaStopCommandEvent
    • LeicaStopCommandEvent.command
    • LeicaStopCommandEvent.data
    • LeicaStopCommandEvent.event_type
  • setup_module()
  • Submodules
  • camacq.plugins.leica.command module
    • cam_com()
    • camstart_com()
    • camstop_com()
    • del_com()
    • enable_com()
    • gain_com()
    • start()
    • stop()
  • camacq.plugins.leica.helper module
    • find_image_path()
    • get_field()
    • get_imgs()
    • get_well()
• camacq.plugins.sample package
  • Image
    • Image.change_event
    • Image.images
    • Image.name
    • Image.path
    • Image.values
  • ImageContainer
    • ImageContainer.change_event
    • ImageContainer.images
    • ImageContainer.name
    • ImageContainer.values
  • Sample
    • Sample.center
    • Sample.change_event
    • Sample.data
    • Sample.get_sample()
    • Sample.image_event_type
    • Sample.images
    • Sample.name
    • Sample.on_image()
    • Sample.set_sample()
    • Sample.set_sample_schema
    • Sample.values
  • SampleEvent
    • SampleEvent.container
    • SampleEvent.container_name
    • SampleEvent.data
    • SampleEvent.event_type
    • SampleEvent.images
    • SampleEvent.values
  • SampleImageSetEvent
    • SampleImageSetEvent.container
    • SampleImageSetEvent.container_name
    • SampleImageSetEvent.data
    • SampleImageSetEvent.event_type
    • SampleImageSetEvent.images
    • SampleImageSetEvent.values
  • Samples
    • Samples.clear()
    • Samples.copy()
    • Samples.fromkeys()
    • Samples.get()
    • Samples.items()
    • Samples.keys()
    • Samples.pop()
    • Samples.popitem()
    • Samples.setdefault()
    • Samples.update()
    • Samples.values()
  • get_matched_samples()
  • register_sample()
  • setup_module()
  • Submodules
  • camacq.plugins.sample.helper module

Submodules

camacq.plugins.rename_image module

Handle renaming of an image.

camacq.plugins.rename_image.rename_image(old_path, new_path)

Rename image at old_path to new_path.

Parameters:

• old_path (str) – The absolute path to the existing image.

• new_path (str) – The absolute path to the renamed image.

async camacq.plugins.rename_image.setup_module(center, config)

Set up image rename plugin.

Parameters:

• center (Center instance) – The Center instance.

• config (dict) – The config dict.