Celartem::ExportUtils

Celartem::ExportUtils Namespace Reference


Classes

struct  VFZExportParam
struct  MrSIDExportParam
struct  JPEG2000ExportParam
struct  TIFFExportParam
struct  TIFFPyramidExportParam
struct  PNGExportParam
struct  JPEGExportParam
struct  BMPExportParam

Typedefs

typedef void(* GenericExportFunction )(Storage *inStorage, Image *inImage, DataStore *inMetadata, void *inParam, ProcessCallback *inCallback)

Functions

void exportAsVFZ (Storage *inStorage, Image *inImage, DataStore *inMetadata=NULL, VFZExportParam *inParam=NULL, ProcessCallback *inCallback=NULL)
void exportAsPFZ (Storage *inStorage, Image *inImage, const String &inPadsAddress, CredentialProvider *inCredentialProvider, HttpManager *inHttpManager=NULL, DataStore *inMetadata=NULL, VFZExportParam *inParam=NULL, ProcessCallback *inCallback=NULL)
void exportAsMrSID (Storage *inStorage, Image *inImage, DataStore *inMetadata=NULL, MrSIDExportParam *inParam=NULL, ProcessCallback *inCallback=NULL)
void unlockMrSIDExportRestriction (bool inUnlock)
bool isMrSIDExportRestricted ()
void exportAsJPEG2000 (Storage *inStorage, Image *inImage, DataStore *inMetadata=NULL, JPEG2000ExportParam *inParam=NULL, ProcessCallback *inCallback=NULL)
void exportAsTIFF (Storage *inStorage, Image *inImage, DataStore *inMetadata=NULL, TIFFExportParam *inParam=NULL, ProcessCallback *inCallback=NULL)
void exportAsMultiPageTIFF (Storage *inStorage, SimpleArray< AutoPtr< Image > > &inImages, SimpleArray< AutoPtr< DataStore > > &inMetadatas, TIFFExportParam *inParam=NULL, ProcessCallback *inCallback=NULL)
void exportAsTIFFPyramid (Storage *inStorage, Image *inImage, DataStore *inMetadata=NULL, TIFFPyramidExportParam *inParam=NULL, ProcessCallback *inCallback=NULL)
void exportAsPNG (Storage *inStorage, Image *inImage, DataStore *inMetadata=NULL, PNGExportParam *inParam=NULL, ProcessCallback *inCallback=NULL)
void exportAsJPEG (Storage *inStorage, Image *inImage, DataStore *inMetadata=NULL, JPEGExportParam *inParam=NULL, ProcessCallback *inCallback=NULL)
void exportAsBMP (Storage *inStorage, Image *inImage, DataStore *inMetadata=NULL, BMPExportParam *inParam=NULL, ProcessCallback *inCallback=NULL)
void exportAsPFZ2 (GenericExportFunction inExportFunction, Storage *inStorage, Image *inImage, const String &inPadsAddress, CredentialProvider *inCredentialProvider, HttpManager *inHttpManager=NULL, DataStore *inMetadata=NULL, void *inParam=NULL, ProcessCallback *inCallback=NULL)

Detailed Description

ExportUtils namespace provides the routines for exporting images.

Typedef Documentation

typedef void(* Celartem::ExportUtils::GenericExportFunction)(Storage *inStorage, Image *inImage, DataStore *inMetadata, void *inParam, ProcessCallback *inCallback)

This is a definition of generic export function.

Parameters:
inStorage The storage to write on.
inImage The image to be exported.
inMetadata DataStore instance that contains the metadata for the exported image. If it is NULL, this function uses the metadata associated to the orignal Image instance.
inParam Parameters that customizes the export options. It can be NULL and then this function uses the default options.
inCallback Callback instance that periodically notifies the process status.
See also:
exportAsMrSID, exportAsPNG, exportAsJPEG, exportAsTIFF

exportAsBMP

Exporting Images, BMP (Windows Bitmap) Image File Format

Definition at line 815 of file pxl_imageexport.h.

Function Documentation

void Celartem::ExportUtils::exportAsBMP ( Storage *  inStorage,
Image *  inImage,
DataStore *  inMetadata = NULL,
BMPExportParam *  inParam = NULL,
ProcessCallback *  inCallback = NULL 
)

This function exports the specified Image instance as BMP file.

Parameters:
inStorage The storage to write on.
inImage The image to be exported.
inMetadata DataStore instance that contains the metadata for the exported image. If it is NULL, this function uses the metadata associated to the orignal Image instance.
inParam Parameters that customizes the export options. It can be NULL and then this function uses the default options.
inCallback Callback instance that periodically notifies the process status.
See also:
BMPExportParam, DataStore, ProcessCallback, exportAsVFZ, exportAsMrSID, exportAsPNG, exportAsJPEG, exportAsTIFF

Exporting Images, BMP (Windows Bitmap) Image File Format

void Celartem::ExportUtils::exportAsJPEG ( Storage *  inStorage,
Image *  inImage,
DataStore *  inMetadata = NULL,
JPEGExportParam *  inParam = NULL,
ProcessCallback *  inCallback = NULL 
)

This function exports the specified Image instance as JPEG file.

Parameters:
inStorage The storage to write on.
inImage The image to be exported.
inMetadata DataStore instance that contains the metadata for the exported image. If it is NULL, this function uses the metadata associated to the orignal Image instance.
inParam Parameters that customizes the export options. It can be NULL and then this function uses the default options.
inCallback Callback instance that periodically notifies the process status.
See also:
JPEGExportParam, DataStore, ProcessCallback, exportAsVFZ, exportAsMrSID, exportAsPNG, exportAsBMP, exportAsTIFF

Exporting Images, JPEG Image File Format

void Celartem::ExportUtils::exportAsJPEG2000 ( Storage *  inStorage,
Image *  inImage,
DataStore *  inMetadata = NULL,
JPEG2000ExportParam *  inParam = NULL,
ProcessCallback *  inCallback = NULL 
)

This function exports the specified Image instance as JPEG2000 file.

Parameters:
inStorage The storage to write on.
inImage The image to be exported.
inMetadata DataStore instance that contains the metadata for the exported image. If it is NULL, this function uses the metadata associated to the orignal Image instance.
inParam Parameters that customizes the export options. It can be NULL and then this function uses the default options.
inCallback Callback instance that periodically notifies the process status.
See also:
JPEG2000ExportParam, DataStore, ProcessCallback, exportAsVFZ, exportAsTIFF, exportAsJPEG, exportAsBMP,exportAsPNG, unlockMrSIDExportRestriction, isMrSIDExportRestricted

Exporting Images, MrSID Image File Format

void Celartem::ExportUtils::exportAsMrSID ( Storage *  inStorage,
Image *  inImage,
DataStore *  inMetadata = NULL,
MrSIDExportParam *  inParam = NULL,
ProcessCallback *  inCallback = NULL 
)

This function exports the specified Image instance as MrSID file. By default, the size of the exported MrSID file size is limited to 100MB. If you want to export MrSID files larger than 100MB, you should obtain MrSID encoding license from Celartem Technology Inc. and then call unlockMrSIDExportRestriction function once before call of this function.

Parameters:
inStorage The storage to write on.
inImage The image to be exported.
inMetadata DataStore instance that contains the metadata for the exported image. If it is NULL, this function uses the metadata associated to the orignal Image instance.
inParam Parameters that customizes the export options. It can be NULL and then this function uses the default options.
inCallback Callback instance that periodically notifies the process status.
See also:
MrSIDExportParam, DataStore, ProcessCallback, exportAsVFZ, exportAsTIFF, exportAsJPEG, exportAsBMP,exportAsPNG, unlockMrSIDExportRestriction, isMrSIDExportRestricted

Exporting Images, MrSID Image File Format

void Celartem::ExportUtils::exportAsMultiPageTIFF ( Storage *  inStorage,
SimpleArray< AutoPtr< Image > > &  inImages,
SimpleArray< AutoPtr< DataStore > > &  inMetadatas,
TIFFExportParam *  inParam = NULL,
ProcessCallback *  inCallback = NULL 
)

This function exports the specified Image instances as multi page TIFF file. If you only want to export simple TIFF file, use exportAsTIFF function. For more information about this function, see Exporting Multipage TIFF Files.

Parameters:
inStorage The storage to write on.
inImages The images to be exported.
inMetadatas DataStore instances that contains the metadata for the exported image. If you want to use the metadata obtained by each image, specify the array of NULL entries.
inParam Parameters that customizes the export options. It can be NULL and then this function uses the default options.
inCallback Callback instance that periodically notifies the process status.
See also:
TIFFExportParam, exportAsTIFF, DataStore, ProcessCallback, exportAsVFZ, exportAsMrSID, exportAsJPEG, exportAsBMP, exportAsPNG

Exporting Images, TIFF Image File Format

void Celartem::ExportUtils::exportAsPFZ ( Storage *  inStorage,
Image *  inImage,
const String &  inPadsAddress,
CredentialProvider *  inCredentialProvider,
HttpManager *  inHttpManager = NULL,
DataStore *  inMetadata = NULL,
VFZExportParam *  inParam = NULL,
ProcessCallback *  inCallback = NULL 
)

This function exports the specified Image instance as PFZ file. For more information about this function, see Exporting PFZ Files.

Parameters:
inStorage The storage to write on.
inImage The image to be exported.
inPadsAddress The address of PixelSafe Server. It should be in either of "hostname:port" or "xxx.xxx.xxx.xxx:port". If there're any other elements in the address, they are simply ignored.
inCredentialProvider A CredentialProvider instance that provides account information to log onto the PixelSafe Server.
inHttpManager A HttpManager instance that is used to create PixelSafe session. It can be NULL and then this function automatically create an instance.
inMetadata DataStore instance that contains the metadata for the exported image. If it is NULL, this function uses the metadata associated to the orignal Image instance.
inParam Parameters that customizes the export options. It can be NULL and then this function uses the default options.
inCallback Callback instance that periodically notifies the process status.
See also:
Exporting PFZ Files, VFZExportParam, exportAsVFZ, DataStore, ProcessCallback, exportAsMrSID, exportAsTIFF, exportAsJPEG, exportAsBMP, exportAsPNG

Exporting Images, VFZ/PFZ Image File Format

void Celartem::ExportUtils::exportAsPFZ2 ( GenericExportFunction  inExportFunction,
Storage *  inStorage,
Image *  inImage,
const String &  inPadsAddress,
CredentialProvider *  inCredentialProvider,
HttpManager *  inHttpManager = NULL,
DataStore *  inMetadata = NULL,
void *  inParam = NULL,
ProcessCallback *  inCallback = NULL 
)

This function exports the specified Image instance as PFZ file. For more information about this function, see Exporting PFZ Files.

Parameters:
inExportFunction The actual function which exports the image to a storage.
inStorage The storage to write on.
inImage The image to be exported.
inPadsAddress The address of PixelSafe Server. It should be in either of "hostname:port" or "xxx.xxx.xxx.xxx:port". If there're any other elements in the address, they are simply ignored.
inCredentialProvider A CredentialProvider instance that provides account information to log onto the PixelSafe Server.
inHttpManager A HttpManager instance that is used to create PixelSafe session. It can be NULL and then this function automatically create an instance.
inMetadata DataStore instance that contains the metadata for the exported image. If it is NULL, this function uses the metadata associated to the orignal Image instance.
inParam Parameters that customizes the export options. It can be NULL and then this function uses the default options.
inCallback Callback instance that periodically notifies the process status.
See also:
Exporting PFZ Files, GenericExportFunction, DataStore, ProcessCallback, exportAsPFZ, exportAsVFZ, exportAsMrSID, exportAsTIFF, exportAsJPEG, exportAsBMP, exportAsPNG

Exporting Images, VFZ/PFZ Image File Format

void Celartem::ExportUtils::exportAsPNG ( Storage *  inStorage,
Image *  inImage,
DataStore *  inMetadata = NULL,
PNGExportParam *  inParam = NULL,
ProcessCallback *  inCallback = NULL 
)

This function exports the specified Image instance as PNG file.

Parameters:
inStorage The storage to write on.
inImage The image to be exported.
inMetadata DataStore instance that contains the metadata for the exported image. If it is NULL, this function uses the metadata associated to the orignal Image instance.
inParam Parameters that customizes the export options. It can be NULL and then this function uses the default options.
inCallback Callback instance that periodically notifies the process status.
See also:
PNGExportParam, DataStore, ProcessCallback, exportAsVFZ, exportAsMrSID, exportAsJPEG, exportAsBMP, exportAsTIFF

Exporting Images, PNG Image File Format

void Celartem::ExportUtils::exportAsTIFF ( Storage *  inStorage,
Image *  inImage,
DataStore *  inMetadata = NULL,
TIFFExportParam *  inParam = NULL,
ProcessCallback *  inCallback = NULL 
)

This function exports the specified Image instance as TIFF file.

Parameters:
inStorage The storage to write on.
inImage The image to be exported.
inMetadata DataStore instance that contains the metadata for the exported image. If it is NULL, this function uses the metadata associated to the orignal Image instance.
inParam Parameters that customizes the export options. It can be NULL and then this function uses the default options.
inCallback Callback instance that periodically notifies the process status.
See also:
TIFFExportParam, exportAsMultiPageTIFF, DataStore, ProcessCallback, exportAsVFZ, exportAsMrSID, exportAsJPEG, exportAsBMP, exportAsPNG

Exporting Images, TIFF Image File Format

void Celartem::ExportUtils::exportAsTIFFPyramid ( Storage *  inStorage,
Image *  inImage,
DataStore *  inMetadata = NULL,
TIFFPyramidExportParam *  inParam = NULL,
ProcessCallback *  inCallback = NULL 
)

This function exports the specified Image instances as pyramid TIFF file. If you only want to export simple TIFF file, use exportAsTIFF function. For more information about this function, see Exporting Multipage TIFF Files.

Parameters:
inStorage The storage to write on.
inImage The primary (largest) image to be exported.
inMetadata DataStore instance that contains the metadata for the exported image. If it is NULL, this function uses the metadata associated to the orignal Image instance.
inParam Parameters which specifies the sub-images and export options. It can be NULL and then this function export single layer TIFF file.
inCallback Callback instance that periodically notifies the process status.
See also:
TIFFPyramidExportParam, exportAsTIFF, DataStore, ProcessCallback, exportAsVFZ, exportAsMrSID, exportAsJPEG, exportAsBMP, exportAsPNG

Exporting Images, TIFF Image File Format

void Celartem::ExportUtils::exportAsVFZ ( Storage *  inStorage,
Image *  inImage,
DataStore *  inMetadata = NULL,
VFZExportParam *  inParam = NULL,
ProcessCallback *  inCallback = NULL 
)

This function exports the specified Image instance as VFZ file.

Parameters:
inStorage The storage to write on.
inImage The image to be exported.
inMetadata DataStore instance that contains the metadata for the exported image. If it is NULL, this function uses the metadata associated to the orignal Image instance.
inParam Parameters that customizes the export options. It can be NULL and then this function uses the default options.
inCallback Callback instance that periodically notifies the process status.
See also:
VFZExportParam, DataStore, ProcessCallback, exportAsMrSID, exportAsTIFF, exportAsJPEG, exportAsBMP, exportAsPNG

Exporting Images, VFZ/PFZ Image File Format

bool Celartem::ExportUtils::isMrSIDExportRestricted (  ) 

This function is to check whether MrSID export file size is limited or not.

Returns:
true if limited, otherwise false.
See also:
exportAsMrSID, unlockMrSIDExportRestriction

Exporting Images, MrSID Image File Format

void Celartem::ExportUtils::unlockMrSIDExportRestriction ( bool  inUnlock  ) 

This function unlocks the limitation of MrSID export file size. You should obtain license from Celartem Technology Inc. before actually unlock the feature.
Please note that there're no installation or any other procedure to unlock the MrSID export limitation but simply call this function.
Only for the testing purpose, You can unlock the MrSID export limitation without any license from Celartem Technology Inc. Anyway, if you have any questions about the license, please contact us.

Parameters:
inUnlock true to unlock, otherwise lock the feature.
See also:
exportAsMrSID, isMrSIDExportRestricted

Exporting Images, MrSID Image File Format

This document is automatically generated using doxygen 1.5.4 at Fri Jun 27 18:23:32 2008.