dash.ensembleFilter.dispFilter

Displays details about an ensembleFilter in the console


Syntax



Description

width = obj.dispFilter(link, width)

Displays details about an ensembleFilter object in the console. Begins by displaying a link to the class documentation. If the object is scalar, displays the label (if there is one). Also displays the current status of the observations, estimates, uncertainties, and prior. Displays assimilation sizes as they are set. Aligns labels to match the same width.

If the object is an array, displays the array size. If any of the objects in the array have labels, displays the labels. Any object without a label is listed as “<no label>”. If the array is empty, declares that the array is empty.


Input Arguments

width

scalar positive integer | []
The maximum width of labels in subclass disp methods. Only used for scalar display.

Output Arguments

width

scalar positive integer
The maximum width for aligning fields after also considering dispFilter fields.