ImageD  v2_7_5 (24.06.22)
ImageD is an image processing software designed for rapid prototyping and implementing algorithms and solutions for science, research and teaching.
Public Member Functions | List of all members
D_VisDat_Dim Class Reference

The D_VisDat_Dim class Represents a 6D volume. More...

#include <d_visdat_dim.h>

Public Member Functions

 D_VisDat_Dim ()
 
 D_VisDat_Dim (int X, int Y, int Z=1, int T=1, int S=1, int P=1)
 
 D_VisDat_Dim (vector< int > vDims)
 
 D_VisDat_Dim (Vec< int, c_DIM_NUMBER_OF > vDims)
 
 D_VisDat_Dim (D_VisDat_Header source_header)
 
int size_PixelCount ()
 
int size_X ()
 
int size_Y ()
 
int size_Z ()
 
int size_T ()
 
int size_S ()
 
int size_P ()
 
int size_Dim (int idx)
 
vector< int > size_DimsVec ()
 
Size size_XY ()
 
Size size_XZ ()
 
Size size_YZ ()
 
Size size_Plane (int i, int j)
 
QString unit_X ()
 
QString unit_Y ()
 
QString unit_Z ()
 
QString unit_T ()
 
QString unit_S ()
 
QString unit_P ()
 
QString unit_Dim (int d)
 
QStringList unit_Dims ()
 
double step_X ()
 
double step_Y ()
 
double step_Z ()
 
double step_T ()
 
double step_S ()
 
double step_P ()
 
double step_Dim (int d)
 
double step_Dims ()
 
void set_size_X (int X)
 
void set_size_Y (int Y)
 
void set_size_Z (int Z)
 
void set_size_T (int T)
 
void set_size_S (int S)
 
void set_size_P (int P)
 
void set_size_Dim (int idx, int val)
 
void set_size_Dims (vector< int > sizes)
 
void set_unit_X (double step=1, QString unit="px")
 
void set_unit_Y (double step=1, QString unit="px")
 
void set_unit_Z (double step=1, QString unit="px")
 
void set_unit_T (double step=1, QString unit="px")
 
void set_unit_S (double step=1, QString unit="px")
 
void set_unit_P (double step=1, QString unit="px")
 
void set_unit_Dim (int d, double step=1, QString unit="u")
 
int extended_DimsCount ()
 
QString extended_DimsString ()
 
bool is_Dims (int dims)
 
bool is_DimsAtLeast (int dims)
 
bool is_1D ()
 
bool is_2D ()
 
bool is_3D ()
 
bool is_4D ()
 
bool is_5D ()
 
bool is_6D ()
 
bool inRangeOf (D_VisDat_Dim VD_container)
 
Vec< int, c_DIM_NUMBER_OF > ForcePosInRange (Vec< int, c_DIM_NUMBER_OF > pos)
 
int DimOutRanged (D_VisDat_Dim VD_container)
 
bool isEqual (D_VisDat_Dim VD_compare)
 
QString info ()
 
void loop_Reset ()
 
void loop_SetOffset (Vec< int, c_DIM_NUMBER_OF > offset)
 
bool loop_Next ()
 
Vec< int, c_DIM_NUMBER_OF > loop_PosCurrent ()
 
Vec< int, c_DIM_NUMBER_OF > loop_PosCurrent_Offset ()
 

Detailed Description

The D_VisDat_Dim class Represents a 6D volume.

There are basic functionalities describing and changing the 6D volume. This is used to describe the size of a multidimensional image D_VisDat_Obj . There is a method for looping through such a volume pixel by pixel.

The six dimensions are: Spacial X, spacial Y, spacial Z, time T, stack S and pages P. See: D_DIM_INDICES

Constructor & Destructor Documentation

◆ D_VisDat_Dim() [1/5]

D_VisDat_Dim::D_VisDat_Dim ( )

◆ D_VisDat_Dim() [2/5]

D_VisDat_Dim::D_VisDat_Dim ( int  X,
int  Y,
int  Z = 1,
int  T = 1,
int  S = 1,
int  P = 1 
)

◆ D_VisDat_Dim() [3/5]

D_VisDat_Dim::D_VisDat_Dim ( vector< int >  vDims)

◆ D_VisDat_Dim() [4/5]

D_VisDat_Dim::D_VisDat_Dim ( Vec< int, c_DIM_NUMBER_OF >  vDims)

◆ D_VisDat_Dim() [5/5]

D_VisDat_Dim::D_VisDat_Dim ( D_VisDat_Header  source_header)

Member Function Documentation

◆ DimOutRanged()

int D_VisDat_Dim::DimOutRanged ( D_VisDat_Dim  VD_container)

◆ extended_DimsCount()

int D_VisDat_Dim::extended_DimsCount ( )

◆ extended_DimsString()

QString D_VisDat_Dim::extended_DimsString ( )

◆ ForcePosInRange()

Vec< int, c_DIM_NUMBER_OF > D_VisDat_Dim::ForcePosInRange ( Vec< int, c_DIM_NUMBER_OF >  pos)

◆ info()

QString D_VisDat_Dim::info ( )

◆ inRangeOf()

bool D_VisDat_Dim::inRangeOf ( D_VisDat_Dim  VD_container)

◆ is_1D()

bool D_VisDat_Dim::is_1D ( )
inline

◆ is_2D()

bool D_VisDat_Dim::is_2D ( )
inline

◆ is_3D()

bool D_VisDat_Dim::is_3D ( )
inline

◆ is_4D()

bool D_VisDat_Dim::is_4D ( )
inline

◆ is_5D()

bool D_VisDat_Dim::is_5D ( )
inline

◆ is_6D()

bool D_VisDat_Dim::is_6D ( )
inline

◆ is_Dims()

bool D_VisDat_Dim::is_Dims ( int  dims)
inline

◆ is_DimsAtLeast()

bool D_VisDat_Dim::is_DimsAtLeast ( int  dims)
inline

◆ isEqual()

bool D_VisDat_Dim::isEqual ( D_VisDat_Dim  VD_compare)

◆ loop_Next()

bool D_VisDat_Dim::loop_Next ( )

◆ loop_PosCurrent()

Vec<int, c_DIM_NUMBER_OF> D_VisDat_Dim::loop_PosCurrent ( )
inline

◆ loop_PosCurrent_Offset()

Vec< int, c_DIM_NUMBER_OF > D_VisDat_Dim::loop_PosCurrent_Offset ( )

◆ loop_Reset()

void D_VisDat_Dim::loop_Reset ( )
inline

◆ loop_SetOffset()

void D_VisDat_Dim::loop_SetOffset ( Vec< int, c_DIM_NUMBER_OF >  offset)
inline

◆ set_size_Dim()

void D_VisDat_Dim::set_size_Dim ( int  idx,
int  val 
)
inline

◆ set_size_Dims()

void D_VisDat_Dim::set_size_Dims ( vector< int >  sizes)
inline

◆ set_size_P()

void D_VisDat_Dim::set_size_P ( int  P)
inline

◆ set_size_S()

void D_VisDat_Dim::set_size_S ( int  S)
inline

◆ set_size_T()

void D_VisDat_Dim::set_size_T ( int  T)
inline

◆ set_size_X()

void D_VisDat_Dim::set_size_X ( int  X)
inline

◆ set_size_Y()

void D_VisDat_Dim::set_size_Y ( int  Y)
inline

◆ set_size_Z()

void D_VisDat_Dim::set_size_Z ( int  Z)
inline

◆ set_unit_Dim()

void D_VisDat_Dim::set_unit_Dim ( int  d,
double  step = 1,
QString  unit = "u" 
)
inline

◆ set_unit_P()

void D_VisDat_Dim::set_unit_P ( double  step = 1,
QString  unit = "px" 
)
inline

◆ set_unit_S()

void D_VisDat_Dim::set_unit_S ( double  step = 1,
QString  unit = "px" 
)
inline

◆ set_unit_T()

void D_VisDat_Dim::set_unit_T ( double  step = 1,
QString  unit = "px" 
)
inline

◆ set_unit_X()

void D_VisDat_Dim::set_unit_X ( double  step = 1,
QString  unit = "px" 
)
inline

◆ set_unit_Y()

void D_VisDat_Dim::set_unit_Y ( double  step = 1,
QString  unit = "px" 
)
inline

◆ set_unit_Z()

void D_VisDat_Dim::set_unit_Z ( double  step = 1,
QString  unit = "px" 
)
inline

◆ size_Dim()

int D_VisDat_Dim::size_Dim ( int  idx)
inline

◆ size_DimsVec()

vector<int> D_VisDat_Dim::size_DimsVec ( )
inline

◆ size_P()

int D_VisDat_Dim::size_P ( )
inline

◆ size_PixelCount()

int D_VisDat_Dim::size_PixelCount ( )

◆ size_Plane()

Size D_VisDat_Dim::size_Plane ( int  i,
int  j 
)
inline

◆ size_S()

int D_VisDat_Dim::size_S ( )
inline

◆ size_T()

int D_VisDat_Dim::size_T ( )
inline

◆ size_X()

int D_VisDat_Dim::size_X ( )
inline

◆ size_XY()

Size D_VisDat_Dim::size_XY ( )
inline

◆ size_XZ()

Size D_VisDat_Dim::size_XZ ( )
inline

◆ size_Y()

int D_VisDat_Dim::size_Y ( )
inline

◆ size_YZ()

Size D_VisDat_Dim::size_YZ ( )
inline

◆ size_Z()

int D_VisDat_Dim::size_Z ( )
inline

◆ step_Dim()

double D_VisDat_Dim::step_Dim ( int  d)
inline

◆ step_Dims()

double D_VisDat_Dim::step_Dims ( )
inline

◆ step_P()

double D_VisDat_Dim::step_P ( )
inline

◆ step_S()

double D_VisDat_Dim::step_S ( )
inline

◆ step_T()

double D_VisDat_Dim::step_T ( )
inline

◆ step_X()

double D_VisDat_Dim::step_X ( )
inline

◆ step_Y()

double D_VisDat_Dim::step_Y ( )
inline

◆ step_Z()

double D_VisDat_Dim::step_Z ( )
inline

◆ unit_Dim()

QString D_VisDat_Dim::unit_Dim ( int  d)
inline

◆ unit_Dims()

QStringList D_VisDat_Dim::unit_Dims ( )
inline

◆ unit_P()

QString D_VisDat_Dim::unit_P ( )
inline

◆ unit_S()

QString D_VisDat_Dim::unit_S ( )
inline

◆ unit_T()

QString D_VisDat_Dim::unit_T ( )
inline

◆ unit_X()

QString D_VisDat_Dim::unit_X ( )
inline

◆ unit_Y()

QString D_VisDat_Dim::unit_Y ( )
inline

◆ unit_Z()

QString D_VisDat_Dim::unit_Z ( )
inline
The documentation for this class was generated from the following files: