write_image_metadatawrite_image_metadataWriteImageMetadataWriteImageMetadatawrite_image_metadata (算子)
名称
write_image_metadatawrite_image_metadataWriteImageMetadataWriteImageMetadatawrite_image_metadata — 写入图像文件的元数据。
签名
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 (输入控制) string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Graphic format.
默认值：
'tiff'
"tiff"
"tiff"
"tiff"
"tiff"
"tiff"
建议值：
'tiff'"tiff""tiff""tiff""tiff""tiff", 'bigtiff'"bigtiff""bigtiff""bigtiff""bigtiff""bigtiff"
TagNameTagNameTagNameTagNametagNametag_name (输入控制) tuple → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Name of the tag to be written in the image file.
默认值：
'tiff_image_description'
"tiff_image_description"
"tiff_image_description"
"tiff_image_description"
"tiff_image_description"
"tiff_image_description"
建议值：
'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 (输入控制) 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 (输入控制) 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
the operator write_image_metadatawrite_image_metadataWriteImageMetadataWriteImageMetadataWriteImageMetadatawrite_image_metadata 返回值 2 ( H_MSG_TRUE )。否则将抛出异常。 In this case, an extended error
information, as e.g., the causative tag, may be set and can be queried with
the operator get_extended_error_infoget_extended_error_infoGetExtendedErrorInfoGetExtendedErrorInfoGetExtendedErrorInfoget_extended_error_info。
可能的前趋
write_imagewrite_imageWriteImageWriteImageWriteImagewrite_image
可能的后继
read_image_metadataread_image_metadataReadImageMetadataReadImageMetadataReadImageMetadataread_image_metadata
模块
基础