added schema for functional properties (#86)

* added schema for functional propertoes

* tied the schema to the upper level

emannotationschemas/__init__.py

@@ -13,6 +13,7 @@
     FunctionalUnitCoregistration,
     FunctionalUnitCoregistrationExtended,
 )
+from emannotationschemas.schemas.functional_props import FunctionalPropertiesBCM
 from emannotationschemas.schemas.postsynaptic_compartment import PostsynapticCompartment
 from emannotationschemas.schemas.base import (
     FlatSegmentationReferenceSinglePoint,
@@ -72,6 +73,7 @@
     "microns_func_coreg": FunctionalCoregistration,
     "microns_func_unit_coreg": FunctionalUnitCoregistration,
     "func_unit_ext_coreg": FunctionalUnitCoregistrationExtended,
+    "func_properties_bcm": FunctionalPropertiesBCM,
     "simple_reference": ReferenceAnnotation,
     "reference_tag": ReferenceTagAnnotation,
     "cell_type_local": CellTypeLocal,
@@ -106,6 +108,7 @@
     "bound_tag_valid": BoundTagWithValid,
 }
 
+
 def get_types():
     return [k for k in type_mapping.keys()]
 

emannotationschemas/schemas/functional_props.py

@@ -0,0 +1,30 @@
+import marshmallow as mm
+from emannotationschemas.schemas.base import (
+    ReferenceAnnotation,
+)
+
+
+class FunctionalPropertiesBCM(ReferenceAnnotation):
+    session = mm.fields.Int(required=True, description="session ID of imaging")
+    scan_idx = mm.fields.Int(
+        required=True, description="index of the scan within the session"
+    )
+    unit_id = mm.fields.Int(
+        required=True, description="unique functional cell ID within the scan"
+    )
+    pref_ori = mm.fields.Float(
+        required=True, desription="preferred orientation in radians (0 - pi)"
+    )
+    pref_dir = mm.fields.Float(
+        required=True, desription="preferred direction in radians (0 - 2pi)"
+    )
+    gOSI = mm.fields.Float(
+        required=True, desription="global orientation selectivity index"
+    )
+    gDSI = mm.fields.Float(
+        required=True, desription="global direction selectivity index"
+    )
+    cc_abs = mm.fields.Float(
+        required=True,
+        desription="prediction performance of the model, higher is better",
+    )