vil3d_analyze_header Class Reference

Structure containing analyse header file information. More...

#include <vil3d_analyze_format.h>

List of all members.

Classes
class	Dimensions
class	History
class	Key
Public Member Functions
	vil3d_analyze_header ()
	~vil3d_analyze_header ()
void	reset ()
enum vil_pixel_format	pixel_format () const
	Define format of pixels.
void	set_pixel_format (enum vil_pixel_format format)
	Define format of pixels.
void	set_image_size (unsigned ni, unsigned nj, unsigned nk, unsigned np=1)
	Define number of pixels in each dimension.
short int	ni () const
short int	nj () const
short int	nk () const
short int	nplanes () const
	Number of planes (or time points in image sequence).
float	voxel_width_i () const
float	voxel_width_j () const
float	voxel_width_k () const
void	set_voxel_size (float si, float sj, float sk)
	Define width of voxels in each dimension.
bool	read_file (const vcl_string &path)
	Read in header from given file.
bool	write_file (const vcl_string &path) const
	Write header to given file.
void	swapBytes (char *data, int size)
bool	needSwap () const
void	print_summary (vcl_ostream &os) const
	Print out some parts of header.
Public Attributes
Key	key
Dimensions	dim
History	history
Private Attributes
bool	swap_bytes_

---

Detailed Description

Structure containing analyse header file information.

Definition at line 17 of file vil3d_analyze_format.h.

---

Constructor & Destructor Documentation

vil3d_analyze_header::vil3d_analyze_header

(

)

[inline]

Definition at line 108 of file vil3d_analyze_format.h.

vil3d_analyze_header::~vil3d_analyze_header

(

)

[inline]

Definition at line 109 of file vil3d_analyze_format.h.

---

Member Function Documentation

bool vil3d_analyze_header::needSwap

(

)

const [inline]

Definition at line 143 of file vil3d_analyze_format.h.

short int vil3d_analyze_header::ni

(

)

const [inline]

Definition at line 122 of file vil3d_analyze_format.h.

short int vil3d_analyze_header::nj

(

)

const [inline]

Definition at line 123 of file vil3d_analyze_format.h.

short int vil3d_analyze_header::nk

(

)

const [inline]

Definition at line 124 of file vil3d_analyze_format.h.

short int vil3d_analyze_header::nplanes

(

)

const [inline]

Number of planes (or time points in image sequence).

Definition at line 127 of file vil3d_analyze_format.h.

enum vil_pixel_format vil3d_analyze_header::pixel_format

(

)

const

Define format of pixels.

Definition at line 413 of file vil3d_analyze_format.cxx.

void vil3d_analyze_header::print_summary

(

vcl_ostream &

os

)

const

Print out some parts of header.

Definition at line 428 of file vil3d_analyze_format.cxx.

bool vil3d_analyze_header::read_file

(

const vcl_string &

path

)

Read in header from given file.

Definition at line 187 of file vil3d_analyze_format.cxx.

void vil3d_analyze_header::reset

(

)

Definition at line 95 of file vil3d_analyze_format.cxx.

void vil3d_analyze_header::set_image_size	(	unsigned	ni,
		unsigned	nj,
		unsigned	nk,
		unsigned	np = 1
	)

Define number of pixels in each dimension.

Definition at line 371 of file vil3d_analyze_format.cxx.

void vil3d_analyze_header::set_pixel_format

(

enum vil_pixel_format

format

)

Define format of pixels.

Definition at line 399 of file vil3d_analyze_format.cxx.

void vil3d_analyze_header::set_voxel_size	(	float	si,
		float	sj,
		float	sk
	)

Define width of voxels in each dimension.

Definition at line 380 of file vil3d_analyze_format.cxx.

void vil3d_analyze_header::swapBytes	(	char *	data,
		int	size
	)

Definition at line 387 of file vil3d_analyze_format.cxx.

float vil3d_analyze_header::voxel_width_i

(

)

const [inline]

Definition at line 129 of file vil3d_analyze_format.h.

float vil3d_analyze_header::voxel_width_j

(

)

const [inline]

Definition at line 130 of file vil3d_analyze_format.h.

float vil3d_analyze_header::voxel_width_k

(

)

const [inline]

Definition at line 131 of file vil3d_analyze_format.h.

bool vil3d_analyze_header::write_file

(

const vcl_string &

path

)

const

Write header to given file.

Definition at line 109 of file vil3d_analyze_format.cxx.

---

Member Data Documentation

Dimensions vil3d_analyze_header::dim

Definition at line 101 of file vil3d_analyze_format.h.

History vil3d_analyze_header::history

Definition at line 102 of file vil3d_analyze_format.h.

Key vil3d_analyze_header::key

Definition at line 100 of file vil3d_analyze_format.h.

bool vil3d_analyze_header::swap_bytes_ [private]

Definition at line 105 of file vil3d_analyze_format.h.

---

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

• contrib/mul/vil3d/file_formats/vil3d_analyze_format.h
• contrib/mul/vil3d/file_formats/vil3d_analyze_format.cxx