imagecompression.h File Reference

#include <string>
#include <unidefs.h>
#include <imagecompression/libimagecompression_exports.h>
#include <imagecompression/libimagecompression_undef.h>

Go to the source code of this file.

Functions
IMAGECOMPRESSION_API int	IMAGECOMPRESSION_invoke_translation_on_dataset (tag_t dataset)

Function Documentation

IMAGECOMPRESSION_API int IMAGECOMPRESSION_invoke_translation_on_dataset

(

tag_t

dataset

)

Invokes the translation on the input Dataset into derived lower resolution Datasets based on the the values specified in the preference "TC__image_compression_types".
The translated lower resolution datasets will be related to the supplied dataset with "Fnd0DerivedImangeRel" relation.

The input Dataset must contain the NamedReference listed in the preference "TC__thumbnail_dataset_type_order", must be a secondary object of any relation and the primary object of that relation is included in the "Fnd0ImageTranslationSupportedPrimaryTypes" global constant.

Returns

• ITK_ok on success.
• IMAGECOMPRESSION_error_dataset_nulltag if dataset is NULLTAG
• IMAGECOMPRESSION_error_input_not_dataset if the input object is not of type Dataset.
• IMAGECOMPRESSION_error_invalid_dataset if dataset does not exist or is deleted.
• IMAGECOMPRESSION_error_imagecompression_not_enabled if the preference "TC__image_compression_enabled" is not set to "true"
• #IMAGECOMPRESSION_error_dataset_invalid_namedrefernece if dataset does not contain any NamedReference specified in the preference "TC__thumbnail_dataset_type_order".
• IMAGECOMPRESSION_error_invalid_imagetype_pref_value if the preference "TC__image_compression_types" does not contain any value.
• #IMAGECOMPRESSION_error_invalid_primary if none of the primary objects associated with dataset is of a type listed in the BMIDE constant "Fnd0ImageTranslationSupportedPrimaryTypes".

Parameters

dataset

(I) The source dataset on which translation should be invoked.