MosaicExporter Class Reference

#include <R3D/MosaicExporter/MosaicExporter.h>

List of all members.


Detailed Description

This class will export a complete mosaic based on a slice of a RoboMet.3D data set.

Author:
Michael A. Jackson for BlueQuartz Software
Date:
Jan 20, 2009
Version:
1.1


Static Public Member Functions

static R3DMosaic::Pointer ExportMosaic (R3DMosaicExportProperties::Pointer properties)
 Exports the Mosaic to a memory buffer.
static R3DMosaic::Pointer ExportMosaic (R3DMosaicExportProperties::Pointer properties, IDataFile::Pointer mxaDataFile)
 Exports the Mosaic to a memory buffer.
static int ExportMosaicToFile (R3DMosaicExportProperties::Pointer properties, R3DMosaic::Pointer mosaic)
 Exports a mosaic to an image file.
static int WriteTiff (R3DMosaicExportProperties::Pointer properties, R3DMosaic::Pointer mosaic)
 Writes the Extracted Image data to a tiff file.
static R3DFrame::Pointer ComputeWorkingVolume (const std::string &mxaFileName, int32 sliceStart, int32 sliceEnd, IR3DProgress::Pointer prog)
 This method will compute an area that would be valid for all slices where exporting the mosaic for that given area would result in the entire mosaic containing data.


Member Function Documentation

R3DMosaic::Pointer MosaicExporter::ExportMosaic ( R3DMosaicExportProperties::Pointer  properties  )  [static]

Exports the Mosaic to a memory buffer.

It is up to the calling program to clean up the memory when finished with it.

Parameters:
properties Shared Pointer to the Export Properties
Returns:
SharedPointer to a R3DMosaic object. The wrapped pointer may be NULL if an error occurs.

R3DMosaic::Pointer MosaicExporter::ExportMosaic ( R3DMosaicExportProperties::Pointer  properties,
IDataFile::Pointer  mxaDataFile 
) [static]

Exports the Mosaic to a memory buffer.

It is up to the calling program to clean up the memory when finished with it.

Parameters:
properties Shared Pointer to the Export Properties
mxaDataFile A Valid IDataFile Object
Returns:
SharedPointer to a R3DMosaic object. The wrapped pointer may be NULL if an error occurs.

int MosaicExporter::ExportMosaicToFile ( R3DMosaicExportProperties::Pointer  properties,
R3DMosaic::Pointer  mosaic 
) [static]

Exports a mosaic to an image file.

Parameters:
properties The properties of the export
mosaic A smart pointer to the exported mosaic
Returns:
Error code. Negative values are errors.

int MosaicExporter::WriteTiff ( R3DMosaicExportProperties::Pointer  properties,
R3DMosaic::Pointer  mosaic 
) [static]

Writes the Extracted Image data to a tiff file.

Parameters:
properties The Properties to use for the export
mosaic The R3DMosaic Object to store the raw image and associated properties
Returns:
Error code. Less than Zero (0) is an error.

R3DFrame::Pointer MosaicExporter::ComputeWorkingVolume ( const std::string &  mxaFileName,
int32  sliceStart,
int32  sliceEnd,
IR3DProgress::Pointer  prog 
) [static]

This method will compute an area that would be valid for all slices where exporting the mosaic for that given area would result in the entire mosaic containing data.

This method is helpful when trying to figure out the largest volume that could be rendered without consideration for any rotational effects.

Parameters:
mxaFileName The name of the input file.
Returns:


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