aims::SpmHeader Class Reference

SPM Header class. More...

#include <aims/io/spmheader.h>

Inheritance diagram for aims::SpmHeader:

Collaboration diagram for aims::SpmHeader:

Public Member Functions
	SpmHeader (const std::string &name)
	SpmHeader (int dimx, int dimy, int dimz, int dimt, float sx, float sy, float sz, float st, const std::string &name)
virtual	~SpmHeader ()
const std::string &	name () const
void	setName (const std::string &fname)
int	dimX () const
	Get dimX... sizeT dimensions and sizes. More...
int	dimY () const
int	dimZ () const
int	dimT () const
float	sizeX () const
float	sizeY () const
float	sizeZ () const
float	sizeT () const
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...
bool	read ()
bool	write (bool writeMinf=true, bool allow4d=true)
bool	isNormalized () const
void	setupWriteAttributes (const std::string &datatypecode)
bool	imageIsProbablyLabel () const
Public Member Functions inherited from aims::PythonHeader
	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 std::string &filename) const
	extension of given filename (including '.') More...
virtual std::string	removeExtension (const std::string &) const

Additional Inherited Members
Public Types inherited from carto::RCObject
typedef int	RefCounterType
Static Public Member Functions inherited from aims::PythonHeader
static carto::SyntaxSet *	syntax ()
Protected Member Functions inherited from carto::GenericObject
virtual Interface *	_getGenericInterface ()=0
virtual const void *	_getAddressOfValue () const=0

Detailed Description

SPM Header class.

Private attributes :

Attribute name type Comment

• minimum int ???
• maximum int I don't know what's these for...

Definition at line 53 of file spmheader.h.

Constructor & Destructor Documentation

SpmHeader() [1/2]

aims::SpmHeader::SpmHeader

(

const std::string &

name

)

SpmHeader() [2/2]

aims::SpmHeader::SpmHeader	(	int	dimx,
		int	dimy,
		int	dimz,
		int	dimt,
		float	sx,
		float	sy,
		float	sz,
		float	st,
		const std::string &	name
	)

~SpmHeader()

virtual aims::SpmHeader::~SpmHeader ( )

virtual

Member Function Documentation

dimT()

int aims::SpmHeader::dimT

(

)

const

dimX()

int aims::SpmHeader::dimX

(

)

const

Get dimX... sizeT dimensions and sizes.

dimY()

int aims::SpmHeader::dimY

(

)

const

dimZ()

int aims::SpmHeader::dimZ

(

)

const

extension()

virtual std::string aims::SpmHeader::extension ( ) const

inlinevirtual

standard file format extension of specialized headers

Reimplemented from aims::Header.

Definition at line 74 of file spmheader.h.

extensions()

virtual std::set<std::string> aims::SpmHeader::extensions ( ) const

virtual

possible filename extensions for specialized formats

Reimplemented from aims::Header.

imageIsProbablyLabel()

bool aims::SpmHeader::imageIsProbablyLabel

(

)

const

isNormalized()

bool aims::SpmHeader::isNormalized

(

)

const

name()

const std::string& aims::SpmHeader::name

(

)

const

read()

bool aims::SpmHeader::read

(

)

Referenced by aims::SpmReader< T >::read().

setName()

void aims::SpmHeader::setName ( const std::string &  fname )

inline

Definition at line 62 of file spmheader.h.

setupWriteAttributes()

void aims::SpmHeader::setupWriteAttributes

(

const std::string &

datatypecode

)

sizeT()

float aims::SpmHeader::sizeT

(

)

const

sizeX()

float aims::SpmHeader::sizeX

(

)

const

sizeY()

float aims::SpmHeader::sizeY

(

)

const

sizeZ()

float aims::SpmHeader::sizeZ

(

)

const

write()

bool aims::SpmHeader::write	(	bool	writeMinf = true,
		bool	allow4d = true
	)

---

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

• aims/io/spmheader.h