Main Content

bioinfo.pipeline.Output

Output port object for bioinformatics pipeline block

Since R2023a

expand all in page

Description

Each output port of a bioinfo.pipeline.Block object is a bioinfo.pipeline.Output object.

Creation

Create the object using bioinfo.pipeline.Output.

Properties

expand all

Flag to merge parallel outputs with cell arrays, specified as a numeric or logical 1 (true) or 0 (false).

This property determines the merge strategy of the block output results after the block runs multiple times independently generating various results from each run according to the SplitDimension property.

If the value is true, the results from each block run are merged according to the output data type and concatenated along the specified split dimensions (similar to the UniformOutput name-value argument of cellfun or arrayfun). Additionally, the individual outputs from each run must be scalar unless the block only runs once. If there is only one block run, nonscalar outputs are allowed with UniformOutput=true.

If the value is false, the results from each run are wrapped in a cell array before concatenating.

Data Types: double | logical

This property is read-only.

Flag to indicate if the output port is required for the block, specified as a numeric or logical 1 (true) or 0 (false).

A required output must be a field of a structure returned by the run method of a block. Otherwise, the block fails to run.

You can set the value as true or false when you define a block subclass. For details, see Subclass Pipeline Block.

Data Types: double | logical

Version History

Introduced in R2023a

See Also

|