aims::SliceFormatHeader Class Reference

Header used for 2D image formats. More...

#include <aims/data/sliceformatheader.h>

Inheritance diagram for aims::SliceFormatHeader:

Collaboration diagram for aims::SliceFormatHeader:

Public Member Functions
	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 >	inputFilenames ()
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
	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

Protected Attributes
std::string	_name

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

Header used for 2D image formats.

It contains a mechanism to retreive a list of slices / frames to build a 3D or 4D volume from a files list from the .minf attributes

Definition at line 47 of file sliceformatheader.h.

Constructor & Destructor Documentation

SliceFormatHeader()

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
	)

~SliceFormatHeader()

virtual aims::SliceFormatHeader::~SliceFormatHeader ( )

virtual

Member Function Documentation

filename()

std::string aims::SliceFormatHeader::filename

(

)

const

inputFilenames()

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

virtual

Reimplemented in aims::FdfHeader.

Referenced by aims::JpegReader< T >::read(), and aims::TiffReader< T >::read().

inputNamepattern()

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

outputFilenames()

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

virtual

Member Data Documentation

_name

std::string aims::SliceFormatHeader::_name

protected

Definition at line 63 of file sliceformatheader.h.

Referenced by aims::TiffHeader::name().

---

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

• aims/data/sliceformatheader.h