Skip to content

Class: Roi

A ROI (Region Of Interest). Collection of shapes and an image to which they are applied

URI: microscopemetrics_schema:Roi

classDiagram class Roi click Roi href "../Roi" MetricsObject <|-- Roi click MetricsObject href "../MetricsObject" Roi : data_reference Roi --> "0..1" DataReference : data_reference click DataReference href "../DataReference" Roi : description Roi : ellipses Roi --> "*" Ellipse : ellipses click Ellipse href "../Ellipse" Roi : lines Roi --> "*" Line : lines click Line href "../Line" Roi : linked_references Roi --> "*" DataReference : linked_references click DataReference href "../DataReference" Roi : masks Roi --> "*" Mask : masks click Mask href "../Mask" Roi : name Roi : points Roi --> "*" Point : points click Point href "../Point" Roi : polygons Roi --> "*" Polygon : polygons click Polygon href "../Polygon" Roi : rectangles Roi --> "*" Rectangle : rectangles click Rectangle href "../Rectangle"

Inheritance

Slots

Name Cardinality and Range Description Inheritance
points *
Point		 A list of points included in the ROI direct
lines *
Line		 A list of lines included in the ROI direct
rectangles *
Rectangle		 A list of rectangles included in the ROI direct
ellipses *
Ellipse		 A list of ellipses included in the ROI direct
polygons *
Polygon		 A list of polygons included in the ROI direct
masks *
Mask		 A list of masks included in the ROI direct
data_reference 0..1
DataReference		 A reference to the data MetricsObject
linked_references *
DataReference		 A list of linked references MetricsObject
name 0..1
String		 The human readable name of an entity NamedObject
description 0..1
String		 A human readable description of an entity NamedObject

Usages

used by used in type used
OrthogonalImage source_roi range Roi
FieldIlluminationOutput roi_profiles range Roi
FieldIlluminationOutput roi_corners range Roi
FieldIlluminationOutput roi_centers_of_mass range Roi
FieldIlluminationOutput roi_centers_geometric range Roi
FieldIlluminationOutput roi_centers_fitted range Roi
FieldIlluminationOutput roi_centers_max_intensity range Roi
FieldIlluminationOutput roi_center_region range Roi
PSFBeadsOutput analyzed_bead_centers range Roi
PSFBeadsOutput considered_bead_centers_lateral_edge range Roi
PSFBeadsOutput considered_bead_centers_self_proximity range Roi
PSFBeadsOutput considered_bead_centers_axial_edge range Roi
PSFBeadsOutput considered_bead_centers_intensity_outlier range Roi
PSFBeadsOutput considered_bead_centers_z_fit_quality range Roi
PSFBeadsOutput considered_bead_centers_y_fit_quality range Roi
PSFBeadsOutput considered_bead_centers_x_fit_quality range Roi

Identifier and Mapping Information

Schema Source

  • from schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema

Mappings

Mapping Type Mapped Value
self microscopemetrics_schema:Roi
native microscopemetrics_schema:Roi

LinkML Source

Direct

name: Roi
description: A ROI (Region Of Interest). Collection of shapes and an image to which
  they are applied
from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema
is_a: MetricsObject
attributes:
  points:
    name: points
    description: A list of points included in the ROI
    from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema/core
    rank: 1000
    domain_of:
    - Roi
    range: Point
    required: false
    multivalued: true
    inlined: true
    inlined_as_list: true
  lines:
    name: lines
    description: A list of lines included in the ROI
    from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema/core
    rank: 1000
    domain_of:
    - Roi
    range: Line
    required: false
    multivalued: true
    inlined: true
    inlined_as_list: true
  rectangles:
    name: rectangles
    description: A list of rectangles included in the ROI
    from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema/core
    rank: 1000
    domain_of:
    - Roi
    range: Rectangle
    required: false
    multivalued: true
    inlined: true
    inlined_as_list: true
  ellipses:
    name: ellipses
    description: A list of ellipses included in the ROI
    from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema/core
    rank: 1000
    domain_of:
    - Roi
    range: Ellipse
    required: false
    multivalued: true
    inlined: true
    inlined_as_list: true
  polygons:
    name: polygons
    description: A list of polygons included in the ROI
    from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema/core
    rank: 1000
    domain_of:
    - Roi
    range: Polygon
    required: false
    multivalued: true
    inlined: true
    inlined_as_list: true
  masks:
    name: masks
    description: A list of masks included in the ROI
    from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema/core
    rank: 1000
    domain_of:
    - Roi
    range: Mask
    required: false
    multivalued: true
    inlined: true
    inlined_as_list: true

Induced

name: Roi
description: A ROI (Region Of Interest). Collection of shapes and an image to which
  they are applied
from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema
is_a: MetricsObject
attributes:
  points:
    name: points
    description: A list of points included in the ROI
    from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema/core
    rank: 1000
    alias: points
    owner: Roi
    domain_of:
    - Roi
    range: Point
    required: false
    multivalued: true
    inlined: true
    inlined_as_list: true
  lines:
    name: lines
    description: A list of lines included in the ROI
    from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema/core
    rank: 1000
    alias: lines
    owner: Roi
    domain_of:
    - Roi
    range: Line
    required: false
    multivalued: true
    inlined: true
    inlined_as_list: true
  rectangles:
    name: rectangles
    description: A list of rectangles included in the ROI
    from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema/core
    rank: 1000
    alias: rectangles
    owner: Roi
    domain_of:
    - Roi
    range: Rectangle
    required: false
    multivalued: true
    inlined: true
    inlined_as_list: true
  ellipses:
    name: ellipses
    description: A list of ellipses included in the ROI
    from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema/core
    rank: 1000
    alias: ellipses
    owner: Roi
    domain_of:
    - Roi
    range: Ellipse
    required: false
    multivalued: true
    inlined: true
    inlined_as_list: true
  polygons:
    name: polygons
    description: A list of polygons included in the ROI
    from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema/core
    rank: 1000
    alias: polygons
    owner: Roi
    domain_of:
    - Roi
    range: Polygon
    required: false
    multivalued: true
    inlined: true
    inlined_as_list: true
  masks:
    name: masks
    description: A list of masks included in the ROI
    from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema/core
    rank: 1000
    alias: masks
    owner: Roi
    domain_of:
    - Roi
    range: Mask
    required: false
    multivalued: true
    inlined: true
    inlined_as_list: true
  data_reference:
    name: data_reference
    description: A reference to the data
    from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema
    rank: 1000
    alias: data_reference
    owner: Roi
    domain_of:
    - MetricsObject
    range: DataReference
    required: false
    multivalued: false
  linked_references:
    name: linked_references
    description: A list of linked references
    from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema
    rank: 1000
    alias: linked_references
    owner: Roi
    domain_of:
    - MetricsObject
    range: DataReference
    required: false
    multivalued: true
    inlined: true
    inlined_as_list: true
  name:
    name: name
    description: The human readable name of an entity
    from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema/core
    rank: 1000
    alias: name
    owner: Roi
    domain_of:
    - NamedObject
    range: string
    required: false
    multivalued: false
  description:
    name: description
    description: A human readable description of an entity
    from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema/core
    rank: 1000
    alias: description
    owner: Roi
    domain_of:
    - NamedObject
    range: string
    required: false
    multivalued: false