Acquisition

Note

TODO: make a nice object diagram for “acquisition” section

“acquisition” section

A typical acquisition section would look like below:

{
    "$schema":      "https://.../amorphys.json#properties/acquisition",
    "$description": "the acquisition programs related to the foraging behavior project.",

    "programs": {
        ...
    },

    "signals": {
        ...
    },

    "conversion": [
        ...
    ]
}

Caution

Note that, during actual acquisitions, not all the programs may be run. In other words, you can list as many programs as you can imagine in the programs field.

class acquisition

The acquisition section of amorphys is a subclass of section. It holds Program and Signal instances.

$description

a recommended string field inherited from the section class.

programs

a required mapping that maps program names to Program instances used in the experiments. In case the same program (e.g. Matlab) is used but in different ways (e.g. intrinsic signal acquisition vs behavioral control) during different contexts (e.g. surgery vs training sessions), it must be split into different instances.

For an example Program, refer to this section.

signals

a required mapping that maps channel names to Signal instances used in the experiments. Note that, as soon as a Signal instance gets processed by a device or a program, it must turn into another distinct Signal instance with a different name.

For an example, refer to this section.

conversion

a required array (but can be empty) of Relationship objects that describes how each Signal in channels relates to each other.

For available vocabulary, refer to Relationships between signals.