UNIVERS  15.3
UNIVERS base processing software API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
U3dDataCube Class Reference

#include <u3d_data_cube.hpp>

Classes

class  badcontent
 

Public Member Functions

 U3dDataCube (ushort i_size, ushort j_size, ushort k_size, float x_max, float y_max, float z_max)
 
 U3dDataCube (U3dModel *model, U3D_WAVE_TYPE wt, ushort isize, ushort jsize, ushort ksize, U3dProgress *prg=NULL)
 
 U3dDataCube (const U3dDataCube &other)
 
bool initialize (ushort i_size, ushort j_size, ushort k_size, float x_max, float y_max, float z_max)
 
void loadFromFile (const char *fileName) throw (std::ios_base::failure, badcontent)
 
void generate (ushort i_max, ushort j_max, ushort k_max, float x_max, float y_max, float z_max)
 
void getDimensions (ushort *widthX, ushort *heightY, ushort *depthZ)
 
void getCubeCoordLimits (float &xmax, float &ymax, float &zmax)
 
void saveToFile (const char *fname)
 
unsigned getImageSize ()
 
bool getPlaneFacet (const PlaneOrient &op, const float &coord, float *&images)
 
bool getPlaneAxeSimple (float xn, float yn, float xk, float yk, float *&images, ushort *width, ushort *depth)
 
bool getPlaneAxeIntrpl (float xn, float yn, float xk, float yk, float *&images, ushort *width, ushort *depth)
 
unsigned size ()
 
bool getReady ()
 
void setValue (const int &i, const int &j, const int &k, const float &ampl)
 
void averageAmpls ()
 
float getValue (const int &i, const int &j, const int &k)
 
float getMaxValue ()
 
float getMinValue ()
 
bool saveImage (char *OutMod, U3dBox *image_box=NULL)
 
virtual bool save (char *OutMod)
 
U3dDataCubeinterpData (double *factor)
 
void smData (int *epsilon)
 
 U3dDataCube (ushort i_size, ushort j_size, ushort k_size, float x_max, float y_max, float z_max)
 
 U3dDataCube (U3dModel *model, U3D_WAVE_TYPE wt, ushort isize, ushort jsize, ushort ksize, U3dProgress *prg=NULL)
 
 U3dDataCube (const U3dDataCube &other)
 
bool initialize (ushort i_size, ushort j_size, ushort k_size, float x_max, float y_max, float z_max)
 
void loadFromFile (const char *fileName) throw (std::ios_base::failure, badcontent)
 
void generate (ushort i_max, ushort j_max, ushort k_max, float x_max, float y_max, float z_max)
 
void getDimensions (ushort *widthX, ushort *heightY, ushort *depthZ)
 
void getCubeCoordLimits (float &xmax, float &ymax, float &zmax)
 
void saveToFile (const char *fname)
 
unsigned getImageSize ()
 
bool getPlaneFacet (const PlaneOrient &op, const float &coord, float *&images)
 
bool getPlaneAxeSimple (float xn, float yn, float xk, float yk, float *&images, ushort *width, ushort *depth)
 
bool getPlaneAxeIntrpl (float xn, float yn, float xk, float yk, float *&images, ushort *width, ushort *depth)
 
unsigned size ()
 
bool getReady ()
 
void setValue (const int &i, const int &j, const int &k, const float &ampl)
 
void averageAmpls ()
 
float getValue (const int &i, const int &j, const int &k)
 
float getMaxValue ()
 
float getMinValue ()
 
bool saveImage (char *OutMod, U3dBox *image_box=NULL)
 
virtual bool save (char *OutMod)
 
U3dDataCubeinterpData (double *factor)
 
void smData (int *epsilon)
 

Protected Member Functions

virtual U3dDataCubeclone ()
 
void clean ()
 
virtual U3dDataCubeclone ()
 
void clean ()
 

Protected Attributes

bool m_ready
 
ushort m_width
 
ushort m_height
 
ushort m_depth
 
U3dArray3D< float > m_ampl
 
U3dArray3D< ushort > m_ampl_num
 
float m_stepX
 
float m_stepY
 
float m_stepZ
 
float m_vmax
 
float m_vmin
 

Detailed Description

3d data Cube storage object

Constructor & Destructor Documentation

U3dDataCube::U3dDataCube ( ushort  i_size,
ushort  j_size,
ushort  k_size,
float  x_max,
float  y_max,
float  z_max 
)

Data cube initialization according to the given sizes (coordinates and indexes)

U3dDataCube::U3dDataCube ( U3dModel model,
U3D_WAVE_TYPE  wt,
ushort  isize,
ushort  jsize,
ushort  ksize,
U3dProgress prg = NULL 
)

3d model velocities data cube forming

U3dDataCube::U3dDataCube ( ushort  i_size,
ushort  j_size,
ushort  k_size,
float  x_max,
float  y_max,
float  z_max 
)

Data cube initialization according to the given sizes (coordinates and indexes)

U3dDataCube::U3dDataCube ( U3dModel model,
U3D_WAVE_TYPE  wt,
ushort  isize,
ushort  jsize,
ushort  ksize,
U3dProgress prg = NULL 
)

3d model velocities data cube forming

Member Function Documentation

void U3dDataCube::averageAmpls ( )

Average data in each cell according to the number of appended values

void U3dDataCube::averageAmpls ( )

Average data in each cell according to the number of appended values

virtual U3dDataCube* U3dDataCube::clone ( )
inlineprotectedvirtual

Copy 3d data to another object

virtual U3dDataCube* U3dDataCube::clone ( )
inlineprotectedvirtual

Copy 3d data to another object

void U3dDataCube::generate ( ushort  i_max,
ushort  j_max,
ushort  k_max,
float  x_max,
float  y_max,
float  z_max 
)

Generate cube data

void U3dDataCube::generate ( ushort  i_max,
ushort  j_max,
ushort  k_max,
float  x_max,
float  y_max,
float  z_max 
)

Generate cube data

void U3dDataCube::getCubeCoordLimits ( float &  xmax,
float &  ymax,
float &  zmax 
)

Returns data cube limits (in coordinates)

void U3dDataCube::getCubeCoordLimits ( float &  xmax,
float &  ymax,
float &  zmax 
)

Returns data cube limits (in coordinates)

void U3dDataCube::getDimensions ( ushort *  widthX,
ushort *  heightY,
ushort *  depthZ 
)

Getting width, heght and depth of the cube

void U3dDataCube::getDimensions ( ushort *  widthX,
ushort *  heightY,
ushort *  depthZ 
)

Getting width, heght and depth of the cube

bool U3dDataCube::getPlaneAxeIntrpl ( float  xn,
float  yn,
float  xk,
float  yk,
float *&  images,
ushort *  width,
ushort *  depth 
)

Getting shear of Cube parallel to some axe with interpolation

bool U3dDataCube::getPlaneAxeIntrpl ( float  xn,
float  yn,
float  xk,
float  yk,
float *&  images,
ushort *  width,
ushort *  depth 
)

Getting shear of Cube parallel to some axe with interpolation

bool U3dDataCube::getPlaneAxeSimple ( float  xn,
float  yn,
float  xk,
float  yk,
float *&  images,
ushort *  width,
ushort *  depth 
)

Getting shear of Cube parallel to some axe without interpolation

bool U3dDataCube::getPlaneAxeSimple ( float  xn,
float  yn,
float  xk,
float  yk,
float *&  images,
ushort *  width,
ushort *  depth 
)

Getting shear of Cube parallel to some axe without interpolation

bool U3dDataCube::getPlaneFacet ( const PlaneOrient &  op,
const float &  coord,
float *&  images 
)

Getting shear of Cube parallel to some facet

bool U3dDataCube::getPlaneFacet ( const PlaneOrient &  op,
const float &  coord,
float *&  images 
)

Getting shear of Cube parallel to some facet

bool U3dDataCube::getReady ( )
inline

Returns object status

bool U3dDataCube::getReady ( )
inline

Returns object status

float U3dDataCube::getValue ( const int &  i,
const int &  j,
const int &  k 
)
inline

Returns value, contained in the cell [i][j][k]

float U3dDataCube::getValue ( const int &  i,
const int &  j,
const int &  k 
)
inline

Returns value, contained in the cell [i][j][k]

void U3dDataCube::loadFromFile ( const char *  fileName)
throw (std::ios_base::failure,
badcontent
)

Load cube data from file

void U3dDataCube::loadFromFile ( const char *  fileName)
throw (std::ios_base::failure,
badcontent
)

Load cube data from file

bool U3dDataCube::saveImage ( char *  OutMod,
U3dBox image_box = NULL 
)

Saves image to data base

bool U3dDataCube::saveImage ( char *  OutMod,
U3dBox image_box = NULL 
)

Saves image to data base

void U3dDataCube::setValue ( const int &  i,
const int &  j,
const int &  k,
const float &  ampl 
)

Increase the value in cell [i][j][k] with the ampl value

void U3dDataCube::setValue ( const int &  i,
const int &  j,
const int &  k,
const float &  ampl 
)

Increase the value in cell [i][j][k] with the ampl value

Member Data Documentation

U3dArray3D< float > U3dDataCube::m_ampl
protected

3d data storage

U3dArray3D< ushort > U3dDataCube::m_ampl_num
protected

3d storage, containing infarmation about the numbers of appended values

ushort U3dDataCube::m_depth
protected

3d data storage z-dimention

ushort U3dDataCube::m_height
protected

3d data storage y-dimention

bool U3dDataCube::m_ready
protected

object status flag

float U3dDataCube::m_stepX
protected

x-direction data step

float U3dDataCube::m_stepY
protected

y-direction data step

float U3dDataCube::m_stepZ
protected

z-direction data step

ushort U3dDataCube::m_width
protected

3d data storage x-dimention


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