Class: MetricsDataset

A base object on which microscope-metrics runs the analysis

NOTE: this is an abstract class and should not be instantiated directly

URI: microscopemetrics_schema:MetricsDataset

classDiagram class MetricsDataset click MetricsDataset href "../MetricsDataset" MetricsObject <|-- MetricsDataset click MetricsObject href "../MetricsObject" MetricsDataset <|-- FieldIlluminationDataset click FieldIlluminationDataset href "../FieldIlluminationDataset" MetricsDataset <|-- PSFBeadsDataset click PSFBeadsDataset href "../PSFBeadsDataset" MetricsDataset <|-- LightSourcePowerDataset click LightSourcePowerDataset href "../LightSourcePowerDataset" MetricsDataset : acquisition_datetime MetricsDataset : acquisition_protocol MetricsDataset --> "0..1" Protocol : acquisition_protocol click Protocol href "../Protocol" MetricsDataset : data_reference MetricsDataset --> "0..1" DataReference : data_reference click DataReference href "../DataReference" MetricsDataset : description MetricsDataset : experimenter MetricsDataset --> "0..1" Experimenter : experimenter click Experimenter href "../Experimenter" MetricsDataset : input_data MetricsDataset --> "1" MetricsInputData : input_data click MetricsInputData href "../MetricsInputData" MetricsDataset : linked_references MetricsDataset --> "*" DataReference : linked_references click DataReference href "../DataReference" MetricsDataset : microscope MetricsDataset --> "1" Microscope : microscope click Microscope href "../Microscope" MetricsDataset : name MetricsDataset : output MetricsDataset --> "0..1" MetricsOutput : output click MetricsOutput href "../MetricsOutput" MetricsDataset : processed

Inheritance

NamedObject
- MetricsObject
  - MetricsDataset

Slots

Name	Cardinality and Range	Description	Inheritance
acquisition_datetime	0..1 datetime	The datetime of the acquisition	direct
input_data	1 MetricsInputData	The input data for the analysis	direct
output	0..1 MetricsOutput	The output of the analysis	direct
microscope	1 Microscope	The microscope that was used to acquire the dataset	direct
experimenter	0..1 Experimenter	The experimenter that performed the imaging experiment	direct
acquisition_protocol	0..1 Protocol	The protocol used to acquire the dataset	direct
processed	1 Boolean	Has the dataset been processed by microscope-metrics	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
MetricsDatasetCollection	dataset_collection	range	MetricsDataset
HarmonizedMetricsDatasetCollection	dataset_collection	range	MetricsDataset

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: MetricsDataset
description: A base object on which microscope-metrics runs the analysis
from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema
is_a: MetricsObject
abstract: true
slots:
- acquisition_datetime
- input_data
- output
attributes:
  microscope:
    name: microscope
    description: The microscope that was used to acquire the dataset
    from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema/core
    rank: 1000
    domain_of:
    - MetricsDataset
    range: Microscope
    required: true
    multivalued: false
  experimenter:
    name: experimenter
    description: The experimenter that performed the imaging experiment
    from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema/core
    rank: 1000
    domain_of:
    - MetricsDataset
    range: Experimenter
    multivalued: false
  acquisition_protocol:
    name: acquisition_protocol
    description: The protocol used to acquire the dataset
    from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema/core
    rank: 1000
    domain_of:
    - MetricsDataset
    range: Protocol
    required: false
    multivalued: false
    inlined: false
  processed:
    name: processed
    description: Has the dataset been processed by microscope-metrics
    from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema/core
    rank: 1000
    ifabsent: 'False'
    domain_of:
    - MetricsDataset
    range: boolean
    required: true
    multivalued: false
tree_root: true

Induced

name: MetricsDataset
description: A base object on which microscope-metrics runs the analysis
from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema
is_a: MetricsObject
abstract: true
attributes:
  microscope:
    name: microscope
    description: The microscope that was used to acquire the dataset
    from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema/core
    rank: 1000
    alias: microscope
    owner: MetricsDataset
    domain_of:
    - MetricsDataset
    range: Microscope
    required: true
    multivalued: false
  experimenter:
    name: experimenter
    description: The experimenter that performed the imaging experiment
    from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema/core
    rank: 1000
    alias: experimenter
    owner: MetricsDataset
    domain_of:
    - MetricsDataset
    range: Experimenter
    multivalued: false
  acquisition_protocol:
    name: acquisition_protocol
    description: The protocol used to acquire the dataset
    from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema/core
    rank: 1000
    alias: acquisition_protocol
    owner: MetricsDataset
    domain_of:
    - MetricsDataset
    range: Protocol
    required: false
    multivalued: false
    inlined: false
  processed:
    name: processed
    description: Has the dataset been processed by microscope-metrics
    from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema/core
    rank: 1000
    ifabsent: 'False'
    alias: processed
    owner: MetricsDataset
    domain_of:
    - MetricsDataset
    range: boolean
    required: true
    multivalued: false
  acquisition_datetime:
    name: acquisition_datetime
    description: The datetime of the acquisition
    from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema
    rank: 1000
    alias: acquisition_datetime
    owner: MetricsDataset
    domain_of:
    - MetricsDataset
    - Image
    - PowerSample
    range: datetime
    multivalued: false
  input_data:
    name: input_data
    description: The input data for the analysis
    from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema
    rank: 1000
    alias: input_data
    owner: MetricsDataset
    domain_of:
    - MetricsDataset
    range: MetricsInputData
    required: true
    multivalued: false
  output:
    name: output
    description: The output of the analysis
    from_schema: https://MontpellierRessourcesImagerie.github.io/microscopemetrics-schema
    rank: 1000
    abstract: true
    alias: output
    owner: MetricsDataset
    domain_of:
    - MetricsDataset
    range: MetricsOutput
    required: false
    multivalued: false
  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: MetricsDataset
    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: MetricsDataset
    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: MetricsDataset
    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: MetricsDataset
    domain_of:
    - NamedObject
    range: string
    required: false
    multivalued: false
tree_root: true