openCARP
Doxygen code documentation for the open cardiac electrophysiology simulator openCARP
Public Member Functions | List of all members
IGBheader Class Reference

#include <IGBheader.h>

Collaboration diagram for IGBheader:

Public Member Functions

 IGBheader (gzFile a=NULL, bool read=false, bool quiet=false)
 
 IGBheader (FILE *f, bool read=false, bool quiet=false)
 
 IGBheader (IGBheader *h)
 
 ~IGBheader ()
 
int write ()
 
int read (bool quiet=false)
 
void fileptr (gzFile f)
 
void fileptr (FILE *f)
 
void * fileptr (void)
 
void close (void)
 
void swab (void *, int nd=-1)
 
double from_raw (double a)
 
double to_raw (double a)
 
size_t slice_sz ()
 
int go2slice (size_t s)
 go to a slice More...
 
void comment (const char *)
 
char ** comment (void)
 
size_t data_size (void)
 
size_t x (void)
 
size_t x (bool &set)
 
void x (size_t a)
 
size_t y (void)
 
size_t y (bool &set)
 
void y (size_t a)
 
size_t z (void)
 
size_t z (bool &set)
 
void z (size_t a)
 
size_t t (void)
 
size_t t (bool &set)
 
void t (size_t a)
 
int type (void)
 
int type (bool &set)
 
void type (int a)
 
void type (char *)
 
int taille (void)
 
int taille (bool &set)
 
void taille (int a)
 
int num (void)
 
int num (bool &set)
 
void num (int a)
 
int bin (void)
 
int bin (bool &set)
 
void bin (int a)
 
int trame (void)
 
int trame (bool &set)
 
void trame (int a)
 
const char * systemestr (void)
 
int systeme (void)
 
void systeme (const char *s)
 
unsigned int lut (void)
 
unsigned int lut (bool &set)
 
void lut (unsigned int a)
 
unsigned int comp (void)
 
unsigned int comp (bool &set)
 
void comp (unsigned int a)
 
float epais (void)
 
float epais (bool &set)
 
void epais (float a)
 
float org_x (void)
 
float org_x (bool &set)
 
void org_x (float a)
 
float org_y (void)
 
float org_y (bool &set)
 
void org_y (float a)
 
float org_z (void)
 
float org_z (bool &set)
 
void org_z (float a)
 
float org_t (void)
 
float org_t (bool &set)
 
void org_t (float a)
 
void inc_x (float a)
 
float inc_x (bool &set)
 
float inc_x (void)
 
void inc_y (float a)
 
float inc_y (bool &set)
 
float inc_y (void)
 
void inc_z (float a)
 
float inc_z (bool &set)
 
float inc_z (void)
 
void inc_t (float a)
 
float inc_t (bool &set)
 
float inc_t (void)
 
void dim_x (float a)
 
float dim_x (bool &set)
 
float dim_x (void)
 
void dim_y (float a)
 
float dim_y (bool &set)
 
float dim_y (void)
 
void dim_z (float a)
 
float dim_z (bool &set)
 
float dim_z (void)
 
void dim_t (float a)
 
float dim_t (bool &set)
 
float dim_t (void)
 
void facteur (float a)
 
float facteur (bool &set)
 
float facteur (void)
 
void zero (float a)
 
float zero (bool &set)
 
float zero (void)
 
void vect_z (float *a)
 
float * vect_z (bool &set)
 
float * vect_z (void)
 
void unites_x (const char *a)
 
char * unites_x (bool &set)
 
char * unites_x (void)
 
void unites_y (const char *a)
 
char * unites_y (bool &set)
 
char * unites_y (void)
 
void unites_z (const char *a)
 
char * unites_z (bool &set)
 
char * unites_z (void)
 
void unites_t (const char *a)
 
char * unites_t (bool &set)
 
char * unites_t (void)
 
void unites (const char *a)
 
char * unites (bool &set)
 
char * unites (void)
 
void struct_desc (const char *a)
 
char * struct_desc (bool &set)
 
char * struct_desc (void)
 
void aut_name (const char *a)
 
char * aut_name (bool &set)
 
char * aut_name (void)
 
void transparent (void *a)
 
void * transparent (bool &set)
 
void * transparent (void)
 
char * transparentstr (void)
 
unsigned short num_components ()
 
int endian ()
 
long tell ()
 
template<class T >
int read_data (T *dp, size_t numt=1, char *buf=NULL)
 
template<class T >
void write_data (T *dp, size_t numt=1, char *buf=NULL)
 
template<class T >
void to_bin (void *buf, T d)
 
template<class T >
void to_bin (void *buf, T *d)
 
template<class T >
convert_buffer_datum (void *buf, int a)
 

Detailed Description

Definition at line 193 of file IGBheader.h.

Constructor & Destructor Documentation

◆ IGBheader() [1/3]

IGBheader::IGBheader ( gzFile  a = NULL,
bool  read = false,
bool  quiet = false 
)

Definition at line 315 of file IGBheader.cc.

◆ IGBheader() [2/3]

IGBheader::IGBheader ( FILE *  f,
bool  read = false,
bool  quiet = false 
)

Definition at line 306 of file IGBheader.cc.

◆ IGBheader() [3/3]

IGBheader::IGBheader ( IGBheader h)
inline

Definition at line 252 of file IGBheader.h.

◆ ~IGBheader()

IGBheader::~IGBheader ( )

Definition at line 324 of file IGBheader.cc.

Member Function Documentation

◆ aut_name() [1/3]

void IGBheader::aut_name ( const char *  a)
inline

Definition at line 371 of file IGBheader.h.

Here is the caller graph for this function:

◆ aut_name() [2/3]

char* IGBheader::aut_name ( bool &  set)
inline

Definition at line 372 of file IGBheader.h.

◆ aut_name() [3/3]

char* IGBheader::aut_name ( void  )
inline

Definition at line 373 of file IGBheader.h.

◆ bin() [1/3]

int IGBheader::bin ( void  )
inline

Definition at line 290 of file IGBheader.h.

◆ bin() [2/3]

int IGBheader::bin ( bool &  set)
inline

Definition at line 291 of file IGBheader.h.

◆ bin() [3/3]

void IGBheader::bin ( int  a)
inline

Definition at line 292 of file IGBheader.h.

◆ close()

void IGBheader::close ( void  )
inline

Definition at line 259 of file IGBheader.h.

Here is the caller graph for this function:

◆ comment() [1/2]

void IGBheader::comment ( const char *  ligne)

Definition at line 1239 of file IGBheader.cc.

Here is the caller graph for this function:

◆ comment() [2/2]

char** IGBheader::comment ( void  )
inline

Definition at line 266 of file IGBheader.h.

◆ comp() [1/3]

unsigned int IGBheader::comp ( void  )
inline

Definition at line 302 of file IGBheader.h.

◆ comp() [2/3]

unsigned int IGBheader::comp ( bool &  set)
inline

Definition at line 303 of file IGBheader.h.

◆ comp() [3/3]

void IGBheader::comp ( unsigned int  a)
inline

Definition at line 304 of file IGBheader.h.

◆ convert_buffer_datum()

template<class T >
T IGBheader::convert_buffer_datum ( void *  buf,
int  a 
)

convert the IGB data to the proper type

Parameters
hIGB header
bufraw IGB data
aindex of datum

Definition at line 466 of file IGBheader.h.

◆ data_size()

size_t IGBheader::data_size ( void  )
inline

Definition at line 267 of file IGBheader.h.

Here is the caller graph for this function:

◆ dim_t() [1/3]

void IGBheader::dim_t ( float  a)
inline

Definition at line 341 of file IGBheader.h.

Here is the caller graph for this function:

◆ dim_t() [2/3]

float IGBheader::dim_t ( bool &  set)
inline

Definition at line 342 of file IGBheader.h.

◆ dim_t() [3/3]

float IGBheader::dim_t ( void  )
inline

Definition at line 343 of file IGBheader.h.

◆ dim_x() [1/3]

void IGBheader::dim_x ( float  a)
inline

Definition at line 332 of file IGBheader.h.

Here is the caller graph for this function:

◆ dim_x() [2/3]

float IGBheader::dim_x ( bool &  set)
inline

Definition at line 333 of file IGBheader.h.

◆ dim_x() [3/3]

float IGBheader::dim_x ( void  )
inline

Definition at line 334 of file IGBheader.h.

◆ dim_y() [1/3]

void IGBheader::dim_y ( float  a)
inline

Definition at line 335 of file IGBheader.h.

Here is the caller graph for this function:

◆ dim_y() [2/3]

float IGBheader::dim_y ( bool &  set)
inline

Definition at line 336 of file IGBheader.h.

◆ dim_y() [3/3]

float IGBheader::dim_y ( void  )
inline

Definition at line 337 of file IGBheader.h.

◆ dim_z() [1/3]

void IGBheader::dim_z ( float  a)
inline

Definition at line 338 of file IGBheader.h.

Here is the caller graph for this function:

◆ dim_z() [2/3]

float IGBheader::dim_z ( bool &  set)
inline

Definition at line 339 of file IGBheader.h.

◆ dim_z() [3/3]

float IGBheader::dim_z ( void  )
inline

Definition at line 340 of file IGBheader.h.

◆ endian()

int IGBheader::endian ( )

return whether the machine is big or little endian

Definition at line 1391 of file IGBheader.cc.

◆ epais() [1/3]

float IGBheader::epais ( void  )
inline

Definition at line 305 of file IGBheader.h.

◆ epais() [2/3]

float IGBheader::epais ( bool &  set)
inline

Definition at line 306 of file IGBheader.h.

◆ epais() [3/3]

void IGBheader::epais ( float  a)
inline

Definition at line 307 of file IGBheader.h.

◆ facteur() [1/3]

void IGBheader::facteur ( float  a)
inline

Definition at line 344 of file IGBheader.h.

Here is the caller graph for this function:

◆ facteur() [2/3]

float IGBheader::facteur ( bool &  set)
inline

Definition at line 345 of file IGBheader.h.

◆ facteur() [3/3]

float IGBheader::facteur ( void  )
inline

Definition at line 346 of file IGBheader.h.

◆ fileptr() [1/3]

void IGBheader::fileptr ( gzFile  f)

Definition at line 329 of file IGBheader.cc.

Here is the caller graph for this function:

◆ fileptr() [2/3]

void IGBheader::fileptr ( FILE *  f)

Definition at line 336 of file IGBheader.cc.

◆ fileptr() [3/3]

void* IGBheader::fileptr ( void  )
inline

Definition at line 258 of file IGBheader.h.

◆ from_raw()

double IGBheader::from_raw ( double  a)
inline

Definition at line 261 of file IGBheader.h.

◆ go2slice()

int IGBheader::go2slice ( size_t  s)

go to a slice

Parameters
sthe slice number
Return values
0successful
-1unsuccessful

Definition at line 1459 of file IGBheader.cc.

Here is the caller graph for this function:

◆ inc_t() [1/3]

void IGBheader::inc_t ( float  a)
inline

Definition at line 329 of file IGBheader.h.

Here is the caller graph for this function:

◆ inc_t() [2/3]

float IGBheader::inc_t ( bool &  set)
inline

Definition at line 330 of file IGBheader.h.

◆ inc_t() [3/3]

float IGBheader::inc_t ( void  )
inline

Definition at line 331 of file IGBheader.h.

◆ inc_x() [1/3]

void IGBheader::inc_x ( float  a)
inline

Definition at line 320 of file IGBheader.h.

Here is the caller graph for this function:

◆ inc_x() [2/3]

float IGBheader::inc_x ( bool &  set)
inline

Definition at line 321 of file IGBheader.h.

◆ inc_x() [3/3]

float IGBheader::inc_x ( void  )
inline

Definition at line 322 of file IGBheader.h.

◆ inc_y() [1/3]

void IGBheader::inc_y ( float  a)
inline

Definition at line 323 of file IGBheader.h.

Here is the caller graph for this function:

◆ inc_y() [2/3]

float IGBheader::inc_y ( bool &  set)
inline

Definition at line 324 of file IGBheader.h.

◆ inc_y() [3/3]

float IGBheader::inc_y ( void  )
inline

Definition at line 325 of file IGBheader.h.

◆ inc_z() [1/3]

void IGBheader::inc_z ( float  a)
inline

Definition at line 326 of file IGBheader.h.

Here is the caller graph for this function:

◆ inc_z() [2/3]

float IGBheader::inc_z ( bool &  set)
inline

Definition at line 327 of file IGBheader.h.

◆ inc_z() [3/3]

float IGBheader::inc_z ( void  )
inline

Definition at line 328 of file IGBheader.h.

◆ lut() [1/3]

unsigned int IGBheader::lut ( void  )
inline

Definition at line 299 of file IGBheader.h.

◆ lut() [2/3]

unsigned int IGBheader::lut ( bool &  set)
inline

Definition at line 300 of file IGBheader.h.

◆ lut() [3/3]

void IGBheader::lut ( unsigned int  a)
inline

Definition at line 301 of file IGBheader.h.

◆ num() [1/3]

int IGBheader::num ( void  )
inline

Definition at line 287 of file IGBheader.h.

◆ num() [2/3]

int IGBheader::num ( bool &  set)
inline

Definition at line 288 of file IGBheader.h.

◆ num() [3/3]

void IGBheader::num ( int  a)
inline

Definition at line 289 of file IGBheader.h.

◆ num_components()

unsigned short IGBheader::num_components ( )
inline

Definition at line 378 of file IGBheader.h.

Here is the caller graph for this function:

◆ org_t() [1/3]

float IGBheader::org_t ( void  )
inline

Definition at line 317 of file IGBheader.h.

Here is the caller graph for this function:

◆ org_t() [2/3]

float IGBheader::org_t ( bool &  set)
inline

Definition at line 318 of file IGBheader.h.

◆ org_t() [3/3]

void IGBheader::org_t ( float  a)
inline

Definition at line 319 of file IGBheader.h.

◆ org_x() [1/3]

float IGBheader::org_x ( void  )
inline

Definition at line 308 of file IGBheader.h.

Here is the caller graph for this function:

◆ org_x() [2/3]

float IGBheader::org_x ( bool &  set)
inline

Definition at line 309 of file IGBheader.h.

◆ org_x() [3/3]

void IGBheader::org_x ( float  a)
inline

Definition at line 310 of file IGBheader.h.

◆ org_y() [1/3]

float IGBheader::org_y ( void  )
inline

Definition at line 311 of file IGBheader.h.

Here is the caller graph for this function:

◆ org_y() [2/3]

float IGBheader::org_y ( bool &  set)
inline

Definition at line 312 of file IGBheader.h.

◆ org_y() [3/3]

void IGBheader::org_y ( float  a)
inline

Definition at line 313 of file IGBheader.h.

◆ org_z() [1/3]

float IGBheader::org_z ( void  )
inline

Definition at line 314 of file IGBheader.h.

Here is the caller graph for this function:

◆ org_z() [2/3]

float IGBheader::org_z ( bool &  set)
inline

Definition at line 315 of file IGBheader.h.

◆ org_z() [3/3]

void IGBheader::org_z ( float  a)
inline

Definition at line 316 of file IGBheader.h.

◆ read()

int IGBheader::read ( bool  quiet = false)

read in a header

Parameters
quietdo not print warnings/errors
Returns
0 if and only if all is o.k.
Precondition
the file has been opened

Definition at line 757 of file IGBheader.cc.

Here is the caller graph for this function:

◆ read_data()

template<class T >
int IGBheader::read_data ( T *  dp,
size_t  numt = 1,
char *  buf = NULL 
)

read in a number of time slices

Parameters
dp[out]values read
numtnumber of time slices
buftemporary buffer of raw data
Precondition
dp must be allocated
Postcondition
will be filled
Returns
the number of items read

Definition at line 431 of file IGBheader.h.

Here is the caller graph for this function:

◆ slice_sz()

size_t IGBheader::slice_sz ( )
inline

Definition at line 263 of file IGBheader.h.

Here is the caller graph for this function:

◆ struct_desc() [1/3]

void IGBheader::struct_desc ( const char *  a)
inline

Definition at line 368 of file IGBheader.h.

◆ struct_desc() [2/3]

char* IGBheader::struct_desc ( bool &  set)
inline

Definition at line 369 of file IGBheader.h.

◆ struct_desc() [3/3]

char* IGBheader::struct_desc ( void  )
inline

Definition at line 370 of file IGBheader.h.

◆ swab()

void IGBheader::swab ( void *  data,
int  nd = -1 
)

swap bytes ]]

Parameters
datadata buffer
ndnumber of items in buffer

Definition at line 1337 of file IGBheader.cc.

◆ systeme() [1/2]

int IGBheader::systeme ( void  )
inline

Definition at line 297 of file IGBheader.h.

Here is the caller graph for this function:

◆ systeme() [2/2]

void IGBheader::systeme ( const char *  s)

Definition at line 1278 of file IGBheader.cc.

◆ systemestr()

const char * IGBheader::systemestr ( void  )

Definition at line 1263 of file IGBheader.cc.

Here is the caller graph for this function:

◆ t() [1/3]

size_t IGBheader::t ( void  )
inline

Definition at line 277 of file IGBheader.h.

Here is the caller graph for this function:

◆ t() [2/3]

size_t IGBheader::t ( bool &  set)
inline

Definition at line 278 of file IGBheader.h.

◆ t() [3/3]

void IGBheader::t ( size_t  a)
inline

Definition at line 279 of file IGBheader.h.

◆ taille() [1/3]

int IGBheader::taille ( void  )
inline

Definition at line 284 of file IGBheader.h.

◆ taille() [2/3]

int IGBheader::taille ( bool &  set)
inline

Definition at line 285 of file IGBheader.h.

◆ taille() [3/3]

void IGBheader::taille ( int  a)
inline

Definition at line 286 of file IGBheader.h.

◆ tell()

long IGBheader::tell ( )

Definition at line 1306 of file IGBheader.cc.

◆ to_bin() [1/2]

template<class T >
void IGBheader::to_bin ( void *  buf,
d 
)

convert the data to the binary representation

Parameters
bufplace to put raw binary IGB data
ddatum

Definition at line 529 of file IGBheader.h.

Here is the caller graph for this function:

◆ to_bin() [2/2]

template<class T >
void IGBheader::to_bin ( void *  buf,
T *  d 
)

convert the data to the binary representation for vector types

Parameters
bufplace to put raw binary IGB data
ddatum

Definition at line 587 of file IGBheader.h.

◆ to_raw()

double IGBheader::to_raw ( double  a)
inline

Definition at line 262 of file IGBheader.h.

◆ trame() [1/3]

int IGBheader::trame ( void  )
inline

Definition at line 293 of file IGBheader.h.

◆ trame() [2/3]

int IGBheader::trame ( bool &  set)
inline

Definition at line 294 of file IGBheader.h.

◆ trame() [3/3]

void IGBheader::trame ( int  a)
inline

Definition at line 295 of file IGBheader.h.

◆ transparent() [1/3]

void IGBheader::transparent ( void *  a)
inline

Definition at line 374 of file IGBheader.h.

Here is the caller graph for this function:

◆ transparent() [2/3]

void* IGBheader::transparent ( bool &  set)
inline

Definition at line 375 of file IGBheader.h.

◆ transparent() [3/3]

void* IGBheader::transparent ( void  )
inline

Definition at line 376 of file IGBheader.h.

◆ transparentstr()

char* IGBheader::transparentstr ( void  )
inline

Definition at line 377 of file IGBheader.h.

Here is the caller graph for this function:

◆ type() [1/4]

int IGBheader::type ( void  )
inline

Definition at line 280 of file IGBheader.h.

Here is the caller graph for this function:

◆ type() [2/4]

int IGBheader::type ( bool &  set)
inline

Definition at line 281 of file IGBheader.h.

◆ type() [3/4]

void IGBheader::type ( int  a)
inline

Definition at line 282 of file IGBheader.h.

◆ type() [4/4]

void IGBheader::type ( char *  datatype)

Definition at line 1290 of file IGBheader.cc.

◆ unites() [1/3]

void IGBheader::unites ( const char *  a)
inline

Definition at line 365 of file IGBheader.h.

Here is the caller graph for this function:

◆ unites() [2/3]

char* IGBheader::unites ( bool &  set)
inline

Definition at line 366 of file IGBheader.h.

◆ unites() [3/3]

char* IGBheader::unites ( void  )
inline

Definition at line 367 of file IGBheader.h.

◆ unites_t() [1/3]

void IGBheader::unites_t ( const char *  a)
inline

Definition at line 362 of file IGBheader.h.

Here is the caller graph for this function:

◆ unites_t() [2/3]

char* IGBheader::unites_t ( bool &  set)
inline

Definition at line 363 of file IGBheader.h.

◆ unites_t() [3/3]

char* IGBheader::unites_t ( void  )
inline

Definition at line 364 of file IGBheader.h.

◆ unites_x() [1/3]

void IGBheader::unites_x ( const char *  a)
inline

Definition at line 353 of file IGBheader.h.

Here is the caller graph for this function:

◆ unites_x() [2/3]

char* IGBheader::unites_x ( bool &  set)
inline

Definition at line 354 of file IGBheader.h.

◆ unites_x() [3/3]

char* IGBheader::unites_x ( void  )
inline

Definition at line 355 of file IGBheader.h.

◆ unites_y() [1/3]

void IGBheader::unites_y ( const char *  a)
inline

Definition at line 356 of file IGBheader.h.

Here is the caller graph for this function:

◆ unites_y() [2/3]

char* IGBheader::unites_y ( bool &  set)
inline

Definition at line 357 of file IGBheader.h.

◆ unites_y() [3/3]

char* IGBheader::unites_y ( void  )
inline

Definition at line 358 of file IGBheader.h.

◆ unites_z() [1/3]

void IGBheader::unites_z ( const char *  a)
inline

Definition at line 359 of file IGBheader.h.

Here is the caller graph for this function:

◆ unites_z() [2/3]

char* IGBheader::unites_z ( bool &  set)
inline

Definition at line 360 of file IGBheader.h.

◆ unites_z() [3/3]

char* IGBheader::unites_z ( void  )
inline

Definition at line 361 of file IGBheader.h.

◆ vect_z() [1/3]

void IGBheader::vect_z ( float *  a)
inline

Definition at line 350 of file IGBheader.h.

◆ vect_z() [2/3]

float* IGBheader::vect_z ( bool &  set)
inline

Definition at line 351 of file IGBheader.h.

◆ vect_z() [3/3]

float* IGBheader::vect_z ( void  )
inline

Definition at line 352 of file IGBheader.h.

◆ write()

int IGBheader::write ( )

Definition at line 343 of file IGBheader.cc.

Here is the caller graph for this function:

◆ write_data()

template<class T >
void IGBheader::write_data ( T *  dp,
size_t  numt = 1,
char *  buf = NULL 
)

write out a number of time slices

Parameters
dp[in]buffer of data
numtnumber of time slices
buftemporary buffer of raw data

Definition at line 397 of file IGBheader.h.

Here is the caller graph for this function:

◆ x() [1/3]

size_t IGBheader::x ( void  )
inline

Definition at line 268 of file IGBheader.h.

Here is the caller graph for this function:

◆ x() [2/3]

size_t IGBheader::x ( bool &  set)
inline

Definition at line 269 of file IGBheader.h.

◆ x() [3/3]

void IGBheader::x ( size_t  a)
inline

Definition at line 270 of file IGBheader.h.

◆ y() [1/3]

size_t IGBheader::y ( void  )
inline

Definition at line 271 of file IGBheader.h.

Here is the caller graph for this function:

◆ y() [2/3]

size_t IGBheader::y ( bool &  set)
inline

Definition at line 272 of file IGBheader.h.

◆ y() [3/3]

void IGBheader::y ( size_t  a)
inline

Definition at line 273 of file IGBheader.h.

◆ z() [1/3]

size_t IGBheader::z ( void  )
inline

Definition at line 274 of file IGBheader.h.

Here is the caller graph for this function:

◆ z() [2/3]

size_t IGBheader::z ( bool &  set)
inline

Definition at line 275 of file IGBheader.h.

◆ z() [3/3]

void IGBheader::z ( size_t  a)
inline

Definition at line 276 of file IGBheader.h.

◆ zero() [1/3]

void IGBheader::zero ( float  a)
inline

Definition at line 347 of file IGBheader.h.

Here is the caller graph for this function:

◆ zero() [2/3]

float IGBheader::zero ( bool &  set)
inline

Definition at line 348 of file IGBheader.h.

◆ zero() [3/3]

float IGBheader::zero ( void  )
inline

Definition at line 349 of file IGBheader.h.


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