Predefined subclasses for Temporal¶
Representative classes of the Temporal class are described below.
An example can be found here.
Contents
Procedure¶
Procedure is an abstract class representing an experimental procedure.
-
class
Procedure¶ Procedureis a subclass ofTemporal, and represents any type of experimental procedure.-
type¶ a required
stringproperty inherited as anEntityinstance. This field must hold"Proedure"or the name of one of its subclasses.
-
date¶ an optional (but recommended)
Dateproperty specifying the date of this procedure.Usually, the value for this property holds a reference to a variable, as the date of the procedure varies across subjects and/or sessions.
-
start-time an optional
Timeproperty specifying the starting time of this procedure.
-
end-time an optional
Timeproperty specifying the ending time of this procedure.
-
Action and Block¶
Both Action and Block derive from the Procedure
abstract class.
-
class
Action¶ Actionis a subclass ofProcedure, and represents an elemental procedural action.-
type¶ a required
stringproperty inherited as anEntityinstance. This field must hold"Action"or the name of one of its subclasses.
-
date¶ a required
Dateproperty specifying the date of this action, as it is inherited fromProcedure.
-
start-time an optional
Timeproperty specifying the starting time of this action, as it is inherited fromProcedure.
-
end-time an optional
Timeproperty specifying the ending time of this action, as it is inherited fromProcedure.
-
-
class
Block¶ Blockis a subclass ofProcedure, and consists of a group of Procedures.-
type¶ a required
stringproperty inherited as anEntityinstance. This field must hold"Block"or the name of one of its subclasses.
-
date¶ a required
Dateproperty specifying the date of this block of procedures, as it is inherited fromProcedure.
-
procedures¶ a required array consisting of
Procedureobjects (can contain none), specifying the list of sub-procedures in this block of procedures.
-
order¶ an optional array consisting of temporal
Relationshipobjects, specifying the order of individual sub-procedures in this block.
-
start-time an optional
Timeproperty specifying the starting time of this block of procedures, as it is inherited fromProcedure.
-
end-time an optional
Timeproperty specifying the ending time of this block of procedures, as it is inherited fromProcedure.
-
Phase¶
For an example, refer to this section.
-
class
Phase¶ Phaseis a subclass ofBlock(i.e. a group of procedures), and represents a operational phase, or an experimental session consisting of one experimental procedure or more..-
type¶ a required
stringproperty inherited as anEntityinstance. This field must hold"Phase"or the name of one of its subclasses.
-
date¶ a required
Dateproperty specifying the date of this block of procedures, as it is inherited fromProcedure.
-
procedures¶ a required array consisting of
Procedureobjects (can contain none), specifying the list of sub-procedures in this block of procedures. This is a property inherited fromBlock.
-
order¶ an optional array consisting of temporal
Relationshipobjects, specifying the order of individual sub-procedures in this block. This is a property inherited fromBlock.
-
start-time an optional
Timeproperty specifying the starting time of this block of procedures, as it is inherited fromProcedure.
-
end-time an optional
Timeproperty specifying the ending time of this block of procedures, as it is inherited fromProcedure.
-
Specific types of actions¶
Anesthesia¶
TODO
describe what this is:
- content: material used, probably with concentration
- route: i.p., s.c., etc.
Acquisition¶
For an example, refer to this section.
Acquisition allows to link an Action entity (i.e. an atomic procedure)
with specific acquisition configurations.
-
class
Acquisition¶ a subclass of
Action.-
type¶ a required
stringproperty inherited as anEntityinstance. This field must hold"Acquisition"or the name of one of its subclasses.
-
date¶ a required
Dateproperty specifying the date of this action, as it is inherited fromProcedure.
-
sequencer¶ an optional
Sequencerproperty for better describing what task/protocol/sequence is used during this acquisition.
-
start-time an optional
Timeproperty specifying the starting time of this action, as it is inherited fromProcedure.
-
end-time an optional
Timeproperty specifying the ending time of this action, as it is inherited fromProcedure.
-
ChronicPreparation¶
Introduction or removal of some component from the subject.
-
class
ChronicPreparation¶ a subclass of
Action.-
type¶ a required
stringproperty inherited as anEntityinstance. This field must hold"ChronicPreparation"or the name of one of its subclasses.
-
date¶ a required
Dateproperty specifying the date of this action, as it is inherited fromProcedure.
-
manipulations¶ a required array with manipulation-related
Relationshipdescribing what material is introduced to / removed from the subject, with what parameters / coordinates.
-
start-time an optional
Timeproperty specifying the starting time of this action, as it is inherited fromProcedure.
-
end-time an optional
Timeproperty specifying the ending time of this action, as it is inherited fromProcedure.
-