write_image_metadatawrite_image_metadataWriteImageMetadataWriteImageMetadatawrite_image_metadata (算子名称)
名称
write_image_metadatawrite_image_metadataWriteImageMetadataWriteImageMetadatawrite_image_metadata — Write metadata of image files.
参数签名
void WriteImageMetadata(const HTuple& Format, const HTuple& TagName, const HTuple& TagValue, const HTuple& FileName)
static void HImage::WriteImageMetadata(const HString& Format, const HTuple& TagName, const HTuple& TagValue, const HString& FileName)
static void HImage::WriteImageMetadata(const char* Format, const HTuple& TagName, const HTuple& TagValue, const char* FileName)
static void HImage::WriteImageMetadata(const wchar_t* Format, const HTuple& TagName, const HTuple& TagValue, const wchar_t* FileName)
(
Windows only)
描述
该算子 write_image_metadatawrite_image_metadataWriteImageMetadataWriteImageMetadataWriteImageMetadatawrite_image_metadata saves the information in
TagValueTagValueTagValueTagValuetagValuetag_value with the tag TagNameTagNameTagNameTagNametagNametag_name into the file
FileNameFileNameFileNameFileNamefileNamefile_name.
In doing so, TagValueTagValueTagValueTagValuetagValuetag_value and TagNameTagNameTagNameTagNametagNametag_name can be single values
or tuples of values.
The parameter FormatFormatFormatFormatformatformat specifies, in which format
the metadata is to be written.
This operators supports for FormatFormatFormatFormatformatformat the TIFF metadata
formats 'tiff'"tiff""tiff""tiff""tiff""tiff" and 'bigtiff'"bigtiff""bigtiff""bigtiff""bigtiff""bigtiff".
A file extension .tif is expected.
A list of the supported tag names for TagNameTagNameTagNameTagNametagNametag_name and the according
data types for TagValueTagValueTagValueTagValuetagValuetag_value is given in read_image_metadataread_image_metadataReadImageMetadataReadImageMetadataReadImageMetadataread_image_metadata.
运行信息
- 多线程类型:可重入(与非独占操作符并行运行)。
- 多线程作用域:全局(可以从任何线程调用)。
- 未经并行化处理。
参数表
FormatFormatFormatFormatformatformat (input_control) string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Graphic format.
Default:
'tiff'
"tiff"
"tiff"
"tiff"
"tiff"
"tiff"
Suggested values:
'tiff'"tiff""tiff""tiff""tiff""tiff", 'bigtiff'"bigtiff""bigtiff""bigtiff""bigtiff""bigtiff"
TagNameTagNameTagNameTagNametagNametag_name (input_control) tuple → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Name of the tag to be written in the image file.
Default:
'tiff_image_description'
"tiff_image_description"
"tiff_image_description"
"tiff_image_description"
"tiff_image_description"
"tiff_image_description"
Suggested values:
'tiff_image_description'"tiff_image_description""tiff_image_description""tiff_image_description""tiff_image_description""tiff_image_description", 'tiff_make'"tiff_make""tiff_make""tiff_make""tiff_make""tiff_make", 'tiff_software'"tiff_software""tiff_software""tiff_software""tiff_software""tiff_software", 'tiff_date_time'"tiff_date_time""tiff_date_time""tiff_date_time""tiff_date_time""tiff_date_time", 'tiff_copyright'"tiff_copyright""tiff_copyright""tiff_copyright""tiff_copyright""tiff_copyright", 'tiff_exposure_time'"tiff_exposure_time""tiff_exposure_time""tiff_exposure_time""tiff_exposure_time""tiff_exposure_time", 'tiff_aperture_value'"tiff_aperture_value""tiff_aperture_value""tiff_aperture_value""tiff_aperture_value""tiff_aperture_value", 'tiff_light_source'"tiff_light_source""tiff_light_source""tiff_light_source""tiff_light_source""tiff_light_source"
TagValueTagValueTagValueTagValuetagValuetag_value (input_control) tuple → HTupleUnion[int, float, str]HTupleHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double)
Value of the tag to be written in the image file.
FileNameFileNameFileNameFileNamefileNamefile_name (input_control) filename.write → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Name of image file.
File extension:
.tif, .tiff
结果
If TagValueTagValueTagValueTagValuetagValuetag_value can be correctly written for the specified parameters
该算子 write_image_metadatawrite_image_metadataWriteImageMetadataWriteImageMetadataWriteImageMetadatawrite_image_metadata 返回值 2 (
H_MSG_TRUE)
.
Otherwise an exception is raised. In this case, an extended error
information, as e.g., the causative tag, may be set and can be queried with
该算子 get_extended_error_infoget_extended_error_infoGetExtendedErrorInfoGetExtendedErrorInfoGetExtendedErrorInfoget_extended_error_info.
可能的前置算子
write_imagewrite_imageWriteImageWriteImageWriteImagewrite_image
可能的后置算子
read_image_metadataread_image_metadataReadImageMetadataReadImageMetadataReadImageMetadataread_image_metadata
模块
Foundation