/* 
   This schema specifies the algorithm_settings and output_data elements for
   analysis requests and responses to/from the Analysis Server.
 */
targetNamespace "urn:bml/brainml.org:med.cornell.edu/Analysis/1"
namespace "urn:bml/brainml.org:med.cornell.edu/Analysis/1"
namespace bml "urn:bml/brainml.org:internal/BrainML/4"
namespace bmtl "urn:bml/brainml.org:internal/BrainMetaL/1"
import "http://brainml.org/schemas/internal/BrainMetaL/1/xml.xsd" namespace "http://www.w3.org/XML/1998/namespace"
import "http://brainml.org/schemas/internal/BrainML/4/brainml.xsd" namespace "urn:bml/brainml.org:internal/BrainML/4"
import "http://brainml.org/schemas/internal/BrainMetaL/1/citation.xsd" namespace "urn:bml/brainml.org:internal/BrainMetaL/1"
element analysis_algorithm_settings substitutes bml:algorithm_settings { analysis_algorithm_settings-type }
complexType analysis_algorithm_settings-type extends bml:algorithm_settings-type {
    ( bml:name, analysis_module* )
}
element analysis_module { analysis_module-type }
complexType analysis_module-type extends bmtl:method_element-type {
    ( bml:name, analysis_user_input* )
}
element analysis_user_input { analysis_user_input-type }
complexType analysis_user_input-type extends bmtl:method_element-type {
    ( bml:name, analysis_input_value?, analysis_user_input* )
}

/*  Input value entered or selected by the user for algorithm parameter or
   option. */
element analysis_input_value { xs:normalizedString }

/*  Contains output data results generated from the Analysis server
   after computational analysis. */
element analysis_output_data substitutes bml:output_data { analysis_output_data-type }
complexType analysis_output_data-type extends bml:output_data-type {
    ( scalar*, vector*, matrix*, estimate*, hist2d*, histcond* )
}

/* Analysis output data type: simplest type with a label and value. */
element scalar { scalar-type }
complexType scalar-type extends bmtl:data_element-type {
    ( variable_name, value? )
}

/* Data value. */
element value { xs:string }

/* Analysis output data type: vector with a label and dataset. */
element vector { vector-type }
complexType vector-type extends bmtl:data_element-type {
    ( variable_name, bmtl:dataset )
}

/* Analysis output data type: matrix data with a label and dataset. */
element matrix { matrix-type }
complexType matrix-type extends bmtl:data_element-type {
    ( variable_name, value )
}

/*  output_data type: Holds a 2-dimensional histogram and its mutual information.
 */
element hist2d { hist2d-type }
complexType hist2d-type extends bmtl:data_element-type {
    ( variable_name, hist1d [ 0, 3 ], estimate )
}

/*  output_data type: Holds a total histogram, class-conditional histograms,
   and the mutual information. */
element histcond { histcond-type }
complexType histcond-type extends bmtl:data_element-type {
    ( variable_name, hist1dvec?, hist1d?, estimate [ 1, 2 ] )
}

/* output_data type: Holds a vector of 1-D histograms. */
element hist1dvec { hist1dvec-type }
complexType hist1dvec-type extends bmtl:data_element-type {
    ( variable_name, hist1d, scalar*, estimate )
}

/* output_data type: Holds a 1-dimensional histogram and its entropy. */
element hist1d { hist1d-type }
complexType hist1d-type extends bmtl:data_element-type {
    ( variable_name, scalar*, vector*, estimate* )
}

/* output_data type: Holds information related to an estimated quantity. */
element estimate { estimate-type }
complexType estimate-type extends bmtl:data_element-type {
    ( variable_name, output_value?, num_bias_correction_methods*, num_variance_estimation_methods*, nv_pair? )
}

/* output_data variable name */
element variable_name { xs:normalizedString }

/* output_data value */
element output_value { xs:decimal }

/* output_data variable: Number of words used to generate the estimate. */
element num_total_words { xs:int }

/* output_data variable: Number of elements in the vector. */
element num_vector_elements { xs:int }

/* output_data variable: Number of subwords per word. */
element num_subwords { xs:int }

/* output_data variable: Number of unique words. */
element num_unique_words { xs:int }

/* output_data variable: List of unique words. */
element wordlist { wordlist-type }
complexType wordlist-type extends bmtl:data_element-type {
    ( bmtl:dataset, )
}

/* output_data variable: Counts of unique words. */
element wordcnt { wordlist-type }
complexType wordcnt-type extends bmtl:data_element-type {
    ( bmtl:dataset, )
}

/* output_data variable: Number of bias correction methods. */
element num_bias_correction_methods { xs:int }

/* output_data variable: Number of variance estimation methods. */
element num_variance_estimation_methods { xs:int }

/* output_data type: Simple structure that holds name and value. */
element nv_pair { nv_pair-type }
complexType nv_pair-type extends bmtl:data_element-type {
    ( variable_name, output_value? )
}

/* output_data type: Holds a 1-dimensional histogram and its entropy. */
element vec { vec-type }
complexType vec-type extends bmtl:data_element-type {
    ( variable_name, hist1d* )
}