phenotypic.sdk_.constants_.PIPE_STATUS

class phenotypic.sdk_.constants_.PIPE_STATUS(*values)

Bases: MeasurementInfo

Constants for image set status.

Methods

category	Return the category name for this measurement enumeration.
kind	Coarse classification kind, or None until assigned by a base class.
tier	Trust tier (1/2/3) for primary measurements, or None.
rembi_module	REMBI module for this enum, or None until a subclass declares it.
header_scheme	Naming scheme for this enum's DataFrame output headers.
member_for_header	Return the member column is an output header for, or None.
owns_header	Whether column is one of this enum's output headers.
get_labels	Get all measurement labels without category prefix.
get_headers	Get all measurement headers with category prefix.
rst_table	Render an RST list-table of this enum's members.
append_rst_to_doc	Append the measurement documentation table to a module or class docstring.
encode	Encode the string using the codec registered for encoding.
replace	Return a copy with all occurrences of substring old replaced by new.
split	Return a list of the substrings in the string, using sep as the separator string.
rsplit	Return a list of the substrings in the string, using sep as the separator string.
join	Concatenate any number of strings.
capitalize	Return a capitalized version of the string.
casefold	Return a version of the string suitable for caseless comparisons.
title	Return a version of the string where each word is titlecased.
center	Return a centered string of length width.
count	S.count(sub[, start[, end]]) -> int
expandtabs	Return a copy where all tab characters are expanded using spaces.
find	S.find(sub[, start[, end]]) -> int
partition	Partition the string into three parts using the given separator.
index	S.index(sub[, start[, end]]) -> int
ljust	Return a left-justified string of length width.
lower	Return a copy of the string converted to lowercase.
lstrip	Return a copy of the string with leading whitespace removed.
rfind	S.rfind(sub[, start[, end]]) -> int
rindex	S.rindex(sub[, start[, end]]) -> int
rjust	Return a right-justified string of length width.
rstrip	Return a copy of the string with trailing whitespace removed.
rpartition	Partition the string into three parts using the given separator.
splitlines	Return a list of the lines in the string, breaking at line boundaries.
strip	Return a copy of the string with leading and trailing whitespace removed.
swapcase	Convert uppercase characters to lowercase and lowercase characters to uppercase.
translate	Replace each character in the string using the given translation table.
upper	Return a copy of the string converted to uppercase.
startswith	S.startswith(prefix[, start[, end]]) -> bool
endswith	S.endswith(suffix[, start[, end]]) -> bool
removeprefix	Return a str with the given prefix string removed if present.
removesuffix	Return a str with the given suffix string removed if present.
isascii	Return True if all characters in the string are ASCII, False otherwise.
islower	Return True if the string is a lowercase string, False otherwise.
isupper	Return True if the string is an uppercase string, False otherwise.
istitle	Return True if the string is a title-cased string, False otherwise.
isspace	Return True if the string is a whitespace string, False otherwise.
isdecimal	Return True if the string is a decimal string, False otherwise.
isdigit	Return True if the string is a digit string, False otherwise.
isnumeric	Return True if the string is a numeric string, False otherwise.
isalpha	Return True if the string is an alphabetic string, False otherwise.
isalnum	Return True if the string is an alpha-numeric string, False otherwise.
isidentifier	Return True if the string is a valid Python identifier, False otherwise.
isprintable	Return True if all characters in the string are printable, False otherwise.
zfill	Pad a numeric string with zeros on the left, to fill a field of the given width.
format	S.format(*args, **kwargs) -> str
format_map	S.format_map(mapping) -> str
maketrans	Return a translation table usable for str.translate().
__init__

Attributes

CATEGORY	Get the category name for this measurement instance.
resolved_kind	The coarse kind for this member (identity/quality/primary/derived).
resolved_tier	The trust tier (1/2/3) for this member, or None for non-primary.
resolved_rembi_module	override > enum declaration > fallback.
use_label	Short human-readable 'how to apply' label, empty for non-primary.
use_badge	RST sphinx-design xref badge for this member's classification.
PROCESSED
MEASURED
label
desc
bio_desc
image
pair
tier_override
derivation_type
derives_from
rembi_module_override

classmethod category() → str

Return the category name for this measurement enumeration.

Subclasses must implement this method to provide a category name that will be used to prefix all measurement labels. This ensures consistent naming conventions across the codebase.

Returns:

The category name (e.g., ‘Shape’, ‘Color’, ‘Texture’). This string is

prepended to each measurement label with an underscore separator to form the full header name (e.g., ‘Shape_Area’).

Return type:

str

Raises:

NotImplementedError – If not implemented by a subclass.

PROCESSED = 'Status_Processed'

classmethod kind() → str | None

Coarse classification kind, or None until assigned by a base class.

Return type:

str | None

classmethod tier() → int | None

Trust tier (1/2/3) for primary measurements, or None.

Return type:

int | None

classmethod rembi_module() → REMBI_MODULE | None

REMBI module for this enum, or None until a subclass declares it.

Return type:

REMBI_MODULE | None

classmethod header_scheme() → str

Naming scheme for this enum’s DataFrame output headers.

"static" (default) → exact {category}_{label}; "metric_qualified" → {category}_{metric}_{label} (growth models + model metrics, where {metric} is a runtime value); "texture" → TEXTURE’s -deg/-scale suffix scheme.

Return type:

str

classmethod member_for_header(column: str) → MeasurementInfo | None

Return the member column is an output header for, or None.

Parameters:

column (str)

Return type:

MeasurementInfo | None

classmethod owns_header(column: str) → bool

Whether column is one of this enum’s output headers.

Parameters:

column (str)

Return type:

bool

property CATEGORY: str

Get the category name for this measurement instance.

Provides instance-level access to the category name defined by the category() classmethod. This is useful when you have a measurement instance and need to know which category it belongs to without explicitly referencing the class.

Returns:

The category name from the enum class’s category() method.

Return type:

str

__str__() → str

Return the string representation of this measurement as the prefixed name.

Returns the full enumeration value, which is the category-prefixed label (e.g., ‘Shape_Area’). This is used when the measurement is converted to a string or used in string formatting.

Returns:

The full prefixed name of the measurement (e.g., ‘{category}_{label}’).

Return type:

str

property resolved_kind: str

The coarse kind for this member (identity/quality/primary/derived).

property resolved_tier: int | None

The trust tier (1/2/3) for this member, or None for non-primary.

property resolved_rembi_module: REMBI_MODULE

override > enum declaration > fallback.

Type:

Total REMBI-module resolver

property use_label: str

Short human-readable ‘how to apply’ label, empty for non-primary.

property use_badge: str

RST sphinx-design xref badge for this member’s classification.

A coloured :bdg-ref-{color}: pill linking to the measurement- classification explanation page (tier badges deep-link to the trust- contract table). Unlike use_label, this covers every kind — Identity, Quality and normalization-Derived included — so the rendered reference table classifies every column. Returns "" for members that do not classify (e.g. enums that subclass MeasurementInfo directly).

classmethod get_labels() → list[str]

Get all measurement labels without category prefix.

Returns a list of the short labels (without category prefix) for all measurements defined in this enumeration. These come from each member’s Entry.label field. Useful for creating human-readable lists or column names when the category context is already established.

Returns:

List of measurement labels in enumeration order (e.g.,

[‘Area’, ‘Perimeter’]). Does not include the category prefix; to get prefixed names, use get_headers().

Return type:

list[str]

classmethod get_headers() → list[str]

Get all measurement headers with category prefix.

Returns a list of the full enumeration values (with category prefix) for all measurements defined in this enumeration. These strings are suitable for use as DataFrame column names, dictionary keys, or in any context where the full categorized name is needed.

Returns:

List of prefixed measurement names in enumeration order

(e.g., [‘Shape_Area’, ‘Shape_Perimeter’]). Each header includes the category prefix separated by an underscore.

Return type:

list[str]

classmethod rst_table(*, title: str | None = None, header: tuple[str, str] = ('Name', 'Description'), use_headers: bool = False) → str

Render an RST list-table of this enum’s members.

Adds a Biology column when any member sets bio_desc and an Image column when any sets image (each suppressed otherwise).

Parameters:

• title (str | None) – Table caption; defaults to the category name.

• header (tuple[str, str]) – (name_column_header, description_column_header).

• use_headers (bool) – Name cell shows the prefixed value (Shape_Area) instead of the bare label (Area).

Return type:

str

classmethod append_rst_to_doc(module: str | object) → str

Append the measurement documentation table to a module or class docstring.

Generates the RST documentation table for this measurement enumeration and appends it to the provided module’s or class’s existing docstring. This is useful for automatically documenting which measurements a class produces or uses.

If the input is a string, it is treated as the docstring itself. If it is an object (class, function, module), its __doc__ attribute is used.

Parameters:

module (str | object) – Either a docstring string or an object (class, function, module) whose __doc__ attribute contains the docstring. The existing docstring is preserved, and the measurement table is appended with a blank line separator.

Returns:

The original docstring (or string) with the RST measurement table appended,

separated by two blank lines. The returned string is ready to be assigned back to the target’s __doc__ attribute.

Return type:

str

__new_member__(entry: Entry)

Create a member from an Entry.

The enum value is the category-prefixed header (e.g. Shape_Area); label/desc/bio_desc/image are stored as instance attributes. Anything other than an Entry raises TypeError at class-creation time.

Parameters:

entry (Entry)

encode(encoding='utf-8', errors='strict')

Encode the string using the codec registered for encoding.

encoding

The encoding in which to encode the string.

errors

The error handling scheme to use for encoding errors. The default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

replace(old, new, count=-1, /)

Return a copy with all occurrences of substring old replaced by new.

count

Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.

If the optional argument count is given, only the first count occurrences are replaced.

split(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including n r t f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

Note, str.split() is mainly useful for data that has been intentionally delimited. With natural text that includes punctuation, consider using the regular expression module.

rsplit(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including n r t f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

join(iterable, /)

Concatenate any number of strings.

The string whose method is called is inserted in between each given string. The result is returned as a new string.

Example: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’

capitalize()

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

casefold()

Return a version of the string suitable for caseless comparisons.

title()

Return a version of the string where each word is titlecased.

More specifically, words start with uppercased characters and all remaining cased characters have lower case.

center(width, fillchar=' ', /)

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

count(sub[, start[, end]]) → int

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

expandtabs(tabsize=8)

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

find(sub[, start[, end]]) → int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

partition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing the original string and two empty strings.

index(sub[, start[, end]]) → int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

ljust(width, fillchar=' ', /)

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).

lower()

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

rfind(sub[, start[, end]]) → int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex(sub[, start[, end]]) → int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

rjust(width, fillchar=' ', /)

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).

rstrip(chars=None, /)

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

rpartition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing two empty strings and the original string.

splitlines(keepends=False)

Return a list of the lines in the string, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and true.

strip(chars=None, /)

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

swapcase()

Convert uppercase characters to lowercase and lowercase characters to uppercase.

translate(table, /)

Replace each character in the string using the given translation table.

table

Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

The table must implement lookup/indexing via __getitem__, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper()

Return a copy of the string converted to uppercase.

startswith(prefix[, start[, end]]) → bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

endswith(suffix[, start[, end]]) → bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

removeprefix(prefix, /)

Return a str with the given prefix string removed if present.

If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.

removesuffix(suffix, /)

Return a str with the given suffix string removed if present.

If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.

isascii()

Return True if all characters in the string are ASCII, False otherwise.

ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.

islower()

Return True if the string is a lowercase string, False otherwise.

A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.

isupper()

Return True if the string is an uppercase string, False otherwise.

A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.

istitle()

Return True if the string is a title-cased string, False otherwise.

In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.

isspace()

Return True if the string is a whitespace string, False otherwise.

A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.

isdecimal()

Return True if the string is a decimal string, False otherwise.

A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.

isdigit()

Return True if the string is a digit string, False otherwise.

A string is a digit string if all characters in the string are digits and there is at least one character in the string.

isnumeric()

Return True if the string is a numeric string, False otherwise.

A string is numeric if all characters in the string are numeric and there is at least one character in the string.

isalpha()

Return True if the string is an alphabetic string, False otherwise.

A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.

isalnum()

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

isidentifier()

Return True if the string is a valid Python identifier, False otherwise.

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as “def” or “class”.

isprintable()

Return True if all characters in the string are printable, False otherwise.

A character is printable if repr() may use it in its output.

zfill(width, /)

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.

format(*args, **kwargs) → str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping) → str

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

static maketrans()

Return a translation table usable for str.translate().

If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.

MEASURED = 'Status_Measured'

__dir__()

Returns public methods and other interesting attributes.

label: str

desc: str

bio_desc: str

image: str | None

pair: tuple[str, str]

tier_override: int | None

derivation_type: str | None

derives_from: str | None

rembi_module_override: REMBI_MODULE | None