Archiver Class Reference

#include <Importer/Archiver.h>

List of all members.


Detailed Description

This class controls the importing of RoboMet Datasets into MXA DataModel files.

Author:
Mike Jackson/Herb Mullens
Date:
Oct 2007
Version:
Revision
1.1


Public Member Functions

int32 run ()
 Imports the data into the data file.

Static Public Member Functions

static std::string generateZeissXMLFilename (const std::string &rmsFile, R3DMetaData::Pointer r3dMetaData, int32 sliceNumber)
 Generates a native file system path to a Zeiss XML file for a particulare slice number.
static std::string generateBmpImageFilePath (const std::string &rmsFile, R3DMetaData::Pointer r3dMetaData, int32 currentSliceNumber, int32 currentTileNumber, int32 frameCount)
 Generates a native file system path to a Bitmap file for a particulare slice and frame number.
static bool mosaicXMLFileExists (const std::string &rmsFile, R3DSliceInfo::Pointer slicePtr, R3DMetaData::Pointer r3dMetaData)
 Determines if the mosaic xml file exists.
static void removeNonExistantSlices (const std::string &rmsFile, R3DSliceInfo::SliceMap &sliceInfos, R3DMetaData::Pointer r3dMetaData)
 Removes sliceinfo objects from the array if the slice data does NOT exist on disk.
static void findSliceInformation (const std::string &rmsFile, R3DSliceInfo::SliceMap &sliceInfos, R3DMetaData::Pointer r3dMetaData, ZeissTileInfo::CollectionMap &frameInfosMap)
 Finds all the files with the given file extension (csv currently) and parses all the slice information from the file.
static void ReadZeissMetaData (const std::string &rmsFile, R3DSliceInfo::Pointer sliceInfo, R3DMetaData::Pointer r3dMetaData, ZeissTileInfo::Collection &frameInfosMap)
 Reads the Zeiss Meta Data from the rms file.


Member Function Documentation

std::string Archiver::generateZeissXMLFilename ( const std::string &  rmsFile,
R3DMetaData::Pointer  r3dMetaData,
int32  sliceNumber 
) [static]

Generates a native file system path to a Zeiss XML file for a particulare slice number.

Parameters:
rmsFile The path/filename of the RMS file to be used for import
r3dMetaData The current R3DMetaData object
sliceNumber The slice number to generate the file path for
Returns:
A native file system string that represents the absolute path to the file

std::string Archiver::generateBmpImageFilePath ( const std::string &  rmsFile,
R3DMetaData::Pointer  r3dMetaData,
int32  currentSliceNumber,
int32  currentTileNumber,
int32  frameCount 
) [static]

Generates a native file system path to a Bitmap file for a particulare slice and frame number.

Parameters:
rmsFile The path/filename of the RMS file to be used for import
r3dMetaData The current R3DMetaData object
currentSliceNumber The slice number to generate the file path for
currentTileNumber The frame number to generate the file path for
frameCount The number of frames in the slice
Returns:
A native file system string that represents the absolute path to the file

bool Archiver::mosaicXMLFileExists ( const std::string &  rmsFile,
R3DSliceInfo::Pointer  slicePtr,
R3DMetaData::Pointer  r3dMetaData 
) [static]

Determines if the mosaic xml file exists.

Parameters:
rmsFile The .rms file
slicePtr Pointer to a sliceinfo object
r3dMetaData The meta data for this import
Returns:
true if the xml file exists

void Archiver::removeNonExistantSlices ( const std::string &  rmsFile,
R3DSliceInfo::SliceMap &  sliceInfos,
R3DMetaData::Pointer  r3dMetaData 
) [static]

Removes sliceinfo objects from the array if the slice data does NOT exist on disk.

Parameters:
rmsFile The path/name of the RMS file to be used for the import
sliceInfos Pointer to a sliceinfo object
r3dMetaData The meta data for this import

void Archiver::findSliceInformation ( const std::string &  rmsFile,
R3DSliceInfo::SliceMap &  sliceInfos,
R3DMetaData::Pointer  r3dMetaData,
ZeissTileInfo::CollectionMap &  frameInfosMap 
) [static]

Finds all the files with the given file extension (csv currently) and parses all the slice information from the file.

Parameters:
rmsFile The path/name of the RMS file to be used for the import
sliceInfos Pointer to a sliceinfo object
r3dMetaData The meta data for this import
frameInfosMap The std::map<> of frame id to Zeiss Tile Info

void Archiver::ReadZeissMetaData ( const std::string &  rmsFile,
R3DSliceInfo::Pointer  sliceInfo,
R3DMetaData::Pointer  r3dMetaData,
ZeissTileInfo::Collection &  frameInfosMap 
) [static]

Reads the Zeiss Meta Data from the rms file.

Parameters:
rmsFile The path/name of the RMS file to be used for the import
sliceInfo Pointer to a sliceinfo object
r3dMetaData The meta data for this import
frameInfosMap The std::map<> of frame id to Zeiss Tile Info

int32 Archiver::run (  ) 

Imports the data into the data file.

Returns:
Error Condition. Zero or Positive is Success


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