#include <aims/io/fdfheader.h>

Inheritance diagram for aims::FdfHeader:

[legend]

Collaboration diagram for aims::FdfHeader:

[legend]

Public Member Functions
	FdfHeader (const std::string &name, const std::string &type="UNKNOWN", int x=1, int y=1, int z=1, int t=1, float sx=1, float sy=1, float sz=1, float st=1)

virtual	~FdfHeader ()

int	dimX () const

int	dimY () const

int	dimZ () const

int	dimT () const

float	sizeX () const

float	sizeY () const

float	sizeZ () const

float	sizeT () const

std::string	dataType () const
	Get type of items ("U08", "S08", "U16", "S16", ...) More...

void	setType (const std::string &t)

std::string	name () const
	Get the file name of the header. More...

std::vector< std::string >	possibleDataTypes () 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...

void	read ()

void	readProcPar (std::string name)

virtual std::vector< std::string >	inputFilenames ()

Public Member Functions inherited from aims::SliceFormatHeader
	SliceFormatHeader (const std::string &filename, int dimx=1, int dimy=1, int dimz=1, int dimt=1, float vsx=1, float vsy=1, float vsz=1, float vst=1)

virtual	~SliceFormatHeader ()

virtual std::vector< std::string >	outputFilenames () const

std::string	inputNamepattern (unsigned &smin, unsigned &smax, unsigned &tmin, unsigned &tmax) const

std::string	filename () 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

Protected Member Functions
virtual std::set< std::string >	getFiles (std::string filename) const

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

virtual const void *	_getAddressOfValue () const=0

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 Attributes inherited from aims::SliceFormatHeader
std::string	_name

Detailed Description

Definition at line 45 of file fdfheader.h.

Constructor & Destructor Documentation

◆ FdfHeader()

aims::FdfHeader::FdfHeader	(	const std::string &	name,
		const std::string &	type = `"UNKNOWN"`,
		int	x = `1`,
		int	y = `1`,
		int	z = `1`,
		int	t = `1`,
		float	sx = `1`,
		float	sy = `1`,
		float	sz = `1`,
		float	st = `1`
	)

inline

Definition at line 49 of file fdfheader.h.

◆ ~FdfHeader()

virtual aims::FdfHeader::~FdfHeader ( )

inlinevirtual

Definition at line 57 of file fdfheader.h.

Member Function Documentation

◆ dataType()

std::string aims::FdfHeader::dataType ( ) const

inline

Get type of items ("U08", "S08", "U16", "S16", ...)

Definition at line 70 of file fdfheader.h.

◆ dimT()

int aims::FdfHeader::dimT ( ) const

inline

Definition at line 62 of file fdfheader.h.

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

◆ dimX()

int aims::FdfHeader::dimX ( ) const

inline

Definition at line 59 of file fdfheader.h.

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

◆ dimY()

int aims::FdfHeader::dimY ( ) const

inline

Definition at line 60 of file fdfheader.h.

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

◆ dimZ()

int aims::FdfHeader::dimZ ( ) const

inline

Definition at line 61 of file fdfheader.h.

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

◆ extension()

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

inlinevirtual

standard file format extension of specialized headers

Reimplemented from aims::Header.

Definition at line 76 of file fdfheader.h.

◆ extensions()

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

virtual

possible filename extensions for specialized formats

Reimplemented from aims::Header.

◆ getFiles()

virtual std::set<std::string> aims::FdfHeader::getFiles ( std::string filename ) const

protectedvirtual

◆ inputFilenames()

virtual std::vector<std::string> aims::FdfHeader::inputFilenames ( )

virtual

Reimplemented from aims::SliceFormatHeader.

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

◆ name()

std::string aims::FdfHeader::name ( ) const

inline

Get the file name of the header.

Definition at line 73 of file fdfheader.h.

◆ possibleDataTypes()

std::vector<std::string> aims::FdfHeader::possibleDataTypes ( ) const

◆ read()

void aims::FdfHeader::read ( )

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

◆ readProcPar()

void aims::FdfHeader::readProcPar ( std::string name )

◆ setType()

void aims::FdfHeader::setType ( const std::string & t )

◆ sizeT()

float aims::FdfHeader::sizeT ( ) const

inline

Definition at line 67 of file fdfheader.h.

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

◆ sizeX()

float aims::FdfHeader::sizeX ( ) const

inline

Definition at line 64 of file fdfheader.h.

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

◆ sizeY()

float aims::FdfHeader::sizeY ( ) const

inline

Definition at line 65 of file fdfheader.h.

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

◆ sizeZ()

float aims::FdfHeader::sizeZ ( ) const

inline

Definition at line 66 of file fdfheader.h.

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

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

aims/io/fdfheader.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FdfHeader()

◆ ~FdfHeader()

Member Function Documentation

◆ dataType()

◆ dimT()

◆ dimX()

◆ dimY()

◆ dimZ()

◆ extension()

◆ extensions()

◆ getFiles()

◆ inputFilenames()

◆ name()

◆ possibleDataTypes()

◆ read()

◆ readProcPar()

◆ setType()

◆ sizeT()

◆ sizeX()

◆ sizeY()

◆ sizeZ()