DicomImageInfo Class

Summary: Contains all meta-information from Dicom file header

Module: aspose.imaging.fileformats.dicom

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

Properties

Name	Type	Access	Description
bits_allocated	int	r	Gets a value of the “bitsAllocated”.
bits_stored	int	r	Gets the number of stored bits.
blues	byte	r	Gets the array colors of the blue
dicom_header_info_by_bytes	byte	r	Gets the dicom header information by bytes.
dicom_info	list[str]	r	Gets the header information of the DICOM file.
greens	byte	r	Gets the array colors of the green
height	int	r	Gets the height.
is_little_endian	bool	r	Gets a value indicating whether this instance is little endian.
number_of_frames	int	r	Gets the number of frames.
offset	int	r	Gets the offset.
photo_interpretation	string	r	Gets a value of the “PhotoInterpretation”.
pixel_representation	int	r	Gets a value of the pixel “pixelRepresentation”.
planar_configuration	int	r	Gets the planar configuration.
readonly_tags_list [static]	list[str]	r	The read-only tags list. These tag values will be reset according to the actual image data upon image save.
reds	byte	r	Gets the array colors of the red
rescale_intercept	double	r	Gets a value of the “rescaleIntercept”.
rescale_slope	double	r	Gets a value of the “rescaleSlope”.
samples_per_pixel	int	r	Gets a value of the “samplesPerPixel”.
signed_image	bool	r	Gets a value indicating whether “signedImage”.
width	int	r	Gets the width.
window_centre	double	r	Gets the window centre.
window_width	double	r	Gets the width of the window.

Methods

Name	Description
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:

Parameter	Type	Description
tag_description	string	The tag description. Can not be null or whitespace.
value	object	The tag value. Can not be null.

Method: remove_tag_at(index)

 remove_tag_at(index) 

Remove an existing tag.

Parameters:

Parameter	Type	Description
index	int	The 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:

Parameter	Type	Description
tag_description	string	The tag description. Can not be null or whitespace.
value	object	The tag value. Can not be null.

Returns

Type	Description
bool	The operation result.

Method: try_remove_tag_at(index)

 try_remove_tag_at(index) 

Remove an existing tag.

Parameters:

Parameter	Type	Description
index	int	The index of the tag to be updated.

Returns

Type	Description
bool	The operation result.

Method: try_update_tag_at(index, new_value)

 try_update_tag_at(index, new_value) 

Update an existing tag.

Parameters:

Parameter	Type	Description
index	int	The index of the tag to be updated.
new_value	object	The tag value. Can not be null.

Returns

Type	Description
bool	The operation result.

Method: update_tag_at(index, new_value)

 update_tag_at(index, new_value) 

Update an existing tag.

Parameters:

Parameter	Type	Description
index	int	The index of the tag to be updated.
new_value	object	The tag value. Can not be null.