caf.base.segmentation

Module for handling segmentation objects.

This imports the Segment class from caf.base.segments, and the SegmentsSuper enumeration from caf.base.segments. Both are used for building segmentations.

Functions

NamedTuple(typename[, fields])	Typed version of namedtuple.
ordered_set(list_1, list_2)	Take in two lists and combine them, removing duplicates but preserving order.
product_multiindex(multi_index1, multi_index2)	Take two MultiIndex objects and return their Cartesian product as a new MultiIndex.

Classes

BaseConfig()	Base class for storing model parameters.
Path(*args, **kwargs)	PurePath subclass that can make system calls.
PathLike()	Abstract base class for implementing the file system path protocol.
Segment(*, name, values[, alias, ...])	Class containing info on a Segment, which combined with other Segments form a segmentation.
Segmentation(config)	Segmentation class for handling segmentation objects.
SegmentationInput(*, naming_order[, ...])	Input class for segmentation objects.
SegmentationSlice(slice_params[, naming_order])	Single slice of a segmentation.
SegmentsSuper(value)	Getter for predefined segments.

Exceptions

SegmentationError	Error for segmentation objects.
SegmentationWarning	Warn about segmentation objects.