The directory containing all .tiff files

Location of directory containing starfish experiment.json file. Only used when both skip_formatting and skip_processing are true.

Whether to rescale images before running decoding.

If true, QC will not be run.

The name of the aux view to look at in the experiment file for image segmentation.

Pixels above this percentile are set to 1.

Pixels below this percentile are set to 0.

If true, will save graphical output to a pdf.

PyYML-formatted dictionary outlining how the truerounds in imaging relate to the pseudorounds in the decoding codebook. The keys are truerounds and the values are the corresponding pseudorounds.

Variables to get substituted into the file_format string.

The number of FOVs that are included in this experiment

Root directory containing space_tx formatted experiment. Only used if skip_formatting is true.

Whether to treat the zplanes as a 3D image.

Sigma value for low pass gaussian filter. Will not be run if not provided.

If true, will add blanks with a hamming distance 1 from existing codes.

The index of the first FOV (for file names).

Sigma value for high pass gaussian filter. Will not be run if not provided.

If true, the baysor step will be run.

The name of the auxillary view to be processed in parallel with primary view, such as for anchor round in ISS processing. Will not be included if not provided.

PyYML-formatted list containing a dictionary outlining how the truechannels in imaging relate to the pseudochannels in the decoding codebook. The index of each dict within the list is the trueround % (count of pseudorounds). The keys of the dict are the channels within the image and the values are the pseudochannels in the converted notebook.

String with layout for .tiff files

If true, will run ripley K estimates to find spatial density measures. Can be slow.

If provided, the number of processes that will be spawned for processing. Otherwise, the maximum number of available CPUs will be used.

The number of imaging rounds in the experiment

Whether to generate a reference image and use it alongside spot detection.

Flattened csv input, refer to record entry.

Levelling method for clip and scale application. Defaults to SCALE_BY_CHUNK.

The index of the first round (for file names).

The number of z-planes in each image

The number of total channels per imaging round

Flattened json input, refer to record entry.

If provided, steps after conversion will only be run on FOVs with these indices.

Radius for white top hat filter. Should be slightly larger than the expected spot radius. Will not be run if not provided.

The index of the first channel (for file names).

Flattened directory input, refer to record entry \"binary_mask\"

json file containing parameters for the whole experiment. If variable is present here, it will supercede any passed in the yml.

Radius for rolling ball background subtraction. Larger values lead to increased intensity evening effect. The value of 3 will work for most datasets. Will not be run if not provided.

The name of the auxillary view to be used for background subtraction. Background will be estimated if not provided.

Number of iterations to perform for deconvolution. High values remove more noise while lower values remove less. The value 15 will work for most datasets unless image is very noisy. Will not be run if not provided.

If true, histograms will be equalized.

If true, will skip first two stages and start at processing.

If true, image processing step will be skipped.

Order of non x,y dimensions within each image.

Sigma value for deconvolution. Should be approximately the expected spot size.

Flattened record input, refer to record entry \"binary_mask\"

The name of the auxillary view to be used for image registration.

Flattened file input, refer to record entry \"binary_mask\"

If true, `background_view` will be aligned to `aux_name`.

Flattened record input, refer to record entry \"binary_mask\"

Pipeline will not remove genes that do not match a target and do not meet criteria.