ImageCollection Class

class ImageCollection

Namespace:datalogics_interface

Detailed Description

An image collection can hold multiple images, created from an image file.

The full set of images in the collection can be saved to a single image file, but only as a .tif image file. For any other file type (JPG, PNG, and so on), the collection can only be saved as one image object per file.

Referenced by

Page

Uses types

Image ImageType

Constructor & Destructor Documentation

ImageCollection()

Create an empty image collection, which can have Image objects added to it.

ImageCollection(const std::string & file_name)

Parameters

file_name: const std::string &

Create an empty image collection, which can have Image objects added to it.

ImageCollection(ImageCollection && )

Parameters

: ImageCollection &&

~ImageCollection()

Member Function Documentation

void append(Image image)

Parameters

image: Image: the Image object to be inserted.

Returns:

void

Insert the given Image object at the end of the ImageCollection.

int get_count()

Returns:

int

The count of Image objects in the collection.

Gets the number of Image objects in this collection.

Image get_image(int index)

Parameters

index: int: the index of the Image to be retrieved.

Returns:

Image

the Image object at the specified index.

Retrieve the Image object at the specified index. Note that an exception will be generated if an index is given which is out of range.

ImageCollection & operator=(ImageCollection && )

Parameters

: ImageCollection &&

Returns:

ImageCollection &

void save(const std::string & filename, ImageType type)

Parameters

filename: const std::string &: the file which to save the image.
type: ImageType: the image type to which to be saved. NOTE: The resolution of the first Image in the collection is used as the target Resolution for saving. (Support for saving multiple, different resolutions isn't available)

Returns:

void

Save the images in the collection to the specified file and image type. Multiple images can only be save to an image type of TIFF, otherwise an exception will be thrown.

void save(const std::string & filename, ImageType type, const ImageSaveParams & params)

Parameters

filename: const std::string &: the file which to save the image.
type: ImageType: the image type to which to be saved. NOTE: The resolution of the first Image in the collection is used as the target Resolution for saving. (Support for saving multiple, different resolutions isn't available)
params: const ImageSaveParams &

Returns:

void

Save the images in the collection to the specified file and image type. Multiple images can only be save to an image type of TIFF, otherwise an exception will be thrown.