RoiSubsetState

class glue.core.subset.RoiSubsetState(xatt=None, yatt=None, roi=None, pretransform=None)[source]

Bases: RoiSubsetStateNd

A subset defined as the set of points in two dimensions that lie inside a region of interest (ROI).

The two dimensions are defined as two numerical data attributes.

Parameters
xattComponentID

The data attribute on the x axis.

yattComponentID

The data attribute on the y axis.

roiRoi

The region of interest.

pretransform: callable, optional

A function that can be optionally applied to the data before checking points against the region.

Attributes Summary

xatt

The data attribute on the x axis.

yatt

The data attribute on the y axis.

Methods Summary

copy()

Return a copy of the subset state.

Attributes Documentation

xatt[source]

The data attribute on the x axis.

yatt[source]

The data attribute on the y axis.

Methods Documentation

copy()[source]

Return a copy of the subset state.