PCMRegistrationData Class Reference

#include <R3D/PCMRegistration/PCMRegistrationData.h>

List of all members.


Detailed Description

This class encapsulates the data needed as inputs and outputs from a run of the PCM Registration class.

This class knows how to read and write itself from a binary file and can print itself to any std::ostream as binary or ascii data.

Author:
Michael A. Jackson for BlueQuartz Software
Date:
June 16, 2009
Version:
1.0


Public Member Functions

void getTranslations (double trans[2])
 Get the translations.
void setTranslations (double trans[2])
 Set the translations.
void setFixedOrigin (float origin[2])
 Sets the fixed origin.
void getFixedOrigin (float origin[2])
 Gets the fixed image origin.
void setMovingOrigin (float origin[2])
 Sets the moving origin.
void getMovingOrigin (float origin[2])
 Gets the moving origin.
void initValues ()
 Will initialize all the internal values to defaults.
int32 writeToFile (MXAFileWriter64 &writer)
 Writes out this object into a binary file.
int32 readFromFile (MXAFileReader64 &reader, bool swap=false)
 Reads the values from a file in binary form swapping the bytes if requested.
void print (std::ostream &out, const std::string &delimiter)
 Prints the entry out to the std::ostream.

Static Public Member Functions

static void PrintAsciiHeader (std::ostream &out, const std::string &delimiter)
 Static method to print the column headers for ascii output.


Member Function Documentation

void PCMRegistrationData::PrintAsciiHeader ( std::ostream &  out,
const std::string &  delimiter 
) [static]

Static method to print the column headers for ascii output.

Parameters:
out the ostream to print to
delimiter What type of delimiter to use: Tab, Comma, Space.

void PCMRegistrationData::getTranslations ( double  trans[2]  ) 

Get the translations.

Parameters:
trans Output variable

void PCMRegistrationData::setTranslations ( double  trans[2]  ) 

Set the translations.

Parameters:
trans Input variable

void PCMRegistrationData::setFixedOrigin ( float  origin[2]  ) 

Sets the fixed origin.

Parameters:
origin Input values

void PCMRegistrationData::getFixedOrigin ( float  origin[2]  ) 

Gets the fixed image origin.

Parameters:
origin Output variable

void PCMRegistrationData::setMovingOrigin ( float  origin[2]  ) 

Sets the moving origin.

Parameters:
origin The input values

void PCMRegistrationData::getMovingOrigin ( float  origin[2]  ) 

Gets the moving origin.

Parameters:
origin The output variable

void PCMRegistrationData::initValues (  ) 

Will initialize all the internal values to defaults.

Use this if you plan on reusing an instance of this class for any reason.

int32 PCMRegistrationData::writeToFile ( MXAFileWriter64 &  writer  ) 

Writes out this object into a binary file.

Parameters:
writer The MXAFileWriter64 Object to use for the writing
Returns:
error condition

int32 PCMRegistrationData::readFromFile ( MXAFileReader64 &  reader,
bool  swap = false 
)

Reads the values from a file in binary form swapping the bytes if requested.

Parameters:
reader The reader to use
swap Perform Endian Byte Swapping
Returns:

void PCMRegistrationData::print ( std::ostream &  out,
const std::string &  delimiter 
)

Prints the entry out to the std::ostream.

Parameters:
out std::ostream to print to
delimiter The Delimiter to use between data


The documentation for this class was generated from the following files:
Generated on Fri Aug 28 14:04:33 2009 for R3DImageTools by  doxygen 1.5.2