/*
   This schema specifies elements for the cortical neurophysiology datamodel
   used at neurodatabase.org .  Most structures here build on more generic
   versions in the BrainML base package.  Included are:

   Cortical Protocol

   Cortical Recording Site

   Experimental Submission
*/
targetNamespace "urn:bml/brainml.org:med.cornell.edu/Cortex/1"
namespace "urn:bml/brainml.org:med.cornell.edu/Cortex/1"
namespace bml "urn:bml/brainml.org:internal/BrainML/1"
namespace bmtl "urn:bml/brainml.org:internal/BrainMetaL/1"
namespace xlink "http://www.w3.org/1999/xlink"
import "http://www.w3.org/2001/xml.xsd" namespace "http://www.w3.org/XML/1998/namespace"

import "http://brainml.org/schemas/internal/BrainMetaL/1/xlink.xsd" namespace "http://www.w3.org/1999/xlink"

import "http://brainml.org/schemas/internal/BrainMetaL/1/citation.xsd" namespace "urn:bml/brainml.org:internal/BrainMetaL/1"

import "http://brainml.org/schemas/internal/BrainMetaL/1/brainmetal.xsd" namespace "urn:bml/brainml.org:internal/BrainMetaL/1"

import "http://brainml.org/schemas/internal/BrainML/1/brainml.xsd" namespace "urn:bml/brainml.org:internal/BrainML/1"


complexType stimulus_nudge-type {
   ( effector, pattern, location )+
}

/* The agent effecting one aspect of the Protocol. */
element effector restricts bmtl:vocab-type {
   attribute domain {xs:token} = "stimulus nudge.effector"
}

/* The manner in which an agent acts to effect one aspect of the Protocol. */
element pattern restricts bmtl:vocab-type {
   attribute domain {xs:token} = "stimulus nudge.pattern"
}

/* The locus at which an agent acts to effect one aspect of the Protocol. */
element location restricts bmtl:vocab-type {
   attribute domain {xs:token} = "stimulus nudge.location"
}

/* Holds details on subject preparation and response elicitation. */
element stimulus_nudge { stimulus_nudge-type }

/* Experimental protocol. */
complexType cortical_protocol-type extends bml:protocol-type {
   (  preparation,
      description,
      stimulus_nudge?,
      bml:link_experiment? )
}

/* Preparation type used in this Protocol. */
element preparation restricts bmtl:vocab-type {
   attribute domain {xs:token} = "protocol.preparation"
}

/* Short verbal description of Protocol. */
element description { xs:string }

/* Experimental protocol. */
element cortical_protocol substitutes bml:protocol { cortical_protocol-type }


/* Recording location, specialized to cortical areas. */
complexType cortical_recording_location-type restricts xs:anyType {
  ( cytoarchitectural_area & functional_area & cortical_layer & atlas_location )
}


/* Recording location, specialized to cortical areas. */
element cortical_recording_location substitutes bml:recording_location {
   cortical_recording_location-type
}

/* Cytoarchitectonic area recorded Neuron was found in (Brodmann scheme). */
element cytoarchitectural_area restricts bmtl:vocab-type {
   attribute domain {xs:token} = "cortical location.cytoarchitectural area"
}

/* Functional area recorded Neuron was found in (e.g., V3a). */
element functional_area restricts bmtl:vocab-type {
   attribute domain {xs:token} = "cortical location.functional area"
}

/* Cortical layer recorded Neuron was found in. */
element cortical_layer restricts bmtl:vocab-type {
   attribute domain {xs:token} = "cortical location.cortical layer"
}

/* Specific location of the neuron according to any desired coordinate system
   or framework (in future will be specified). */
element atlas_location { xs:string }


complexType neuron_recording_source-type restricts xs:anyType {
   /* Nothing yet. */
}

/* Superclass for neuron recording sources; do not use directly. */
abstract element neuron_recording_source substitutes bml:recording_source {
   neuron_recording_source-type
}

complexType invertebrate_neuron_recording_source-type extends neuron_recording_source-type {
   (
      /* Canonical invertebrate neuron identifier. */
      neuron_id { xs:string }
   )
}

/* Recording source, specialized to invertebrate neurons. */
element invertebrate_neuron_recording_source substitutes neuron_recording_source {
   invertebrate_neuron_recording_source-type
}

complexType mammalian_neuron_recording_source-type extends neuron_recording_source-type {
   ( spontaneous_firing & directed_firing )
   /* Spontaneous firing rate of the Neuron. */
   element spontaneous_firing restricts bmtl:vocab-type {
      attribute domain {xs:token} = "mammalian neuron.firing"
   }
   /* Firing characteristics of Neuron when driven by stimulus or controlling
      action. */
   element directed_firing restricts bmtl:vocab-type {
      attribute domain {xs:token} = "mammalian neuron.firing"
   }
}

/* Recording source, specialized to mammalian neurons. */
element mammalian_neuron_recording_source substitutes neuron_recording_source {
   mammalian_neuron_recording_source-type
}

complexType cortical_neuron_recording_source-type extends neuron_recording_source-type {
   ( cell_class & classification_method )
   /* Cell type of the Neuron. */
   element cell_class restricts bmtl:vocab-type {
      attribute domain {xs:token} = "cortical neuron.cell class"
   }
   /* Means by which Neuron's cell type was determined. */
   element classification_method restricts bmtl:vocab-type {
      attribute domain {xs:token} = "cortical neuron.classification method"
   }
}

/* Recording source, specialized to cortical neurons. */
element cortical_neuron_recording_source substitutes neuron_recording_source {
   cortical_neuron_recording_source-type
}

complexType multiunit_recording_source-type restricts xs:anyType {
   ( electrode_tip_diameter_mm )
   /* Diameter of electrode tip doing multi-unit recording. */
   element electrode_tip_diameter_mm { xs:float }
}

/* Recording source, specialized to multi-unit recordings. */
element multiunit_recording_source substitutes bml:recording_source {
   multiunit_recording_source-type
}


complexType submission-type {
   (  bml:primary_contributor+,
      bml:contributor+,
      bmtl:citation+,
      bml:protocol,
      bml:recording_site+,
      bml:experiment )*
}

/* Contains a complete data submission. */
element submission { submission-type }