validate_allocation_size

Given dimension sizes and bytes per element, checks that the
total allocation size is safe. Catches negative/NA/Inf dimensions, integer
overflow (by converting to double), and enforces the max allocation limit.

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) 

validate_allocation_size function

<dl><dt>dims</dt>
<dd>numeric vector of dimension sizes (e.g., <code>c(256, 256, 256)</code>).</dd>
<dt>bytes_per_elem</dt>
<dd>single numeric value, the number of bytes per element
(e.g., <code>4</code> for float32).</dd>
<dt>max_bytes</dt>
<dd>single numeric value, the maximum allowed allocation in bytes.
Defaults to the result of <code>get_max_alloc_bytes()</code>. Pass <code>Inf</code> to
disable the limit check (negative/NA/Inf dims are still rejected).</dd></dl>

Arguments

Validate that a requested allocation does not exceed the safety limit. — validate_allocation_size

<dl>

<dt>dims</dt>
<dd>numeric vector of dimension sizes (e.g., <code>c(256, 256, 256)</code>).</dd>


<dt>bytes_per_elem</dt>
<dd>single numeric value, the number of bytes per element
(e.g., <code>4</code> for float32).</dd>


<dt>max_bytes</dt>
<dd>single numeric value, the maximum allowed allocation in bytes.
Defaults to the result of <code>get_max_alloc_bytes()</code>. Pass <code>Inf</code> to
disable the limit check (negative/NA/Inf dims are still rejected).</dd>

</dl>

validate_allocation_size: Validate that a requested allocation does not exceed the safety limit.

Description

Usage

Value

Arguments