Documentation for XCEDE2 - xcede-2.0-core.xsd - Complex Type mappedBinaryDataDimension_t

# Documentation for XCEDE2

### Complex Type: mappedBinaryDataDimension_t

#### [Table of contents]

Super-types: | binaryDataDimension_t < mappedBinaryDataDimension_t (by extension)
Sub-types: | None

Name | mappedBinaryDataDimension_t
Used by (from the same schema document) | Complex Type mappedBinaryDataResource_t
Abstract | no

XML Instance Representation
<...
label=" xs:string [0..1]

'This is a label for the dimension. The first three spatial dimensions (or however many exist) must be labeled, in order, \'x\', \'y\', and \'z\'. The first temporal dimension must be labeled \'t\'.'

"
splitRank=" xs:string [0..1]

'If this attribute exists, this dimension is a \"split\" dimension, and this dimension must be \"merged\" with one or more other dimensions (with the same label) before presenting the data to the application. This is useful, for example, if the data is stored in Siemens\' Mosaic DICOM format, where slices of a 3-D volume are arranged to look like they are tiled onto a square 2-D area. In this case, what would normally be called the \'z\' dimension has two forks, one that occurs before the \'y\' dimension (the first row in the data covers the first row of several slices), and one that occurs after the \'y\' dimension. If, as in this case, there are two or more dimensions that should be merged into one, both component dimensions should have the label \'z\', but have splitRank attributes \"1\" and \"2\", which specifies the order in which all \'split\' dimensions of the same label will be merged. After merging, the resultant \'z\' dimension element should contain the same children of the highest-ranked split \'z\' dimension, except for the \'size\' element, which will be the product of the sizes of all \'z\' split dimensions. The position of the resultant dimension should be the position of the highest-ranked \'z\' split dimension. The data itself should also be reordered to reflect the new dimension structure.'

"
outputSelect=" xs:string [0..1]

'In the same way that the \'splitRank\' attribute allows you to specify dimensions that should be merged before presenting the data to an application, this attribute specifies a data filter along this dimension. If this attribute exists, it should contain a whitespace-separated list of indices (indexed starting at 0). Only data points along this dimension that occur in the index list should be presented to the application. Likewise, the \'size\' of the dimension, after selection, should be updated to reflect the new size of this dimension (which should be the number of indices in the content of this attribute).'

">
<size> xs:int </size> [1]

'The number of elements in the data along one traversal of this dimension.'

<origin> xs:float </origin> [0..1]

'A value assigned to the first data element along this dimension. For example, if this dimension corresponds to \"time\", this element could store the time corresponding to the first data element. If this is a two-dimensional projection of the surface of the Earth, and this dimension takes you around the Earth parallel to the equator, this value could be the degrees longitude. For MRI data, this is the single coordinate on the Left-to-Right, Posterior-to-Anterior, or Inferior-to-Superior axis to which this dimension most closely matches (see \'direction\' element and \'rasOrigin\' element in \'mrImageDataResource_t\').'

<spacing> xs:float </spacing> [0..1]

'This is the average distance between consecutive data elements in this dimension. If the spacing is not regular, then it may be possible to calculate the actual distance between any two data elements in this dimension using the \'datapoints\' element.'

<gap> xs:float </gap> [0..1]

'This is the length of the unsampled space between consecutive data elements in this dimension, i.e. the distance between the end of one data element and the beginning of the next. For MRI data, this can be used to specify the gap between two collected slices ― the actual width of each slice can be calculated as \'spacing\' minus \'gap\'.'

<datapoints> [0..1]

'The content of this element is either (1) a whitespace-separated list of values, or (2) a list of \'value\' elements, that can be used as a label for each data point along this dimension. The values can be numbers representing points on an axis (this is the typical case), text strings, coordinate tuples, etc. Any datapoint label that includes whitespace (coordinate tuples included) must be encapsulated within a child \'value\' element. If this element is missing, it is assumed that labels can be calculated using information in other fields (such as \'origin\', \'spacing\', etc.). This element is particularly useful for dimensions with irregular spacing.'

<!-- Mixed content -->
<value> xs:string </value> [0..*]
</datapoints>
<direction> listoffloats_t </direction> [0..1]

'This element contains a vector (represented as a whitespace-separated list of floating-point values in the appropriate coordinate system) that is parallel to this dimension\'s edge of the bounding box. The vector starts at the first element in the data and points towards subsequent elements along this dimension. For MRI data, this should be a unit vector in (R,A,S) coordinates (positive values are Right, Anterior, or Superior respectively) ― for \'x\' and \'y\' dimensions, this corresponds to the two vectors in the ImagePatientOrientation field in DICOM.'

<units> xs:string </units> [0..1]

'This stores the units used for all numeric values in this dimension element. In MRI data, this should be \'mm\' for all spatial dimensions (\'x\', \'y\', \'z\') and \'ms\' for the temporal dimension \'t\'.'

<measurementframe> [0..1]

'The mapping (if any) between the values expressed in <datapoints> and the coordinate system used by this datarec. For example, in DTI data, this is useful for mapping gradient direction vectors to the RAS coordinate space used in the <direction> vectors.'

<vector> listoffloats_t </vector> [0..*]
</measurementframe>
</...>
Diagram
Schema Component Representation
<xs:complexType name="mappedBinaryDataDimension_t">
<xs:complexContent>
<xs:extension base=" binaryDataDimension_t ">
<xs:sequence>
<xs:element name="origin" type=" xs:float " minOccurs="0"/>
<xs:element name="spacing" type=" xs:float " minOccurs="0"/>
<xs:element name="gap" type=" xs:float " minOccurs="0"/>
<xs:element name="datapoints" minOccurs="0">
<xs:complexType mixed="true">
<xs:sequence>
<xs:element name="value" type=" xs:string " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="direction" type=" listoffloats_t " minOccurs="0"/>
<xs:element name="units" type=" xs:string " minOccurs="0"/>
<xs:element name="measurementframe" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="vector" type=" listoffloats_t " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>