opencarp::IGBheader Class Reference

#include <IGBheader.h>

Collaboration diagram for opencarp::IGBheader:

Public Member Functions
	IGBheader (FILE *f=NULL, bool read=false, bool quiet=false)
	IGBheader (IGBheader *h)
	~IGBheader ()
int	write ()
int	read (bool quiet=false)
void	fileptr (FILE *f)
FILE *	fileptr (void)
void	close (void)
void	swab (void *, int nd=-1)
double	from_raw (double a)
double	to_raw (double a)
int	slice_sz ()
void	comment (char *)
char **	comment (void)
int	data_size (void)
int	x (void)
int	x (bool &set)
void	x (int a)
int	y (void)
int	y (bool &set)
void	y (int a)
int	z (void)
int	z (bool &set)
void	z (int a)
int	t (void)
int	t (bool &set)
void	t (int 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)
int	num_components ()
int	endian ()
template<class T >
int	read_data (T *dp, int numt=1, char *buf=NULL)
template<class T >
void	write_data (T *dp, int numt=1, char *buf=NULL)
template<class T >
void	to_bin (void *buf, T d)
template<class T >
T	convert_buffer_datum (void *buf, int a)

Detailed Description

Definition at line 188 of file IGBheader.h.

Constructor & Destructor Documentation

IGBheader() [1/2]

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

Definition at line 313 of file IGBheader.cc.

IGBheader() [2/2]

opencarp::IGBheader::IGBheader ( IGBheader *  h )

inline

Definition at line 242 of file IGBheader.h.

~IGBheader()

IGBheader::~IGBheader

(

)

Definition at line 322 of file IGBheader.cc.

Member Function Documentation

aut_name() [1/3]

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

inline

Definition at line 360 of file IGBheader.h.

aut_name() [2/3]

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

inline

Definition at line 359 of file IGBheader.h.

aut_name() [3/3]

char* opencarp::IGBheader::aut_name ( void  )

inline

Definition at line 361 of file IGBheader.h.

bin() [1/3]

int opencarp::IGBheader::bin ( bool &  set )

inline

Definition at line 279 of file IGBheader.h.

bin() [2/3]

void opencarp::IGBheader::bin ( int  a )

inline

Definition at line 280 of file IGBheader.h.

bin() [3/3]

int opencarp::IGBheader::bin ( void  )

inline

Definition at line 278 of file IGBheader.h.

close()

void opencarp::IGBheader::close ( void  )

inline

Definition at line 248 of file IGBheader.h.

comment() [1/2]

void IGBheader::comment

(

char *

ligne

)

Definition at line 1215 of file IGBheader.cc.

comment() [2/2]

char** opencarp::IGBheader::comment ( void  )

inline

Definition at line 254 of file IGBheader.h.

comp() [1/3]

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

inline

Definition at line 291 of file IGBheader.h.

comp() [2/3]

void opencarp::IGBheader::comp ( unsigned int  a )

inline

Definition at line 292 of file IGBheader.h.

comp() [3/3]

unsigned int opencarp::IGBheader::comp ( void  )

inline

Definition at line 290 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

h	IGB header
buf	raw IGB data
a	index of datum

Definition at line 445 of file IGBheader.h.

data_size()

int opencarp::IGBheader::data_size ( void  )

inline

Definition at line 255 of file IGBheader.h.

Here is the caller graph for this function:

dim_t() [1/3]

float opencarp::IGBheader::dim_t ( bool &  set )

inline

Definition at line 330 of file IGBheader.h.

dim_t() [2/3]

void opencarp::IGBheader::dim_t ( float  a )

inline

Definition at line 329 of file IGBheader.h.

Here is the caller graph for this function:

dim_t() [3/3]

float opencarp::IGBheader::dim_t ( void  )

inline

Definition at line 331 of file IGBheader.h.

dim_x() [1/3]

float opencarp::IGBheader::dim_x ( bool &  set )

inline

Definition at line 321 of file IGBheader.h.

dim_x() [2/3]

void opencarp::IGBheader::dim_x ( float  a )

inline

Definition at line 320 of file IGBheader.h.

Here is the caller graph for this function:

dim_x() [3/3]

float opencarp::IGBheader::dim_x ( void  )

inline

Definition at line 322 of file IGBheader.h.

dim_y() [1/3]

float opencarp::IGBheader::dim_y ( bool &  set )

inline

Definition at line 324 of file IGBheader.h.

dim_y() [2/3]

void opencarp::IGBheader::dim_y ( float  a )

inline

Definition at line 323 of file IGBheader.h.

dim_y() [3/3]

float opencarp::IGBheader::dim_y ( void  )

inline

Definition at line 325 of file IGBheader.h.

dim_z() [1/3]

float opencarp::IGBheader::dim_z ( bool &  set )

inline

Definition at line 327 of file IGBheader.h.

dim_z() [2/3]

void opencarp::IGBheader::dim_z ( float  a )

inline

Definition at line 326 of file IGBheader.h.

dim_z() [3/3]

float opencarp::IGBheader::dim_z ( void  )

inline

Definition at line 328 of file IGBheader.h.

endian()

int IGBheader::endian

(

)

return whether the machine is big or little endian

Definition at line 1347 of file IGBheader.cc.

Here is the caller graph for this function:

epais() [1/3]

float opencarp::IGBheader::epais ( bool &  set )

inline

Definition at line 294 of file IGBheader.h.

epais() [2/3]

void opencarp::IGBheader::epais ( float  a )

inline

Definition at line 295 of file IGBheader.h.

epais() [3/3]

float opencarp::IGBheader::epais ( void  )

inline

Definition at line 293 of file IGBheader.h.

facteur() [1/3]

float opencarp::IGBheader::facteur ( bool &  set )

inline

Definition at line 333 of file IGBheader.h.

facteur() [2/3]

void opencarp::IGBheader::facteur ( float  a )

inline

Definition at line 332 of file IGBheader.h.

facteur() [3/3]

float opencarp::IGBheader::facteur ( void  )

inline

Definition at line 334 of file IGBheader.h.

fileptr() [1/2]

void IGBheader::fileptr

(

FILE *

f

)

Definition at line 327 of file IGBheader.cc.

Here is the caller graph for this function:

fileptr() [2/2]

FILE* opencarp::IGBheader::fileptr ( void  )

inline

Definition at line 247 of file IGBheader.h.

from_raw()

double opencarp::IGBheader::from_raw ( double  a )

inline

Definition at line 250 of file IGBheader.h.

Here is the caller graph for this function:

inc_t() [1/3]

float opencarp::IGBheader::inc_t ( bool &  set )

inline

Definition at line 318 of file IGBheader.h.

inc_t() [2/3]

void opencarp::IGBheader::inc_t ( float  a )

inline

Definition at line 317 of file IGBheader.h.

Here is the caller graph for this function:

inc_t() [3/3]

float opencarp::IGBheader::inc_t ( void  )

inline

Definition at line 319 of file IGBheader.h.

inc_x() [1/3]

float opencarp::IGBheader::inc_x ( bool &  set )

inline

Definition at line 309 of file IGBheader.h.

inc_x() [2/3]

void opencarp::IGBheader::inc_x ( float  a )

inline

Definition at line 308 of file IGBheader.h.

Here is the caller graph for this function:

inc_x() [3/3]

float opencarp::IGBheader::inc_x ( void  )

inline

Definition at line 310 of file IGBheader.h.

inc_y() [1/3]

float opencarp::IGBheader::inc_y ( bool &  set )

inline

Definition at line 312 of file IGBheader.h.

inc_y() [2/3]

void opencarp::IGBheader::inc_y ( float  a )

inline

Definition at line 311 of file IGBheader.h.

inc_y() [3/3]

float opencarp::IGBheader::inc_y ( void  )

inline

Definition at line 313 of file IGBheader.h.

inc_z() [1/3]

float opencarp::IGBheader::inc_z ( bool &  set )

inline

Definition at line 315 of file IGBheader.h.

inc_z() [2/3]

void opencarp::IGBheader::inc_z ( float  a )

inline

Definition at line 314 of file IGBheader.h.

inc_z() [3/3]

float opencarp::IGBheader::inc_z ( void  )

inline

Definition at line 316 of file IGBheader.h.

lut() [1/3]

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

inline

Definition at line 288 of file IGBheader.h.

lut() [2/3]

void opencarp::IGBheader::lut ( unsigned int  a )

inline

Definition at line 289 of file IGBheader.h.

lut() [3/3]

unsigned int opencarp::IGBheader::lut ( void  )

inline

Definition at line 287 of file IGBheader.h.

num() [1/3]

int opencarp::IGBheader::num ( bool &  set )

inline

Definition at line 276 of file IGBheader.h.

num() [2/3]

void opencarp::IGBheader::num ( int  a )

inline

Definition at line 277 of file IGBheader.h.

num() [3/3]

int opencarp::IGBheader::num ( void  )

inline

Definition at line 275 of file IGBheader.h.

num_components()

int opencarp::IGBheader::num_components ( )

inline

Definition at line 366 of file IGBheader.h.

Here is the caller graph for this function:

org_t() [1/3]

float opencarp::IGBheader::org_t ( bool &  set )

inline

Definition at line 306 of file IGBheader.h.

org_t() [2/3]

void opencarp::IGBheader::org_t ( float  a )

inline

Definition at line 307 of file IGBheader.h.

org_t() [3/3]

float opencarp::IGBheader::org_t ( void  )

inline

Definition at line 305 of file IGBheader.h.

org_x() [1/3]

float opencarp::IGBheader::org_x ( bool &  set )

inline

Definition at line 297 of file IGBheader.h.

org_x() [2/3]

void opencarp::IGBheader::org_x ( float  a )

inline

Definition at line 298 of file IGBheader.h.

org_x() [3/3]

float opencarp::IGBheader::org_x ( void  )

inline

Definition at line 296 of file IGBheader.h.

org_y() [1/3]

float opencarp::IGBheader::org_y ( bool &  set )

inline

Definition at line 300 of file IGBheader.h.

org_y() [2/3]

void opencarp::IGBheader::org_y ( float  a )

inline

Definition at line 301 of file IGBheader.h.

org_y() [3/3]

float opencarp::IGBheader::org_y ( void  )

inline

Definition at line 299 of file IGBheader.h.

org_z() [1/3]

float opencarp::IGBheader::org_z ( bool &  set )

inline

Definition at line 303 of file IGBheader.h.

org_z() [2/3]

void opencarp::IGBheader::org_z ( float  a )

inline

Definition at line 304 of file IGBheader.h.

org_z() [3/3]

float opencarp::IGBheader::org_z ( void  )

inline

Definition at line 302 of file IGBheader.h.

read()

int IGBheader::read

(

bool

quiet = false

)

read in a header

Parameters

quiet

do not print warnings/errors

Returns

0 if and only if all is o.k.

Precondition

the file has been opened

Definition at line 732 of file IGBheader.cc.

Here is the caller graph for this function:

read_data()

template<class T >

int IGBheader::read_data	(	T *	dp,
		int	numt = 1,
		char *	buf = NULL
	)

read in a number of time slices

Parameters

dp[out]	values read
numt	number of time slices
buf	temporary buffer of raw data

Precondition

dp must be allocated

Postcondition

\dp will be filled

Returns

the number of items read

Definition at line 414 of file IGBheader.h.

slice_sz()

int opencarp::IGBheader::slice_sz ( )

inline

Definition at line 252 of file IGBheader.h.

Here is the caller graph for this function:

struct_desc() [1/3]

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

inline

Definition at line 357 of file IGBheader.h.

struct_desc() [2/3]

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

inline

Definition at line 356 of file IGBheader.h.

struct_desc() [3/3]

char* opencarp::IGBheader::struct_desc ( void  )

inline

Definition at line 358 of file IGBheader.h.

swab()

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

swap bytes ]]

Parameters

data	data buffer
nd	number of items in buffer

Definition at line 1293 of file IGBheader.cc.

Here is the caller graph for this function:

systeme() [1/2]

void IGBheader::systeme

(

const char *

s

)

Definition at line 1249 of file IGBheader.cc.

systeme() [2/2]

int opencarp::IGBheader::systeme ( void  )

inline

Definition at line 285 of file IGBheader.h.

Here is the caller graph for this function:

systemestr()

const char * IGBheader::systemestr

(

void

)

Definition at line 1234 of file IGBheader.cc.

t() [1/3]

int opencarp::IGBheader::t ( bool &  set )

inline

Definition at line 266 of file IGBheader.h.

t() [2/3]

void opencarp::IGBheader::t ( int  a )

inline

Definition at line 267 of file IGBheader.h.

t() [3/3]

int opencarp::IGBheader::t ( void  )

inline

Definition at line 265 of file IGBheader.h.

Here is the caller graph for this function:

taille() [1/3]

int opencarp::IGBheader::taille ( bool &  set )

inline

Definition at line 273 of file IGBheader.h.

taille() [2/3]

void opencarp::IGBheader::taille ( int  a )

inline

Definition at line 274 of file IGBheader.h.

taille() [3/3]

int opencarp::IGBheader::taille ( void  )

inline

Definition at line 272 of file IGBheader.h.

to_bin()

template<class T >

void IGBheader::to_bin	(	void *	buf,
		T	d
	)

convert the data to the binary representation

Parameters

buf	place to put raw binary IGB data
d	datum

Definition at line 510 of file IGBheader.h.

to_raw()

double opencarp::IGBheader::to_raw ( double  a )

inline

Definition at line 251 of file IGBheader.h.

Here is the caller graph for this function:

trame() [1/3]

int opencarp::IGBheader::trame ( bool &  set )

inline

Definition at line 282 of file IGBheader.h.

trame() [2/3]

void opencarp::IGBheader::trame ( int  a )

inline

Definition at line 283 of file IGBheader.h.

trame() [3/3]

int opencarp::IGBheader::trame ( void  )

inline

Definition at line 281 of file IGBheader.h.

transparent() [1/3]

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

inline

Definition at line 363 of file IGBheader.h.

transparent() [2/3]

void opencarp::IGBheader::transparent ( void *  a )

inline

Definition at line 362 of file IGBheader.h.

transparent() [3/3]

void* opencarp::IGBheader::transparent ( void  )

inline

Definition at line 364 of file IGBheader.h.

transparentstr()

char* opencarp::IGBheader::transparentstr ( void  )

inline

Definition at line 365 of file IGBheader.h.

type() [1/4]

int opencarp::IGBheader::type ( bool &  set )

inline

Definition at line 269 of file IGBheader.h.

type() [2/4]

void IGBheader::type

(

char *

datatype

)

Definition at line 1261 of file IGBheader.cc.

type() [3/4]

void opencarp::IGBheader::type ( int  a )

inline

Definition at line 270 of file IGBheader.h.

type() [4/4]

int opencarp::IGBheader::type ( void  )

inline

Definition at line 268 of file IGBheader.h.

Here is the caller graph for this function:

unites() [1/3]

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

inline

Definition at line 354 of file IGBheader.h.

unites() [2/3]

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

inline

Definition at line 353 of file IGBheader.h.

Here is the caller graph for this function:

unites() [3/3]

char* opencarp::IGBheader::unites ( void  )

inline

Definition at line 355 of file IGBheader.h.

unites_t() [1/3]

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

inline

Definition at line 351 of file IGBheader.h.

unites_t() [2/3]

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

inline

Definition at line 350 of file IGBheader.h.

Here is the caller graph for this function:

unites_t() [3/3]

char* opencarp::IGBheader::unites_t ( void  )

inline

Definition at line 352 of file IGBheader.h.

unites_x() [1/3]

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

inline

Definition at line 342 of file IGBheader.h.

unites_x() [2/3]

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

inline

Definition at line 341 of file IGBheader.h.

Here is the caller graph for this function:

unites_x() [3/3]

char* opencarp::IGBheader::unites_x ( void  )

inline

Definition at line 343 of file IGBheader.h.

unites_y() [1/3]

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

inline

Definition at line 345 of file IGBheader.h.

unites_y() [2/3]

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

inline

Definition at line 344 of file IGBheader.h.

Here is the caller graph for this function:

unites_y() [3/3]

char* opencarp::IGBheader::unites_y ( void  )

inline

Definition at line 346 of file IGBheader.h.

unites_z() [1/3]

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

inline

Definition at line 348 of file IGBheader.h.

unites_z() [2/3]

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

inline

Definition at line 347 of file IGBheader.h.

Here is the caller graph for this function:

unites_z() [3/3]

char* opencarp::IGBheader::unites_z ( void  )

inline

Definition at line 349 of file IGBheader.h.

vect_z() [1/3]

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

inline

Definition at line 339 of file IGBheader.h.

vect_z() [2/3]

void opencarp::IGBheader::vect_z ( float *  a )

inline

Definition at line 338 of file IGBheader.h.

vect_z() [3/3]

float* opencarp::IGBheader::vect_z ( void  )

inline

Definition at line 340 of file IGBheader.h.

write()

int IGBheader::write

(

)

Definition at line 333 of file IGBheader.cc.

Here is the caller graph for this function:

write_data()

template<class T >

void IGBheader::write_data	(	T *	dp,
		int	numt = 1,
		char *	buf = NULL
	)

write out a number of time slices

Parameters

dp[in]	buffer of data
numt	number of time slices
buf	temporary buffer of raw data

Definition at line 383 of file IGBheader.h.

x() [1/3]

int opencarp::IGBheader::x ( bool &  set )

inline

Definition at line 257 of file IGBheader.h.

x() [2/3]

void opencarp::IGBheader::x ( int  a )

inline

Definition at line 258 of file IGBheader.h.

x() [3/3]

int opencarp::IGBheader::x ( void  )

inline

Definition at line 256 of file IGBheader.h.

Here is the caller graph for this function:

y() [1/3]

int opencarp::IGBheader::y ( bool &  set )

inline

Definition at line 260 of file IGBheader.h.

y() [2/3]

void opencarp::IGBheader::y ( int  a )

inline

Definition at line 261 of file IGBheader.h.

y() [3/3]

int opencarp::IGBheader::y ( void  )

inline

Definition at line 259 of file IGBheader.h.

Here is the caller graph for this function:

z() [1/3]

int opencarp::IGBheader::z ( bool &  set )

inline

Definition at line 263 of file IGBheader.h.

z() [2/3]

void opencarp::IGBheader::z ( int  a )

inline

Definition at line 264 of file IGBheader.h.

z() [3/3]

int opencarp::IGBheader::z ( void  )

inline

Definition at line 262 of file IGBheader.h.

Here is the caller graph for this function:

zero() [1/3]

float opencarp::IGBheader::zero ( bool &  set )

inline

Definition at line 336 of file IGBheader.h.

zero() [2/3]

void opencarp::IGBheader::zero ( float  a )

inline

Definition at line 335 of file IGBheader.h.

zero() [3/3]

float opencarp::IGBheader::zero ( void  )

inline

Definition at line 337 of file IGBheader.h.

---

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

• numerics/IGBheader.h
• numerics/IGBheader.cc