Skip to content

contact builtin

contact(
    coords,
    values,
    *,
    domains=None,
    domain_column=None,
    holes,
    inside,
    outside,
    max_distance,
    bin,
)

Mean of values against signed distance to the inside/outside contact along each hole, negative inside.

Parameters:

Name Type Description Default
coords PointSet or array_like

Samples, or their (n, 2) or (n, 3) coordinates.

required
values array_like or str

Values, or their column in coords.

required
domains array_like

Domain of each sample, int or str.

None
domain_column str

Column of coords holding the domains; give it or domains.

None
holes array_like or str

Hole id of each sample, or its column.

required
inside int or str

Domains on either side of the contact.

required
outside int or str

Domains on either side of the contact.

required
max_distance float

Largest distance to the contact; the outermost bins end there.

required
bin float

Width of the distance bins.

required

Returns:

Type Description
Table

distance (bin centers), mean and n samples per bin.

used in