DicomImageInfo Class

Summary: Contains all meta-information from Dicom file header

Module: aspose.imaging.fileformats.dicom

Full Name: aspose.imaging.fileformats.dicom.DicomImageInfo

Aspose.Imaging Version: 24.7.0

Properties

NameTypeAccessDescription
bits_allocatedintrGets a value of the “bitsAllocated”.
bits_storedintrGets the number of stored bits.
bluesbyterGets the array colors of the blue
dicom_header_info_by_bytesbyterGets the dicom header information by bytes.
dicom_infolist[str]rGets the header information of the DICOM file.
greensbyterGets the array colors of the green
heightintrGets the height.
is_little_endianboolrGets a value indicating whether this instance is little endian.
number_of_framesintrGets the number of frames.
offsetintrGets the offset.
photo_interpretationstringrGets a value of the “PhotoInterpretation”.
pixel_representationintrGets a value of the pixel “pixelRepresentation”.
planar_configurationintrGets the planar configuration.
readonly_tags_list [static]list[str]rThe read-only tags list. These tag values will be reset according to the actual image data upon image save.
redsbyterGets the array colors of the red
rescale_interceptdoublerGets a value of the “rescaleIntercept”.
rescale_slopedoublerGets a value of the “rescaleSlope”.
samples_per_pixelintrGets a value of the “samplesPerPixel”.
signed_imageboolrGets a value indicating whether “signedImage”.
widthintrGets the width.
window_centredoublerGets the window centre.
window_widthdoublerGets the width of the window.

Methods

NameDescription
add_tag(tag_description, value)Add new Dicom tag.
remove_tag_at(index)Remove an existing tag.
try_add_tag(tag_description, value)Add new Dicom tag.
try_remove_tag_at(index)Remove an existing tag.
try_update_tag_at(index, new_value)Update an existing tag.
update_tag_at(index, new_value)Update an existing tag.

Method: add_tag(tag_description, value)

 add_tag(tag_description, value) 

Add new Dicom tag.

Parameters:

ParameterTypeDescription
tag_descriptionstringThe tag description. Can not be null or whitespace.
valueobjectThe tag value. Can not be null.

Method: remove_tag_at(index)

 remove_tag_at(index) 

Remove an existing tag.

Parameters:

ParameterTypeDescription
indexintThe index of the tag to be updated.

Method: try_add_tag(tag_description, value)

 try_add_tag(tag_description, value) 

Add new Dicom tag.

Parameters:

ParameterTypeDescription
tag_descriptionstringThe tag description. Can not be null or whitespace.
valueobjectThe tag value. Can not be null.

Returns

TypeDescription
boolThe operation result.

Method: try_remove_tag_at(index)

 try_remove_tag_at(index) 

Remove an existing tag.

Parameters:

ParameterTypeDescription
indexintThe index of the tag to be updated.

Returns

TypeDescription
boolThe operation result.

Method: try_update_tag_at(index, new_value)

 try_update_tag_at(index, new_value) 

Update an existing tag.

Parameters:

ParameterTypeDescription
indexintThe index of the tag to be updated.
new_valueobjectThe tag value. Can not be null.

Returns

TypeDescription
boolThe operation result.

Method: update_tag_at(index, new_value)

 update_tag_at(index, new_value) 

Update an existing tag.

Parameters:

ParameterTypeDescription
indexintThe index of the tag to be updated.
new_valueobjectThe tag value. Can not be null.