Anatomical API
NeuroCore places a strong emphasis on arrays with named dimensions. This allows the use of well established interfaces for arrays across the julia ecosystem while still providing meaningful information that may be specific to the type of data being worked with.
References
NeuroCore.AnatomicalAPI.axial_axis — Methodaxial_axis(x, size[; first_pad=nothing, last_pad=nothing, stride=nothing, dilation=nothing])Returns an AxisIterator along the axial axis.
NeuroCore.AnatomicalAPI.axial_axis — Methodaxial_axis(x)Returns the axis corresponding to the axial dimension.
NeuroCore.AnatomicalAPI.axial_axis_type — Methodaxial_axis_type(x)Returns the key type corresponding to the axial axis.
NeuroCore.AnatomicalAPI.axial_indices — Methodaxial_indices(x)Returns the indices corresponding to the axial axis
NeuroCore.AnatomicalAPI.axial_keys — Methodaxial_keys(x)Returns the keys corresponding to the axial axis
NeuroCore.AnatomicalAPI.axialdim — Methodaxialdim(x) -> IntReturns the dimension corresponding to axial.
NeuroCore.AnatomicalAPI.coronal_axis — Methodcoronal_axis(x, size[; first_pad=nothing, last_pad=nothing, stride=nothing, dilation=nothing])Returns an AxisIterator along the coronal axis.
NeuroCore.AnatomicalAPI.coronal_axis — Methodcoronal_axis(x)Returns the axis corresponding to the coronal dimension.
NeuroCore.AnatomicalAPI.coronal_axis_type — Methodcoronal_axis_type(x)Returns the key type corresponding to the coronal axis.
NeuroCore.AnatomicalAPI.coronal_indices — Methodcoronal_indices(x)Returns the indices corresponding to the coronal axis
NeuroCore.AnatomicalAPI.coronal_keys — Methodcoronal_keys(x)Returns the keys corresponding to the coronal axis
NeuroCore.AnatomicalAPI.coronaldim — Methodcoronaldim(x) -> IntReturns the dimension corresponding to coronal.
NeuroCore.AnatomicalAPI.each_axial — Methodeach_axial(x)Create a generator that iterates over the axial dimensions A, returning views that select all the data from the other dimensions in A.
NeuroCore.AnatomicalAPI.each_coronal — Methodeach_coronal(x)Create a generator that iterates over the coronal dimensions A, returning views that select all the data from the other dimensions in A.
NeuroCore.AnatomicalAPI.each_sagittal — Methodeach_sagittal(x)Create a generator that iterates over the sagittal dimensions A, returning views that select all the data from the other dimensions in A.
NeuroCore.AnatomicalAPI.has_axialdim — Methodhas_axialdim(x) -> BoolReturns true if x has a dimension corresponding to axial.
NeuroCore.AnatomicalAPI.has_coronaldim — Methodhas_coronaldim(x) -> BoolReturns true if x has a dimension corresponding to coronal.
NeuroCore.AnatomicalAPI.has_sagittaldim — Methodhas_sagittaldim(x) -> BoolReturns true if x has a dimension corresponding to sagittal.
NeuroCore.AnatomicalAPI.is_anatomical — Methodis_anatomical(x) -> BoolReturns true if T represents anatomical data.
NeuroCore.AnatomicalAPI.is_axial — Methodis_axial(x) -> BoolReturns true if x represent the axial orientation.
NeuroCore.AnatomicalAPI.is_coronal — Methodis_coronal(x) -> BoolReturns true if x represent the coronal orientation.
NeuroCore.AnatomicalAPI.is_neurologic — Methodis_neurologic(x) -> BoolTest to see if x is in neurological orientation.
NeuroCore.AnatomicalAPI.is_radiologic — Methodis_radiologic(x) -> BoolTest to see if x is in radiological orientation.
NeuroCore.AnatomicalAPI.is_sagittal — Methodis_sagittal(x) -> BoolReturns true if x represent the sagittal orientation.
NeuroCore.AnatomicalAPI.naxial — Methodnaxial(x) -> IntReturns the size along the dimension corresponding to the axial.
NeuroCore.AnatomicalAPI.ncoronal — Methodncoronal(x) -> IntReturns the size along the dimension corresponding to the coronal.
NeuroCore.AnatomicalAPI.nsagittal — Methodnsagittal(x) -> IntReturns the size along the dimension corresponding to the sagittal.
NeuroCore.AnatomicalAPI.sagittal_axis — Methodsagittal_axis(x, size[; first_pad=nothing, last_pad=nothing, stride=nothing, dilation=nothing])Returns an AxisIterator along the sagittal axis.
NeuroCore.AnatomicalAPI.sagittal_axis — Methodsagittal_axis(x)Returns the axis corresponding to the sagittal dimension.
NeuroCore.AnatomicalAPI.sagittal_axis_type — Methodsagittal_axis_type(x)Returns the key type corresponding to the sagittal axis.
NeuroCore.AnatomicalAPI.sagittal_indices — Methodsagittal_indices(x)Returns the indices corresponding to the sagittal axis
NeuroCore.AnatomicalAPI.sagittal_keys — Methodsagittal_keys(x)Returns the keys corresponding to the sagittal axis
NeuroCore.AnatomicalAPI.sagittaldim — Methodsagittaldim(x) -> IntReturns the dimension corresponding to sagittal.
NeuroCore.AnatomicalAPI.EncodingDirection — TypeEncodingDirectionPossible values: ipos, jpos, kpos, ineg,jneg,kneg(the axis of the NIfTI data along which slices were acquired, and the direction in which SliceTiming is defined with respect to).ipos,jpos,kposidentifiers correspond to the first, second and third axis of the data in the NIfTI file.*neg` indicates that the contents of SliceTiming are defined in reverse order - that is, the first entry corresponds to the slice with the largest index, and the final entry corresponds to slice index zero.
NeuroCore.AnatomicalAPI.is_anterior — Methodis_anterior(x) -> BoolReturns true if x represent the anterior position.
NeuroCore.AnatomicalAPI.is_channel — Methodis_channel(::T) -> BoolReturns true if T represents a gyrus.
NeuroCore.AnatomicalAPI.is_cortical — Methodis_cortical(::T) -> BoolReturns true if T represents a cortical region.
NeuroCore.AnatomicalAPI.is_csf — Methodis_csf(::T) -> BoolReturns true if T represents a region of corticospinal fluid (CSF).
NeuroCore.AnatomicalAPI.is_electrophysiology — Methodis_electrophysiology(::T) -> BoolReturns true if T represents electrophysiology data.
NeuroCore.AnatomicalAPI.is_gyrus — Methodis_gyrus(::T) -> BoolReturns true if T represents a gyrus.
NeuroCore.AnatomicalAPI.is_inferior — Methodis_inferior(x) -> BoolReturns true if x represent the inferior position.
NeuroCore.AnatomicalAPI.is_left — Methodis_left(x) -> BoolReturns true if x represent the left position.
NeuroCore.AnatomicalAPI.is_posterior — Methodis_posterior(x) -> BoolReturns true if x represent the posterior position.
NeuroCore.AnatomicalAPI.is_right — Methodis_right(x) -> BoolReturns true if x represent the right position.
NeuroCore.AnatomicalAPI.is_sulcus — Methodis_sulcus(::T) -> BoolReturns true if T represents a gyrus.
NeuroCore.AnatomicalAPI.is_superior — Methodis_superior(x) -> BoolReturns true if x represent the superior position.
NeuroCore.AnatomicalAPI.is_white_matter — Methodis_white_matter(::T) -> BoolReturns true if T represents white matter.
NeuroCore.AnatomicalAPI.select_axial — Methodselect_axial(x, i)Return a view of all the data of x where the index for the axial dimension equals i.
NeuroCore.AnatomicalAPI.select_coronal — Methodselect_coronal(x, i)Return a view of all the data of x where the index for the coronal dimension equals i.
NeuroCore.AnatomicalAPI.select_sagittal — Methodselect_sagittal(x, i)Return a view of all the data of x where the index for the sagittal dimension equals i.