Interfile fields.
This structure contains all the Interfile keys currently managed by CASToR
Declared in oInterfileIO.hh. More...

#include <oInterfileIO.hh>

Collaboration diagram for Intf_fields:

Public Attributes
string	path_to_image

string	originating_system

uint8_t	endianness

uint32_t	data_offset

string	nb_format

uint8_t	nb_dims

uint32_t	mtx_size [7]

FLTNB	vox_offset [3]

FLTNB	vox_size [3]

FLTNB	slice_thickness_mm

int	nb_bed_positions

FLTNB	bed_relative_position

bool	bed_position_provided

uint16_t	ctr_to_ctr_separation

uint16_t	nb_time_frames

uint16_t	nb_resp_gates

uint16_t	nb_card_gates

uint32_t	nb_total_imgs

uint8_t	nb_bytes_pixel

int8_t	slice_orientation

int8_t	pat_rotation

int8_t	pat_orientation

FLTNB	rescale_slope

FLTNB	quant_units

FLTNB	rescale_intercept

uint32_t	cmtx_size [3]

FLTNB	cvox_size [3]

FLTNB	cvox_offset [3]

bool	is_mtx_size_different

int	data_type

FLTNB	study_duration

vector< FLTNB >	image_duration

vector< FLTNB >	image_start_time

uint32_t	nb_time_windows

string	process_status

uint32_t	nb_img_in_frame_groups

vector< FLTNB >	frame_group_pause

uint16_t	nb_detector_heads

uint32_t	nb_energy_windows

uint16_t	nb_projections

FLTNB	extent_rotation

string	direction_rotation

FLTNB	first_angle

string	projection_angles

string	radius

Detailed Description

Interfile fields.
This structure contains all the Interfile keys currently managed by CASToR
Declared in oInterfileIO.hh.

Definition at line 239 of file oInterfileIO.hh.

Member Data Documentation

◆ bed_position_provided

bool Intf_fields::bed_position_provided

True if the relative bed position has been provided from the datafile

Definition at line 276 of file oInterfileIO.hh.

◆ bed_relative_position

FLTNB Intf_fields::bed_relative_position

Number of bed positions Bed relative position in mm

Definition at line 275 of file oInterfileIO.hh.

◆ cmtx_size

uint32_t Intf_fields::cmtx_size[3]

(C)astor reconstruction dimensions of the images (x,y,z).
Initialized only if interpolation is required on a recovered image.

Definition at line 317 of file oInterfileIO.hh.

◆ ctr_to_ctr_separation

uint16_t Intf_fields::ctr_to_ctr_separation

Recovered from the key 'centre-centre slice separation (pixels)'. Not currently implemented.
Used to compute gap between two slices (gap = ctr-ctr slice separation - slice_thickness_mm).

Definition at line 278 of file oInterfileIO.hh.

◆ cvox_offset

FLTNB Intf_fields::cvox_offset[3]

(C)astor image position offset (x,y,z).
Initialized only if interpolation is required on a recovered image.

Definition at line 323 of file oInterfileIO.hh.

◆ cvox_size

FLTNB Intf_fields::cvox_size[3]

(C)astor voxel size of the reconstructed images (x,y,z).
Initialized only if interpolation is required on a recovered image.

Definition at line 320 of file oInterfileIO.hh.

◆ data_offset

uint32_t Intf_fields::data_offset

Data offset in the image file, as defined by the fields "data offset in bytes" or "data starting block".
Associated with 'imagedata byte order' intf key.

Definition at line 250 of file oInterfileIO.hh.

◆ data_type

int Intf_fields::data_type

Definition at line 330 of file oInterfileIO.hh.

◆ direction_rotation

string Intf_fields::direction_rotation

Direction of rotation : CCW (counter-clockwise), CW (clockwise).
Associated with 'direction of rotation' intf key.

Definition at line 383 of file oInterfileIO.hh.

◆ endianness

uint8_t Intf_fields::endianness

Indicate if bytes follow a Little Endian or Big Endian ordering.
Associated with 'imagedata byte order' intf key.

Definition at line 247 of file oInterfileIO.hh.

◆ extent_rotation

FLTNB Intf_fields::extent_rotation

Angular span ex: 180, 360.
Associated with 'extent of rotation' intf key.

Definition at line 380 of file oInterfileIO.hh.

◆ first_angle

FLTNB Intf_fields::first_angle

Angle of the first view.
Associated with 'start angle' intf key.

Definition at line 387 of file oInterfileIO.hh.

◆ frame_group_pause

vector<FLTNB> Intf_fields::frame_group_pause

< Pause between time windows ?
Should be specific to each time frame.
Not used in the current implementation.
Associated with 'pause between images (sec)' intf key. ""pause between frame groups (sec)".
Associated with 'pause between frame groups (sec) ' intf key.

Definition at line 366 of file oInterfileIO.hh.

◆ image_duration

vector<FLTNB> Intf_fields::image_duration

"image duration (sec)". Duration of the frame.
Should be specific to each time frame.
Associated with 'image duration (sec)' intf key.

Definition at line 338 of file oInterfileIO.hh.

◆ image_start_time

vector<FLTNB> Intf_fields::image_start_time

"image start time (sec)". Start time of the frame.
Should be specific to each time frame.
Associated with 'image start time (sec)' intf key.

Definition at line 342 of file oInterfileIO.hh.

◆ is_mtx_size_different

bool Intf_fields::is_mtx_size_different

Bool indicating the original matric/voxel sizes are different to the reconstruction size,
hence requiring interpolation if the image is read.

Definition at line 327 of file oInterfileIO.hh.

◆ mtx_size

uint32_t Intf_fields::mtx_size[7]

Dimensions of the images (x,y,z) and non-spatial dimensions, such as number of frames.
Support for sinogram reading (and sinogram dimensions) is not yet implemented.
Associated with the 'matrix size[x]' and 'number of time frames' intf key.

Definition at line 259 of file oInterfileIO.hh.

◆ nb_bed_positions

int Intf_fields::nb_bed_positions

Definition at line 274 of file oInterfileIO.hh.

◆ nb_bytes_pixel

uint8_t Intf_fields::nb_bytes_pixel

number of bytes for each pixel/voxel of the image data.
Associated with 'number of bytes per pixel' intf key.

Definition at line 293 of file oInterfileIO.hh.

◆ nb_card_gates

uint16_t Intf_fields::nb_card_gates

Number of cardiac gates in a dynamic series of images.
Associated with 'number of cardiac gates' intf key (CASToR-specific key).

Definition at line 287 of file oInterfileIO.hh.

◆ nb_detector_heads

uint16_t Intf_fields::nb_detector_heads

Number of detector heads in the system.
Associated with 'number of detector heads' intf key.

Definition at line 370 of file oInterfileIO.hh.

◆ nb_dims

uint8_t Intf_fields::nb_dims

Total number of dimensions in the image data.
=3 by default. Computed from the other interfile keys

Definition at line 256 of file oInterfileIO.hh.

◆ nb_energy_windows

uint32_t Intf_fields::nb_energy_windows

Total number of energy windows.
Associated with 'number of energy windows' intf key.

Definition at line 373 of file oInterfileIO.hh.

◆ nb_format

string Intf_fields::nb_format

Type of each pixel/voxel data. Assumed to be similar for each slice.
Associated with 'number format' intf key.

Definition at line 253 of file oInterfileIO.hh.

◆ nb_img_in_frame_groups

uint32_t Intf_fields::nb_img_in_frame_groups

number of images in a frame.
Associated with 'number of images this frame group' intf key.

Definition at line 356 of file oInterfileIO.hh.

◆ nb_projections

uint16_t Intf_fields::nb_projections

Number of projection in acquired data.
Associated with 'number of projections' intf key.

Definition at line 376 of file oInterfileIO.hh.

◆ nb_resp_gates

uint16_t Intf_fields::nb_resp_gates

Number of respiratory gates in a dynamic series of images.
Associated with 'number of respiratory gates' intf key (CASToR-specific key).

Definition at line 284 of file oInterfileIO.hh.

◆ nb_time_frames

uint16_t Intf_fields::nb_time_frames

Number of time frames in a dynamic series of images.
Associated with 'number of time frames' intf key.

Definition at line 281 of file oInterfileIO.hh.

◆ nb_time_windows

uint32_t Intf_fields::nb_time_windows

Number of time windows.
This key is not used in the current implementation.
To define a number of gates, 'number of respiratory gates' and 'number of cardiac gates' must be used.
Associated with 'number of time windows' intf key.

Definition at line 346 of file oInterfileIO.hh.

◆ nb_total_imgs

uint32_t Intf_fields::nb_total_imgs

Total number of images in the associated data files.
Associated with 'total number of images' intf key.

Definition at line 290 of file oInterfileIO.hh.

◆ originating_system

string Intf_fields::originating_system

Name of the system as used and defined in CASTOR.
Associated to 'originating system' intf key.

Definition at line 244 of file oInterfileIO.hh.

◆ pat_orientation

int8_t Intf_fields::pat_orientation

slice orientation : head-in (=0, default), feet-in (=1).
Associated with 'patient orientation' intf key.
NOT used in the current implementation.

Definition at line 304 of file oInterfileIO.hh.

◆ pat_rotation

int8_t Intf_fields::pat_rotation

patient rotation : supine (=0, default), prone (=1).
Associated with 'patient rotation' intf key.
NOT used in the current implementation.

Definition at line 300 of file oInterfileIO.hh.

◆ path_to_image

string Intf_fields::path_to_image

Absolute or relative path to the image file. Will be converted to absolute path in the struct.
Associated with 'name of data file' intf key.

Definition at line 241 of file oInterfileIO.hh.

◆ process_status

string Intf_fields::process_status

"acquired" or "reconstructed" (default).
Associated with 'process status' intf key.

Definition at line 351 of file oInterfileIO.hh.

◆ projection_angles

string Intf_fields::projection_angles

All projection angles (for each view).
Associated with 'projection_angles' intf key.

Definition at line 390 of file oInterfileIO.hh.

◆ quant_units

FLTNB Intf_fields::quant_units

multiplicative calibration values. Initialized from 'quantification units'.
Associated with 'imagedata byte order' intf key.

Definition at line 311 of file oInterfileIO.hh.

◆ radius

string Intf_fields::radius

Distance between center of rotation and detector, for each view.
Associated with 'Center of rotation to detector distance' and 'Radius' intf keys.

Definition at line 393 of file oInterfileIO.hh.

◆ rescale_intercept

FLTNB Intf_fields::rescale_intercept

additive (intercept) calibration values.
Associated with 'uantification units' and 'rescale intercept' intf keys.

Definition at line 314 of file oInterfileIO.hh.

◆ rescale_slope

FLTNB Intf_fields::rescale_slope

multiplicative calibration values. Initialized from 'rescale slope'.
Associated with 'imagedata byte order' intf key.

Definition at line 308 of file oInterfileIO.hh.

◆ slice_orientation

int8_t Intf_fields::slice_orientation

slice orientation : transverse (=0, default), sagittal (=1), coronal (=2).
Associated with 'slice orientation' intf key.
NOT used in the current implementation.

Definition at line 296 of file oInterfileIO.hh.

◆ slice_thickness_mm

FLTNB Intf_fields::slice_thickness_mm

Read from the key 'slice thickness (pixels)'.
Conversely to the key name, the value is assumed to be given in mm.

Definition at line 271 of file oInterfileIO.hh.

◆ study_duration

FLTNB Intf_fields::study_duration

Acquisition duration.
Associated with 'study duration (sec)' intf key.

Definition at line 335 of file oInterfileIO.hh.

◆ vox_offset

FLTNB Intf_fields::vox_offset[3]

Image position offset (x,y,z).
Associated with the 'first pixel offset (mm) [x]' intf key.

Definition at line 263 of file oInterfileIO.hh.

◆ vox_size

FLTNB Intf_fields::vox_size[3]

Voxel dimensions in mm.
Associated with 'scaling factor (mm/pixel) [x]' intf key.

Definition at line 267 of file oInterfileIO.hh.

The documentation for this class was generated from the following file:

oInterfileIO.hh

Public Attributes