Attributed python-like header, stores all needed information about an object, currently used for volumes (AimsData). More...

#include <>>

Inheritance diagram for aims::PythonHeader:

[legend]

Collaboration diagram for aims::PythonHeader:

[legend]

Public Member Functions
	PythonHeader ()

	PythonHeader (const internal::PythonHeaderType &)

	PythonHeader (const PythonHeader &)

	PythonHeader (carto::Headered &)
	initialization by reference More...

virtual	~PythonHeader ()

virtual PythonHeader &	operator= (const PythonHeader &)

virtual const char *	id () const

virtual bool	readMinf (const std::string &filename)
	read meta-info header More...

virtual bool	writeMinf (const std::string &filename)
	write meta-info header, non-const version (may change some attributes) More...

virtual bool	writeMinf (const std::string &filename) const
	write meta-info header More...

virtual Header *	cloneHeader (bool keepUuid=false) const

virtual void	copy (const PythonHeader &, bool keepUuid=false)

virtual bool	isScalar () const

virtual bool	isString () const

virtual bool	isArray () const

virtual bool	isDynArray () const

virtual bool	isIterator () const

virtual bool	isDictionaryIterator () const

Public Member Functions inherited from carto::PointerObject< class >
	PointerObject (T &x, bool owner)

virtual	~PointerObject ()

virtual T &	getValue ()

virtual Object	clone () const

Public Member Functions inherited from carto::TypedObject< T >
	TypedObject ()

virtual	~TypedObject ()

const T &	getValue () const

virtual void	setValue (Object val)

virtual std::string	type () const

virtual double	getScalar () const

virtual void	setScalar (double)

virtual std::string	getString () const

virtual void	setString (const std::string &)

virtual Object	getArrayItem (int index) const

virtual void	setArrayItem (int, Object)

virtual size_t	size () const

virtual void	reserveArray (size_t)

virtual void	resizeArray (size_t)

virtual void	removeArrayItem (int)

virtual void	insertArrayItem (int, Object)

virtual bool	getProperty (const std::string &, Object &) const

virtual bool	isDictionary () const

virtual void	setProperty (const std::string &, Object)

virtual bool	removeProperty (const std::string &)

virtual bool	hasProperty (const std::string &) const

virtual void	clearProperties ()

virtual bool	isIterable () const

virtual Object	objectIterator () const

virtual bool	isValid () const

virtual Object	currentValue () const

virtual void	next ()

virtual bool	isKeyIterator () const

virtual Object	keyObject () const

virtual std::string	key () const

virtual bool	isIntKeyIterator () const

virtual long	intKey () const

virtual bool	isNone () const

virtual bool	operator== (const GenericObject &other) const

Public Member Functions inherited from carto::GenericObject
virtual	~GenericObject ()

const T &	value () const

T &	value ()

bool	value (T &) const

void	setValue (const T &val)

T *	getInterface ()

const T *	getInterface () const

virtual bool	operator!= (const GenericObject &other) const

Public Member Functions inherited from carto::RCObject
	RCObject ()

	RCObject (const RCObject &)

RCObject &	operator= (const RCObject &)

virtual	~RCObject ()

Public Member Functions inherited from carto::StringInterface
virtual	~StringInterface ()

virtual bool	operator== (const StringInterface &other) const

virtual bool	operator!= (const StringInterface &other) const

Public Member Functions inherited from carto::Interface
virtual	~Interface ()

Public Member Functions inherited from carto::ScalarInterface
virtual	~ScalarInterface ()

virtual bool	operator== (const ScalarInterface &other) const

virtual bool	operator!= (const ScalarInterface &other) const

Public Member Functions inherited from carto::DynArrayInterface
virtual	~DynArrayInterface ()

Public Member Functions inherited from carto::ArrayInterface
virtual	~ArrayInterface ()

Public Member Functions inherited from carto::SizeInterface
virtual	~SizeInterface ()

Public Member Functions inherited from carto::IterableInterface
virtual	~IterableInterface ()

virtual bool	operator== (const IterableInterface &other) const

virtual bool	operator!= (const IterableInterface &other) const

Public Member Functions inherited from carto::DictionaryInterface
virtual	~DictionaryInterface ()

Object	getProperty (const std::string &) const

Object	getProperty (Object key) const

bool	getProperty (const std::string &key, T &value) const

void	setProperty (const std::string &, const char *)

void	setProperty (const std::string &, const T &)

virtual void	copyProperties (Object source)

virtual bool	operator== (const DictionaryInterface &other) const

virtual bool	operator!= (const DictionaryInterface &other) const

void	setProperty (const std::string &key, Object const &value)

bool	getProperty (const std::string &key, Object &value) const

Public Member Functions inherited from carto::IteratorInterface
virtual	~IteratorInterface ()

Public Member Functions inherited from carto::KeyIteratorInterface
virtual	~KeyIteratorInterface ()

Public Member Functions inherited from carto::DictionaryIteratorInterface
virtual	~DictionaryIteratorInterface ()

Public Member Functions inherited from carto::IntKeyIteratorInterface
virtual	~IntKeyIteratorInterface ()

Public Member Functions inherited from carto::NoneInterface
virtual	~NoneInterface ()

Public Member Functions inherited from aims::Header
virtual	~Header ()=0

virtual std::string	extension () const
	standard file format extension of specialized headers More...

virtual std::set< std::string >	extensions () const
	possible filename extensions for specialized formats More...

virtual std::string	extension (const std::string &filename) const
	extension of given filename (including '.') More...

virtual std::string	removeExtension (const std::string &) const

Static Public Member Functions
static carto::SyntaxSet *	syntax ()

Additional Inherited Members
Public Types inherited from carto::RCObject
typedef int	RefCounterType

Protected Member Functions inherited from carto::GenericObject
virtual Interface *	_getGenericInterface ()=0

virtual const void *	_getAddressOfValue () const=0

Detailed Description

Attributed python-like header, stores all needed information about an object, currently used for volumes (AimsData).

This will allows to use python dictionaries file format.

Attributes currently stored:

Attribute name type Comment

file_type string SPM, DICOM, ...
data_type string U8, U16, S16,...
disk_data_type string U8... (disk file original format)
possible_data_types vector< string > list of compatible data types allowed for reading, first is default
ascii int 0 or not present : binary
byte_swapping int 0:not needed
spm_normalized bool
spm_origin vector< float > (cx,cy,cz) in voxels in SPM orientation
origin vector< float > (cx,cy,cz) in memory orientation
transfer_syntax string
manufacturer string
modality string
patient_id string
study_id string
series_number int
volume_dimension vector< int > (dimx,dimy,dimz,dimt)
voxel_size vector< float > (sx,sy,sz) (sz=slice thickness)
time_resolution float sizeT, can be equal to tr
bits_allocated int 8, 16, ...
te float echo time (in seconds)
tr float repetition time (in seconds)
ti float inversion time (in seconds)
flip_angle float flip angle (=tip angle)
slice_thickness float
inter_slices float spacing between slices
nb_t_pos int number of temporal positions (=dimT)
start_time vector< int > start time for dynamic series
duration_time vector< int > duration time for dynamic series
isotope string
radiopharamaceutical string
isotope_halflife float
image_unit string either Bq/CC ECAT Count/sec Unknown or labels
process_code int
process_list string "Norm", "Atten_Meas", "Atten_Calc", "Smooth_X", "Smooth_Y", "Smooth_Z", "Scat2d", "Scat3d", "ArcPrc", "DecayPrc", "OnCompPrc", "Random",
category string
zero_start_time int
original_filename string
filter_code int
filter_type string
filter_param vector< float > 6 float numbers
polygon_dimension int mesh: num of vertices per polygon
vertex_number int mesh: num of vertices (1st time pos)
b_value float B value of MR diffusion sequence
scale_factor float scale factor.
scale_factor_applied bool Is SPM scale factor already applied ?
vox_units string SPM parameter
cal_units string SPM parameter
db_name string SPM parameter
aux_file string SPM parameter
orient char SPM parameter
generated string SPM parameter
scannum string SPM parameter
patient_id string SPM parameter
exp_date string SPM parameter
exp_time string SPM parameter
views int SPM parameter
start_field int SPM parameter
field_skip int SPM parameter
omax int SPM parameter
omin int SPM parameter
smax int SPM parameter
smin int SPM parameter
SPM_data_type string SPM parameter
minimum int SPM parameter
maximum int SPM parameter
history string_vector
arg_syntax string syntaxic attribute for a graph file

Definition at line 51 of file pheader.h.

Constructor & Destructor Documentation

◆ PythonHeader() [1/4]

aims::PythonHeader::PythonHeader ( )

◆ PythonHeader() [2/4]

aims::PythonHeader::PythonHeader ( const internal::PythonHeaderType & )

◆ PythonHeader() [3/4]

aims::PythonHeader::PythonHeader ( const PythonHeader & )

◆ PythonHeader() [4/4]

aims::PythonHeader::PythonHeader ( carto::Headered & )

initialization by reference

◆ ~PythonHeader()

virtual aims::PythonHeader::~PythonHeader ( )

virtual

Member Function Documentation

◆ cloneHeader()

virtual Header* aims::PythonHeader::cloneHeader ( bool keepUuid = false ) const

virtual

Implements aims::Header.

Referenced by AimsData< AimsData< AimsData< T > > >::transpose().

◆ copy()

virtual void aims::PythonHeader::copy	(	const PythonHeader &	,
		bool	keepUuid = `false`
	)

virtual

Referenced by aims::Sinogram< T >::operator=(), aims::WavefrontMeshWriter< D, T >::removeExtension(), AimsData< AimsData< AimsData< T > > >::setHeader(), aims::GiftiMeshFormat< D, T >::write(), aims::BckWriter< T >::write(), aims::BckMapWriter< T >::write(), aims::PlyWriter< D, T >::write(), aims::TiffWriter< T >::write(), aims::MeshWriter< D, T >::write(), aims::TexWriter< T >::write(), aims::JpegWriter< T >::write(), aims::SpmWriter< T >::write(), and aims::GiftiTextureFormat< T >::write().

◆ id()

virtual const char* aims::PythonHeader::id ( ) const

virtual

Reimplemented from aims::Header.

◆ isArray()

virtual bool aims::PythonHeader::isArray ( ) const

inlinevirtual

Reimplemented from carto::TypedObject< T >.

Definition at line 71 of file pheader.h.

◆ isDictionaryIterator()

virtual bool aims::PythonHeader::isDictionaryIterator ( ) const

inlinevirtual

Reimplemented from carto::TypedObject< T >.

Definition at line 74 of file pheader.h.

◆ isDynArray()

virtual bool aims::PythonHeader::isDynArray ( ) const

inlinevirtual

Reimplemented from carto::TypedObject< T >.

Definition at line 72 of file pheader.h.

◆ isIterator()

virtual bool aims::PythonHeader::isIterator ( ) const

inlinevirtual

Reimplemented from carto::TypedObject< T >.

Definition at line 73 of file pheader.h.

◆ isScalar()

virtual bool aims::PythonHeader::isScalar ( ) const

inlinevirtual

Reimplemented from carto::TypedObject< T >.

Definition at line 69 of file pheader.h.

◆ isString()

virtual bool aims::PythonHeader::isString ( ) const

inlinevirtual

Reimplemented from carto::TypedObject< T >.

Definition at line 70 of file pheader.h.

◆ operator=()

virtual PythonHeader& aims::PythonHeader::operator= ( const PythonHeader & )

virtual

◆ readMinf()

virtual bool aims::PythonHeader::readMinf ( const std::string & filename )

virtual

read meta-info header

Reimplemented from aims::Header.

◆ syntax()

static carto::SyntaxSet* aims::PythonHeader::syntax ( )

static

◆ writeMinf() [1/2]

virtual bool aims::PythonHeader::writeMinf ( const std::string & filename )

virtual

write meta-info header, non-const version (may change some attributes)

Reimplemented from aims::Header.

Referenced by aims::GiftiMeshFormat< D, T >::write(), aims::PlyWriter< D, T >::write(), aims::MeshWriter< D, T >::write(), aims::GiftiTextureFormat< T >::write(), aims::WavefrontMeshWriter< D, T >::write(), and aims::WavefrontMeshWriter< D, Void >::write().

◆ writeMinf() [2/2]

virtual bool aims::PythonHeader::writeMinf ( const std::string & filename ) const

virtual

write meta-info header

Reimplemented from aims::Header.

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

aims/data/pheader.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PythonHeader() [1/4]

◆ PythonHeader() [2/4]

◆ PythonHeader() [3/4]

◆ PythonHeader() [4/4]

◆ ~PythonHeader()

Member Function Documentation

◆ cloneHeader()

◆ copy()

◆ id()

◆ isArray()

◆ isDictionaryIterator()

◆ isDynArray()

◆ isIterator()

◆ isScalar()

◆ isString()

◆ operator=()

◆ readMinf()

◆ syntax()

◆ writeMinf() [1/2]

◆ writeMinf() [2/2]