Skip to main content

RawVolumeImportOptions

Other

Options describing the layout of a headerless (raw) volume file. A raw file carries no metadata, so every value below has to match how the file was written. The dimensions have no default because they cannot be guessed from the file.

Import​

import ScriptingApi as api

# Access the class
# RawVolumeImportOptions is available via api.RawVolumeImportOptions

Properties​

voxel_data_type​

Voxel data type stored in the file. Use api.RawVoxelDataType values.

Type: RawVoxelDataType

dimension_x​

Number of voxels along X. Must be greater than zero.

Type: int

dimension_y​

Number of voxels along Y. Must be greater than zero.

Type: int

dimension_z​

Number of voxels along Z. Must be greater than zero.

Type: int

spacing_x​

Spacing along X in millimeters. Must be greater than zero.

Type: float

spacing_y​

Spacing along Y in millimeters. Must be greater than zero.

Type: float

spacing_z​

Spacing along Z in millimeters. Must be greater than zero.

Type: float

origin_x​

Origin along X in millimeters.

Type: float

origin_y​

Origin along Y in millimeters.

Type: float

origin_z​

Origin along Z in millimeters.

Type: float

header_size​

Number of bytes to skip before the voxel data starts. Must be non-negative.

Type: int

components​

Number of values stored per voxel. Must be at least one.

Type: int

little_endian​

True when the voxel values are stored in little-endian byte order.

Type: bool

invert_x​

Mirror the imported volume along the X axis after reading.

Type: bool

invert_y​

Mirror the imported volume along the Y axis after reading.

Type: bool

invert_z​

Mirror the imported volume along the Z axis after reading.

Type: bool

invert_intensity​

Invert the grayscale values after reading.

Type: bool

use_compression​

True when the voxel data in the file is compressed and has to be decompressed while reading.

Type: bool

See Also​