Skip to content

compute_projection_hcs

Task for 3D->2D maximum-intensity projection.

compute_projection_hcs(*, zarr_url, init_args)

Perform intensity projection for one image in an HCS plate.

Uses settings prepared by init_projection_hcs and stores the output in a new OME-Zarr file within the projected plate.

PARAMETER DESCRIPTION
zarr_url

Path or url to the individual OME-Zarr image to be processed. (standard argument for Fractal tasks, managed by Fractal server).

TYPE: str

init_args

Initialization arguments provided by init_projection_hcs.

TYPE: InitArgsMIP

Source code in fractal_tasks_core/compute_projection_hcs.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
@validate_call
def compute_projection_hcs(
    *,
    # Fractal parameters
    zarr_url: str,
    init_args: InitArgsMIP,
) -> dict[str, Any]:
    """Perform intensity projection for one image in an HCS plate.

    Uses settings prepared by `init_projection_hcs` and stores the output
    in a new OME-Zarr file within the projected plate.

    Args:
        zarr_url: Path or url to the individual OME-Zarr image to be processed.
            (standard argument for Fractal tasks, managed by Fractal server).
        init_args: Initialization arguments provided by
            `init_projection_hcs`.
    """
    attributes = {"plate": init_args.new_plate_name}
    return projection_core(
        input_zarr_url=init_args.origin_url,
        output_zarr_url=zarr_url,
        method=init_args.method,
        overwrite=init_args.overwrite,
        attributes=attributes,
    )