Organ Module#

Module: pyradise.data.organ

General#

The organ module provides the functionality to manage information about the Organ of a certain SegmentationImage.

Class Overview#

The following classes are provided by the organ module:

Class	Description
`Organ`	Class to identify an organ on a `SegmentationImage`.
`OrganAnnotatorCombination`	Combination class of consisting of an `Organ` instance and a `Annotator` instance.

Details#

class Organ(name, index=None)[source]#

Bases: object

A class for identifying an organ.

Notes

The Organ is used to identify the organ segmented on a SegmentationImage. If multiple organs are segmented on a single SegmentationImage, the Organ may be assigned an artificial name describing the set of organs.

Parameters:

name (str) – The name of the Organ.
index (Optional[int]) – The index of the Organ (default: None).

get_name()[source]#

Get the name of the Organ.

Returns:: The name of the Organ.
Return type:: str

set_name(name)[source]#

Set the name of the Organ.

Parameters:: name (str) – The name of the Organ.
Return type:: None

class OrganAnnotatorCombination(organ, annotator)[source]#

Bases: object

A class combining an Organ with a Annotator.

Parameters:

organ (Union[Organ, str]) – The Organ or its name.
annotator (Union[Annotator, str]) – The Annotator or its name.

property name: str#

Get the name of the OrganAnnotatorCombination.

Returns:: The combined name.
Return type:: str