CustusX  2023.01.05-dev+develop.0da12
An IGT application
cx::OutputVolumeParams Class Reference

Helper struct for sending and controlling output volume properties. More...

#include <cxReconstructedOutputVolumeParams.h>

Public Member Functions

 OutputVolumeParams ()
 
 OutputVolumeParams (DoubleBoundingBox3D extent, double inputSpacing, double maxVolumeSize)
 
bool isValid ()
 
unsigned long getVolumeSize () const
 
void setSpacing (double spacing)
 
double getSpacing () const
 
void setDim (int index, int newDim)
 
Eigen::Array3i getDim () const
 
void constrainVolumeSize ()
 
void setMaxVolumeSize (double maxSize)
 
unsigned long getMaxVolumeSize ()
 
void set_rMd (Transform3D rMd)
 
Transform3D get_rMd ()
 
DoubleBoundingBox3D getExtent ()
 
double getInputSpacing ()
 

Detailed Description

Helper struct for sending and controlling output volume properties.

Date
May 27, 2010
Author
Christian Askeland, SINTEF
Ole Vegard Solberg, SINTEF

Definition at line 39 of file cxReconstructedOutputVolumeParams.h.

Constructor & Destructor Documentation

cx::OutputVolumeParams::OutputVolumeParams ( )

Definition at line 18 of file cxReconstructedOutputVolumeParams.cpp.

cx::OutputVolumeParams::OutputVolumeParams ( DoubleBoundingBox3D  extent,
double  inputSpacing,
double  maxVolumeSize 
)

Initialize the volue parameters with sensible defaults.

Definition at line 27 of file cxReconstructedOutputVolumeParams.cpp.

Member Function Documentation

void cx::OutputVolumeParams::constrainVolumeSize ( )

Increase spacing in order to keep size below a max size

Definition at line 69 of file cxReconstructedOutputVolumeParams.cpp.

Transform3D cx::OutputVolumeParams::get_rMd ( )

Definition at line 99 of file cxReconstructedOutputVolumeParams.cpp.

Eigen::Array3i cx::OutputVolumeParams::getDim ( ) const

Definition at line 63 of file cxReconstructedOutputVolumeParams.cpp.

DoubleBoundingBox3D cx::OutputVolumeParams::getExtent ( )

Definition at line 105 of file cxReconstructedOutputVolumeParams.cpp.

double cx::OutputVolumeParams::getInputSpacing ( )

Definition at line 110 of file cxReconstructedOutputVolumeParams.cpp.

unsigned long cx::OutputVolumeParams::getMaxVolumeSize ( )

Definition at line 88 of file cxReconstructedOutputVolumeParams.cpp.

double cx::OutputVolumeParams::getSpacing ( ) const

Definition at line 52 of file cxReconstructedOutputVolumeParams.cpp.

unsigned long cx::OutputVolumeParams::getVolumeSize ( ) const

Definition at line 41 of file cxReconstructedOutputVolumeParams.cpp.

bool cx::OutputVolumeParams::isValid ( )
inline

Definition at line 45 of file cxReconstructedOutputVolumeParams.h.

void cx::OutputVolumeParams::set_rMd ( Transform3D  rMd)

Definition at line 94 of file cxReconstructedOutputVolumeParams.cpp.

void cx::OutputVolumeParams::setDim ( int  index,
int  newDim 
)

Set one of the dimensions explicitly, recalculate other dims and spacing.

Definition at line 58 of file cxReconstructedOutputVolumeParams.cpp.

void cx::OutputVolumeParams::setMaxVolumeSize ( double  maxSize)

Definition at line 83 of file cxReconstructedOutputVolumeParams.cpp.

void cx::OutputVolumeParams::setSpacing ( double  spacing)

Set a spacing, recalculate dimensions.

Definition at line 48 of file cxReconstructedOutputVolumeParams.cpp.


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