ecl-logo Documentation

PlotContents

PlotContents[Obj]Plot

generates a plot of an item Obj and its immediate contents.

PlotContents[Mod]Plot

generates a plot of the physical layout of a container or instrument model Mod.

PlotContents[Pos]Plot

generates a plot of the location of a position Pos in its parent container within the ECL facility.

Details

  • Map->False will attempt to combine all inputs and return a single plot. If this is not possible (i.e., if the input location graphs are disconnected), inputs will be combined into the minimum number of connected location graphs.
  • If LiveDisplay->True (default), individual containers can be clicked to re-draw the container plot with focus on the clicked object.
  • LiveDisplay is only compatible with PlotType->Plot2D.
  • If both LevelsUp and NearestUp or LevelsUp and NearestDown are specified, the Nearest_ option will take precedence and the Levels_ option will be set to Infinity.
  • Duplicates in input will be deleted and duplicated items will be plotted only once.
  • Input
    Output
    Options
    Axes Options
    Box Options
    Data Specifications Options
    Frame Options
    Grid Options
    Image Format Options
    Plot Labeling Options
    Plot Range Options
    Plot Style Options
    General Options
    Messages
  • DisconnectedGraphThe specified inputs cannot be visualized on a single plot given the specified depth options. They will be split into the minimum number of connected container plots. If a single plot is desired, consider increasing LevelsUp/LevelsDown values to find overlap between the containers or contents of the input objects.
    IncompatibleOptionsLiveDisplay is unavailable when plotting in 3D. To use LiveDisplay, set PlotType->Plot2D.
    InvalidObjectThe following objects or their models are missing fields that are required for plotting: `1`. These object(s) and their contents will be omitted from the resultant plot(s). Run ValidObjectQ with Verbose->Failures for more information.
    InvalidPositionThe following {object, position} pairs cannot be plotted because the specified positions are not defined in their container's model: `1`.
    MismatchedUnitsThe specified TargetUnits, `1`, do not match. Using units `2` for all plot dimensions. When specifying TargetUnits as a list, all members of the list must match.
    ModelNotFoundUnable to plot the following objects due to missing container models: `1`. Populate the 'Model' field to make these Objects plottable.
    ObjectNotFoundUnable to find the following objects in the database for plotting: `1`. Check that these input Object(s) have been entered correctly.

Examples

Basic Examples  (3)

Plot the contents of a 96-well plate:

Plot the contents of a Vertical Lift shelf:

Plot the high-level contents of the ECL-2 facility:

Additional Examples  (4)

If a valid position is specified, its parent container is plotted and the position highlighted:

Multiple items whose containers or contents overlap given the provided 'Levels'/'Nearest' options can be plotted together, generating a single plot:

Plot the layout of a container model:

Plotting the contents of an empty container plots the container itself:

Options  (18)

Axes  (1)

Turn off display of axes around the output plot:

ContainerStyle  (1)

Modify the Style options applied to container graphics:

Highlight  (1)

Highlight one or more items or positions:

HighlightInput  (1)

If HighlightInput -> False, input items will not automatically be highlighted:

HighlightStyle  (1)

Modify the Style options applied to highlighted items:

ImageSize  (1)

Change the size of the output plot:

LabelPositions  (1)

Draw text labels direction within plotted positions:

LevelsDown  (1)

Specify how many levels of contents within the provided object will be displayed:

LevelsUp  (1)

Specify how many levels of containers enclosing the provided object will be displayed:

LiveDisplay  (1)

Allow clicking on containers to refocus the output plot:

Map  (2)

If Map->False and a list of items is supplied, a single plot is returned if the items' containers or contents overlap given the provided 'Levels'/'Nearest' options:

Separate plots can be generated for each member of listed input using the Map->True:

NearestDown  (1)

Plot the requested object, traversing the contents of the provided object until reaching an object of a given type:

NearestUp  (1)

Plot the requested object, traversing the containers enclosing the provided object until reaching an object of a given type:

PlotRange  (1)

Specify the PlotRange of the container plot:

PlotType  (1)

Plot the location of an instrument in the context of the building that holds it in 3D:

PositionStyle  (1)

Modify the Style options applied to position graphics:

TargetUnits  (1)

Set the units in which the plot will be displayed:

Messages  (7)

DisconnectedGraph  (1)

If Map->False and the list of provided items do not have overlapping containers or contents given the provided 'Levels'/'Nearest' options, a warning is displayed:

IncompatibleOptions  (1)

If two mutually exclusive option values are specified, an error is displayed and the conflict is resolved automatically:

InvalidObject  (1)

If an input or one of its containers or contents is missing fields required for plotting, an error is returned:

InvalidPosition  (1)

Contents with Positions that do not appear in their container's model are reported and excluded from plotting:

MismatchedUnits  (1)

If TargetUnits is specified as a list and the elements do not match, a warning is displayed:

ModelNotFound  (1)

If a provided item or an item in its containers or contents has no Model, an error is returned:

ObjectNotFound  (1)

If an object is supplied that is not in the database, an error is displayed and execution is aborted:

Last modified on Sat 12 Aug 2023 12:43:43