amorphys
stable

Table of contents:

  • Why amorphys?
  • Overview
    • Background
    • What is amorphys?
    • Structure
    • How is it going to work?
      • Editor UI
      • Designer UI
      • Experiment runner
  • Core objects
    • Entity
      • Entity class
      • Types of entities
        • Spatial entity
        • Temporal entity
        • Signals
        • Programs and Routines
    • Relationship
      • How Relationship works
      • Pre-defined relationship keys
        • Spatial relationships
        • Temporal relationships
        • Relationships between signals
      • Defining your own relationship key(s)
    • Context
      • Context class
    • Classes for measurements
      • Date
      • Time
      • Subject-related
        • Age
        • Sex
        • Death
      • Space
      • Quantity
      • Notes on unit usages
    • URI-based reference
      • Referrable class
      • Individual class
      • Person class
      • License class
      • Citation class
    • Description of protocol control
      • Overview
      • Unitary stimulus control
        • StimulusState
        • ApparatusState
      • Sequence-type stimulus description
        • Sequencer
        • StimulusBlock
        • StimulusGeneration
      • Context-dependent stimulus sequence
        • StateMachine
        • MachineState
        • MachineStateTransition
    • Behavioral model for a subject
    • Variables and expressions
      • Use of variables
      • Use of conditions
      • Expressions and formatters
      • Use of templates
    • Supplementary documents
      • Predefined subclasses for Spatial
        • Subject entity
        • Component entity
      • Predefined subclasses for Temporal
        • Procedure
        • Action and Block
        • Phase
        • Specific types of actions
      • Predefined subclasses for Signal
        • Sampled and its subclasses
        • Event and its subclasses
        • State
      • Definition of your own entity class
  • Metadata structure
    • Overview
      • Sections
        • A recommended way of annotation
        • “section” class
      • Formatting options
        • Single-file format
        • Multi-file format
    • Project organization
      • “organization” section
      • Dataset class
      • Contributor class
      • Institution class
      • Funding class
    • Subject description
      • “subjects” section
    • Setups
      • “setups” section
      • Setup class
    • Acquisition
      • “acquisition” section
    • Procedures
      • “procedures” section
    • Task/Sweep control
      • “tasks” section
    • Experimental variables
      • An example
      • Scopes
      • Structure of scopes
        • Basic properties
        • Subsection for description of lower scope(s)
amorphys
  • Docs »
  • Core objects
  • Edit on GitHub

Core objects¶

A set of core JSON classes used in amorphys is described here.

The three key concepts in amorphys are:

  1. Entity: represents a physical existence.
  2. Relationship: represents a relationship between two Entity instances.
  3. Context: represents a group of Entities and Relationships.

In addition, several supportive classes are defined to facilitate annotation; refer to URI-based reference, Classes for measurements, Description of protocol control and Variables and expressions.

Table of contents:

  • Entity
    • Entity class
    • Types of entities
  • Relationship
    • How Relationship works
    • Pre-defined relationship keys
    • Defining your own relationship key(s)
  • Context
    • Context class
  • Classes for measurements
    • Date
    • Time
    • Subject-related
    • Space
    • Quantity
    • Notes on unit usages
  • URI-based reference
    • Referrable class
    • Individual class
    • Person class
    • License class
    • Citation class
  • Description of protocol control
    • Overview
    • Unitary stimulus control
    • Sequence-type stimulus description
    • Context-dependent stimulus sequence
  • Behavioral model for a subject
  • Variables and expressions
    • Use of variables
    • Use of conditions
    • Expressions and formatters
    • Use of templates
  • Supplementary documents
    • Predefined subclasses for Spatial
    • Predefined subclasses for Temporal
    • Predefined subclasses for Signal
    • Definition of your own entity class
Next Previous

© Copyright 2019, Keisuke Sehara Revision 437b86de.

Built with Sphinx using a theme provided by Read the Docs.