read_safe_bin

Calls <code><a href="/link/readBin?package=freesurferformats&version=1.0.2" data-mini-rdoc="freesurferformats::readBin">readBin</a></code> and then checks that the
returned vector has the expected length. If the file ends prematurely,
<code>readBin</code> silently returns fewer elements — this wrapper turns that
into an explicit error.

internal

Provides functions to read and write neuroimaging data in various file formats, with a focus on 'FreeSurfer' formats. This includes, but is not limited to, the following file formats: 1) MGH/MGZ/NIFTI format files, which can contain multi-dimensional images or other data. Typically they contain time-series of three-dimensional brain scans acquired by magnetic resonance imaging (MRI). They can also contain vertex-wise measures of surface morphometry data. The MGH format is named after the Massachusetts General Hospital, and the MGZ format is a compressed version of the same format. 2) 'FreeSurfer' morphometry data files in binary 'curv' format. These contain vertex-wise surface measures, i.e., one scalar value for each vertex of a brain surface mesh. These are typically values like the cortical thickness or brain surface area at each vertex. 3) Annotation file format. This contains a brain surface parcellation derived from a cortical atlas. 4) Surface file format. Contains a brain surface mesh, given by a list of vertices and a list of faces.

Tim Schc3<a4>fer

freesurferformats

Read and Write 'FreeSurfer' Neuroimaging File Formats

Tim Schäfer

Van Essen Lab 

Montreal Neurological Institute (MNI) 

read_safe_bin function

<dl><dt>con</dt>
<dd>a connection object.</dd>
<dt>what</dt>
<dd>character string or type, passed to <code>readBin</code>.</dd>
<dt>n</dt>
<dd>integer, the number of elements to read.</dd>
<dt>size</dt>
<dd>integer, the number of bytes per element.</dd>
<dt>endian</dt>
<dd>character string, <code>"big"</code> or <code>"little"</code>.</dd>
<dt>...</dt>
<dd>additional arguments passed to <code>readBin</code>.</dd></dl>

Arguments

Calls <code><a href='https://rdrr.io/r/base/readBin.html'>readBin</a></code> and then checks that the
returned vector has the expected length. If the file ends prematurely,
<code>readBin</code> silently returns fewer elements — this wrapper turns that
into an explicit error.

Safe wrapper around readBin that verifies the number of elements read. — read_safe_bin

<dl>

<dt>con</dt>
<dd>a connection object.</dd>


<dt>what</dt>
<dd>character string or type, passed to <code>readBin</code>.</dd>


<dt>n</dt>
<dd>integer, the number of elements to read.</dd>


<dt>size</dt>
<dd>integer, the number of bytes per element.</dd>


<dt>endian</dt>
<dd>character string, <code>"big"</code> or <code>"little"</code>.</dd>


<dt>...</dt>
<dd>additional arguments passed to <code>readBin</code>.</dd>

</dl>

read_safe_bin: Safe wrapper around readBin that verifies the number of elements read.

Description

Usage

Value

Arguments