ecl-logo Documentation

CompatibleFootprintQ

CompatibleFootprintQ[myLocation,mySample]compatibleFootprintQ

returns a boolean that indicates if mySample can fit onto one of the positions of myLocation.

Details

    Input
    Output
    General Options

Examples

Basic Examples  (6)

Looks through the CompatibleAdapters to determine if an adapter can be used to fit the sample on the instrument 1:

Looks through the CompatibleAdapters to determine if an adapter can be used to fit the sample on the instrument 2:

Looks through the CompatibleAdapters to determine if an adapter can be used to fit the sample on the instrument 3:

Returns a boolean that indicates if there is a position on the instrument that can fit the given sample:

Returns a boolean that indicates if there is a position on the instrument that can fit the given sample:

CompatibleFootprintQ is listable:

Additional Examples  (3)

CompatibleFootprintQ can check Model[Container]s in addition to instruments:

Both the Locations and the containers can be pooled:

Both the specified the pooled options for each of the pooled locations and containers:

Options  (9)

ExactMatch  (2)

When ExactMatch->True, an exact match between the container's dimensions and the model's position's dimensions is evaluated, given the set Tolerance allowed:

When ExactMatch->False, an exact match between the container's dimensions and the model's position's dimensions is evaluated, given the set Tolerance allowed:

FlattenOutput  (1)

Returns a lists of list results when FlattenOutput->False, regardless how many input containers are specified:

MinWidth  (2)

When there is a MinWidth for an instrument (spacing required between roller pins), it can be specified using the MinWidth option:

When there is a MinWidth for an instrument (spacing required between roller pins), it can be specified using the MinWidth option:

Position  (2)

When Position->All, all positions in the instrument will be considered when trying to determine compatibility of the sample:

When Position is set to a specific position name, only that name will be considered during compaitibility determination:

Tolerance  (2)

Tolerance controls the tolerance between the measurement of the container and of the instrument's position. Since measurement is never perfect, this defaults to .5 Centimeters:

Tolerance controls the tolerance between the measurement of the container and of the instrument's position. Since measurement is never perfect, this defaults to .5 Centimeters:

Messages  (1)

PositionNotFound  (1)

When Position is set to a specific position name, if that position name doesn't appear in the instrument's list of positions an error is thrown: