A.I.M.S


aims::GisHeader Class Reference

The descriptor class of the .dim GIS header. More...

#include <aims/io/gisheader.h>

Inheritance diagram for aims::GisHeader:
Collaboration diagram for aims::GisHeader:

Public Member Functions

Constructor and Destructor
 GisHeader (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, uint bo=AIMS_MAGIC_NUMBER, const std::string &openmode="binar")
 The constructor has 2 roles : either to give the name of an existing header, or to inform the class of the various GIS parameters. More...
 
virtual ~GisHeader ()
 Destructor does nothing. More...
 
Methods
int dimX () const
 Get dimension in X axis. More...
 
int dimY () const
 Get dimension in Y axis. More...
 
int dimZ () const
 Get dimension in Z axis. More...
 
int dimT () const
 Get dimension in T axis. More...
 
float sizeX () const
 Get resolution in X axis. More...
 
float sizeY () const
 Get resolution in Y axis. More...
 
float sizeZ () const
 Get resolution in Z axis. More...
 
float sizeT () const
 Get resolution in T axis. More...
 
std::string dataType () const
 Get type of items ("U08", "S08", "U16", "S16", ...) More...
 
std::string name () const
 Get the file name of the header. More...
 
uint byteOrder () const
 Get the byte order (magic uint number) More...
 
std::string openMode () const
 Get the open mode ("binar" or "ascii") More...
 
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 (carto::Object options=carto::none())
 Read the header. More...
 
void write (carto::Object options=carto::none())
 Write the header. More...
 
- 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 PythonHeaderoperator= (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 HeadercloneHeader (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
 
 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 std::string key () 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
 
 RCObject ()
 
 RCObject (const RCObject &)
 
RCObjectoperator= (const RCObject &)
 
virtual ~StringInterface ()
 
virtual bool operator== (const StringInterface &other) const
 
virtual bool operator!= (const StringInterface &other) const
 
virtual ~ScalarInterface ()
 
virtual bool operator== (const ScalarInterface &other) const
 
virtual bool operator!= (const ScalarInterface &other) const
 
virtual ~NoneInterface ()
 
- Public Member Functions inherited from carto::DynArrayInterface
virtual ~DynArrayInterface ()
 
- Public Member Functions inherited from carto::ArrayInterface
virtual ~ArrayInterface ()
 
virtual ~SizeInterface ()
 
virtual ~Interface ()
 
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::DictionaryIteratorInterface
virtual ~DictionaryIteratorInterface ()
 
virtual ~IteratorInterface ()
 
- 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::GenericObject
typedef int RefCounterType
 
- Static Public Member Functions inherited from aims::PythonHeader
static carto::SyntaxSetsyntax ()
 
- Protected Member Functions inherited from carto::GenericObject
virtual Interface_getGenericInterface ()=0
 
virtual const void * _getAddressOfValue () const =0
 

Detailed Description

The descriptor class of the .dim GIS header.

The programmer can either read an existing header, or write a new one.

Definition at line 52 of file gisheader.h.

Constructor & Destructor Documentation

aims::GisHeader::GisHeader ( 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,
uint  bo = AIMS_MAGIC_NUMBER,
const std::string &  openmode = "binar" 
)
inline

The constructor has 2 roles : either to give the name of an existing header, or to inform the class of the various GIS parameters.

Parameters
namefile name
typestring code of the type of the items [default="UNKNOWN"]
xdimension of X axis [default=1]
ydimension of Y axis [default=1]
zdimension of Z axis [default=1]
tdimension of T axis [default=1]
sxresolution of X axis [default=1.0]
syresolution of Y axis [default=1.0]
szresolution of Z axis [default=1.0]
stresolution of T axis [default=1.0]
bobyte order [default=none]
omopen mode "ascii" or "binar" [default="binar"]

Definition at line 72 of file gisheader.h.

virtual aims::GisHeader::~GisHeader ( )
inlinevirtual

Destructor does nothing.

Definition at line 85 of file gisheader.h.

Member Function Documentation

uint aims::GisHeader::byteOrder ( ) const
inline

Get the byte order (magic uint number)

Definition at line 114 of file gisheader.h.

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

std::string aims::GisHeader::dataType ( ) const
inline

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

Definition at line 109 of file gisheader.h.

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

int aims::GisHeader::dimT ( ) const
inline

Get dimension in T axis.

Definition at line 97 of file gisheader.h.

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

int aims::GisHeader::dimX ( ) const
inline

Get dimension in X axis.

Definition at line 91 of file gisheader.h.

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

int aims::GisHeader::dimY ( ) const
inline

Get dimension in Y axis.

Definition at line 93 of file gisheader.h.

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

int aims::GisHeader::dimZ ( ) const
inline

Get dimension in Z axis.

Definition at line 95 of file gisheader.h.

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

virtual std::string aims::GisHeader::extension ( ) const
inlinevirtual

standard file format extension of specialized headers

Reimplemented from aims::Header.

Definition at line 119 of file gisheader.h.

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

possible filename extensions for specialized formats

Reimplemented from aims::Header.

std::string aims::GisHeader::name ( ) const
inline

Get the file name of the header.

Definition at line 111 of file gisheader.h.

std::string aims::GisHeader::openMode ( ) const
inline

Get the open mode ("binar" or "ascii")

Definition at line 117 of file gisheader.h.

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

void aims::GisHeader::read ( carto::Object  options = carto::none())

Read the header.

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

float aims::GisHeader::sizeT ( ) const
inline

Get resolution in T axis.

Definition at line 106 of file gisheader.h.

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

float aims::GisHeader::sizeX ( ) const
inline

Get resolution in X axis.

Definition at line 100 of file gisheader.h.

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

float aims::GisHeader::sizeY ( ) const
inline

Get resolution in Y axis.

Definition at line 102 of file gisheader.h.

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

float aims::GisHeader::sizeZ ( ) const
inline

Get resolution in Z axis.

Definition at line 104 of file gisheader.h.

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

void aims::GisHeader::write ( carto::Object  options = carto::none())

Write the header.


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