VintaSoft Imaging .NET SDK 12.4: Documentation for .NET developer
In This Topic
    VintaSoft DICOM .NET Plug-in: Changes in version 8.7
    In This Topic

    API changes in Vintasoft.Imaging.Dicom.dll

    New classes:

    public class Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomStudyInfo Stores information about a DICOM study.
    public abstract class Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomUtils Contains collection of helper-algorithms for DICOM.
    public class Vintasoft.Imaging.Metadata.DicomMprSliceMetadata A root tree node that stores metadata of DICOM MPR slice.


    Removed classes:

    public class Vintasoft.Imaging.Metadata.DicomDataElementCollectionBaseMedatada This class is obsolete, use DicomDataSetMetadata instead.


    Changed classes:

    Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomFile
    Added properties
    public Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomStudyInfo StudyInfo { get; } Gets the study information of DICOM file.
    Renamed properties
    public Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomGroupedDataSetCollection DataSets { get; } public Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomDataSet DataSet { get; }


    Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomFrame
    Added properties
    public int FrameNumber { get; } Gets the frame number.
    public Vintasoft.Imaging.VintasoftVector3D PatientImageOrientationXAxis { get; } Gets the X-vector direction vector for patient of the patient image.
    public Vintasoft.Imaging.VintasoftVector3D PatientImageOrientationYAxis { get; } Gets the Y-vector direction vector for patient of the patient image.
    public Vintasoft.Imaging.VintasoftPoint3D PatientImagePosition { get; } Gets the location, in millimeters, for patient of the DICOM frame.
    public Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomFile SourceFile { get; } Gets the parent DICOM file of this DICOM frame.
    Added methods
    public Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomFrame GetFrameAssociatedWithImage(Vintasoft.Imaging.VintasoftImage) Returns the frame, which is associated with the image.


    Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomImageLookupTable
    Added methods
    public bool Equals(object) Determines whether two DicomImageLookupTable instances are equal.
    public int GetHashCode() Returns a hash code for this instance.


    Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomImageModalityLookupTable
    Added methods
    public double Calculate(double) Applies the M-Lut to the specified value.


    Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomImageVoiLookupTable
    Added properties
    public Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomImageVoiLookupTableFunctionType FunctionType { get; } Get the Value Of Interest Look Up Table function type.
    Added constructors
    public void DicomImageVoiLookupTable(double, double, Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomImageVoiLookupTableFunctionType, string) Initializes a new instance of the DicomImageVoiLookupTable class.
    public void DicomImageVoiLookupTable(double, double, Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomImageVoiLookupTableFunctionType) Initializes a new instance of the DicomImageVoiLookupTable class.
    Added methods
    public void Scale(double) Scales this DicomImageVoiLookupTable using the specified scale factor.


    Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomUid
    Added fields
    public Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomUid Empty Provides a DicomUid object with empty value.


    Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomAnnotationTreeNode
    Added properties
    public Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomFile SourceFile { get; } Gets the source frame.
    Removed properties
    public Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomGroupedDataSet Identifying { get; } This property is no longer supported.
    Changed properties
    public Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomGroupedDataSet Annotations { get; } public Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomDataSetCollection Annotations { get; }


    Vintasoft.Imaging.ImageProcessing.ApplyDicomImageVoiLutCommand
    Added properties
    public bool IsNegative { get; set; } Gets or sets a value indicating whether the result image must be inverted.
    Removed constructors
    public void ApplyDicomImageVoiLutCommand(Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomImageVoiLookupTable, Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomGroupedDataSetCollection) This constructor is no longer supported.
    Changed constructors
    public void ApplyDicomImageVoiLutCommand(Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomImageVoiLookupTable, Vintasoft.Imaging.Metadata.DicomFrameMetadata) public void ApplyDicomImageVoiLutCommand(Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomImageVoiLookupTable)


    Vintasoft.Imaging.Metadata.DicomDataSetMetadata
    Added properties
    public bool CanRemove { get; } Gets a value that indicating whether the metadata node can be removed from children collection of parent node.
    public bool HasValue { get; } Gets a value indicating whether the node has value.
    Added methods
    public Vintasoft.Imaging.Metadata.DicomDataElementMetadata AddChild(ushort, ushort) Adds element to the end of the Vintasoft.Imaging.Metadata.MetadataNode.Children.
    public Vintasoft.Imaging.Metadata.DicomDataElementMetadata AddChild(ushort, ushort, Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomValueRepresentation) Adds element to the end of the Vintasoft.Imaging.Metadata.MetadataNode.Children.
    public Vintasoft.Imaging.Metadata.DicomDataElementMetadata AddChild(ushort, ushort, object) Adds element to the end of the Vintasoft.Imaging.Metadata.MetadataNode.Children.
    public Vintasoft.Imaging.Metadata.DicomDataElementMetadata AddChild(ushort, ushort, Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomValueRepresentation, object) Adds element to the end of the Vintasoft.Imaging.Metadata.MetadataNode.Children.
    public Vintasoft.Imaging.Metadata.DicomDataElementMetadata FindChildNode(Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomDataElementId) Finds the DicomDataElementMetadata node.
    public Vintasoft.Imaging.Metadata.DicomDataElementMetadata FindChildNode(ushort, ushort) Finds the DicomDataElementMetadata node.
    public bool RemoveChild(Vintasoft.Imaging.Metadata.MetadataNode) Removes the specified node from children nodes of this metadata node.


    Vintasoft.Imaging.Metadata.DicomFrameMetadata
    Added properties
    public Vintasoft.Imaging.VintasoftVector3D PatientImageOrientationXAxis { get; } Gets the X-vector direction vector for patient of the patient image.
    public Vintasoft.Imaging.VintasoftVector3D PatientImageOrientationYAxis { get; } Gets the Y-vector direction vector for patient of the patient image.
    public Vintasoft.Imaging.VintasoftPoint3D PatientImagePosition { get; } Gets the location, in millimeters, for patient of the DICOM frame.
    Added methods
    public Vintasoft.Imaging.Metadata.DicomDataElementMetadata AddChild(ushort, ushort) Adds element to the end of the Vintasoft.Imaging.Metadata.MetadataNode.Children.
    public Vintasoft.Imaging.Metadata.DicomDataElementMetadata AddChild(ushort, ushort, Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomValueRepresentation) Adds element to the end of the Vintasoft.Imaging.Metadata.MetadataNode.Children.
    public Vintasoft.Imaging.Metadata.DicomDataElementMetadata AddChild(ushort, ushort, object) Adds element to the end of the Vintasoft.Imaging.Metadata.MetadataNode.Children.
    public Vintasoft.Imaging.Metadata.DicomDataElementMetadata AddChild(ushort, ushort, Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomValueRepresentation, object) Adds element to the end of the Vintasoft.Imaging.Metadata.MetadataNode.Children.
    public Vintasoft.Imaging.Metadata.DicomDataElementMetadata FindChildNode(Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomDataElementId) Finds the DicomDataElementMetadata node.
    public Vintasoft.Imaging.Metadata.DicomDataElementMetadata FindChildNode(ushort, ushort) Finds the DicomDataElementMetadata node.




    New enumerations:

    public enum Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomAnatomicPositionDirection Specifies available directions for anatomic positions.
    public enum Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomImageVoiLookupTableFunctionType Represents available function types for the Value Of Interest Look Up Tables.




    API changes in Vintasoft.Imaging.Dicom.UI.dll

    New classes:

    public class Vintasoft.Imaging.Dicom.UI.VisualTools.CustomDicomDataElementTextOverlay The text object that shows a custom data element of DICOM file in image viewer.
    public abstract class Vintasoft.Imaging.Dicom.UI.VisualTools.DicomDataElementTextOverlay Provides an abstract base class for static text objects, which can be displayed in image viewer. The text of text objects is loading from DicomDataElementMetadata.
    public class Vintasoft.Imaging.Dicom.UI.VisualTools.DicomImageVoiLutTextOverlay The text object that shows a VOI LUT for DICOM frame in image viewer.
    public abstract class Vintasoft.Imaging.Dicom.UI.VisualTools.DicomMetadataTextOverlay Provides an abstract base class for static text objects, which can be displayed in image viewer. The text of text objects is loading from DicomFrameMetadata.
    public abstract class Vintasoft.Imaging.Dicom.UI.VisualTools.DicomViewerToolTextOverlay Provides an abstract base class for static text objects of DicomViewerTool , which can be displayed in image viewer.
    public class Vintasoft.Imaging.Dicom.UI.VisualTools.PatientOrientationTextOverlay The text object that shows a patient orientation of DICOM frame in image viewer. The text of text objects is loading from DicomFrameMetadata.
    public class Vintasoft.Imaging.Dicom.UI.VisualTools.StandardDicomDataElementTextOverlay The text object that shows a standard data element of DICOM file in image viewer.


    Changed classes:

    Vintasoft.Imaging.Dicom.UI.VisualTools.DicomViewerTool
    Added properties
    public bool AlwaysLoadVoiLutFromMetadataOfDicomFrame { get; set; } Gets or sets a value indicating whether the VOI LUT must be always loaded from DICOM frame metadata when image is changed.
    public Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomImageVoiLookupTable DefaultDicomImageVoiLut { get; } Gets the VOI LUT, which is loaded from DICOM image metadata, of focused DICOM image.
    public Vintasoft.Imaging.Dicom.UI.VisualTools.DicomImageVoiLutMouseMoveDirection DicomImageVoiLutMouseMoveDirection { get; set; } Gets or sets a mouse gesture, which must be used for changing the VOI lookup table of DICOM image.
    public double DicomImageVoiLutMouseSensitivity { get; set; } Gets or sets a mouse sensitivity, which must be used for changing VOI lookup table of DICOM image.
    public double DicomImageVoiLutOffset { get; set; } Gets or sets the offset of DicomImageVoiLut.WindowCenter.
    public double DicomImageVoiLutScale { get; set; } Gets or sets the scale for DicomImageVoiLut.
    public Vintasoft.Imaging.VintasoftImage DisplayedImage { get; } Gets the 8-bpp grayscale image, which is displayed in image viewer.
    public Vintasoft.Imaging.ImageProcessing.ProcessingCommandBase DisplayedImageProcessing { get; set; } Gets or sets the image processing command, which must be applied to the DisplayedImage.
    public System.Collections.Generic.IList<Vintasoft.Imaging.UI.VisualTools.GraphicObjects.GraphicObject> GraphicalOverlay { get; } Gets a collection of static graphic objects, which are displayed in viewer.
    public bool IsGraphicalOverlayVisible { get; set; } Gets or sets a value indicating whether the visual tool must show static graphic objects in image viewer.
    public bool IsImageNegative { get; set; } Gets or sets a value indicating whether the image must be inverted.
    public bool IsTextOverlayVisible { get; set; } Gets or sets a value indicating whether the visual tool must show information with DICOM metadata on image viewer.
    public Vintasoft.Imaging.Dicom.UI.VisualTools.DicomViewerToolMouseWheelInteractionMode MouseWheelInteractionMode { get; set; } Gets or sets the interaction mode for the mouse wheel.
    public object RenderSyncObject { get; set; } Gets or sets the object for image rendering synchronization.
    public bool ShowDicomImageVoiLut { get; set; } This property is obsolete, use the TextOverlay property instead.
    public bool ShowPatientOrientationMetadata { get; set; } This property is obsolete, use the TextOverlay property instead.
    public Vintasoft.Imaging.UI.VisualTools.TextOverlayCollection TextOverlay { get; } Gets a collection of text overlays, which are displayed on viewer.
    public string VoiLutTextFormat { get; set; } This property is obsolete, use the ImagingEnvironment.ResourceManager property instead.
    public int ZoomStep { get; set; } Gets or sets the zoom step of the image.
    Added constructors
    public void DicomViewerTool(bool) Initializes a new instance of the DicomViewerTool class.
    Added methods
    public Vintasoft.Imaging.VintasoftImage GetDisplayedImage() Returns a copy of 8-bpp grayscale image, which is displayed in image viewer.
    public void UpdateDisplayedImage() Updates the 8-bpp grayscale image, which is displayed in image viewer.
    public void UpdateImage() Updates the source image.




    New enumerations:

    public enum Vintasoft.Imaging.Dicom.UI.VisualTools.DicomImageVoiLutMouseMoveDirection Specifies available mouse gestures, which are changing the VOI lookup table of DICOM image.
    public enum Vintasoft.Imaging.Dicom.UI.VisualTools.DicomViewerToolMouseWheelInteractionMode Specifies available modes, which specify how user can interact with image using the DicomViewerTool.




    API changes in Vintasoft.Imaging.Dicom.Wpf.UI.dll

    New classes:

    public class Vintasoft.Imaging.Dicom.Wpf.UI.VisualTools.WpfCustomDicomDataElementTextOverlay The text object that shows a custom data element of DICOM file in image viewer.
    public abstract class Vintasoft.Imaging.Dicom.Wpf.UI.VisualTools.WpfDicomDataElementTextOverlay Provides an abstract base class for static text objects, which can be displayed in image viewer. The text of text objects is loading from DicomDataElementMetadata.
    public class Vintasoft.Imaging.Dicom.Wpf.UI.VisualTools.WpfDicomImageVoiLutTextOverlay The text object that shows a VOI LUT for DICOM frame in image viewer.
    public abstract class Vintasoft.Imaging.Dicom.Wpf.UI.VisualTools.WpfDicomMetadataTextOverlay Provides an abstract base class for static text objects, which can be displayed in image viewer. The text of text objects is loading from DicomFrameMetadata.
    public abstract class Vintasoft.Imaging.Dicom.Wpf.UI.VisualTools.WpfDicomViewerToolTextOverlay Provides an abstract base class for static text objects of WpfDicomViewerTool , which can be displayed in image viewer.
    public class Vintasoft.Imaging.Dicom.Wpf.UI.VisualTools.WpfPatientOrientationTextOverlay The text object that shows a patient orientation of DICOM frame in image viewer. The text of text objects is loading from DicomFrameMetadata.
    public class Vintasoft.Imaging.Dicom.Wpf.UI.VisualTools.WpfStandardDicomDataElementTextOverlay The text object that shows a standard data element of DICOM file in image viewer.


    Changed classes:

    Vintasoft.Imaging.Dicom.Wpf.UI.VisualTools.WpfDicomViewerTool
    Added properties
    public bool AlwaysLoadVoiLutFromMetadataOfDicomFrame { get; set; } Gets or sets a value indicating whether the VOI LUT must be always loaded from DICOM frame metadata when image is changed.
    public Vintasoft.Imaging.Codecs.ImageFiles.Dicom.DicomImageVoiLookupTable DefaultDicomImageVoiLut { get; } Gets the VOI LUT, which is loaded from DICOM image metadata, of focused DICOM image.
    public Vintasoft.Imaging.Dicom.Wpf.UI.VisualTools.DicomImageVoiLutMouseMoveDirection DicomImageVoiLutMouseMoveDirection { get; set; } Gets or sets a mouse gesture, which must be used for changing the VOI lookup table of DICOM image.
    public double DicomImageVoiLutMouseSensitivity { get; set; } Gets or sets a mouse sensitivity, which must be used for changing VOI lookup table of DICOM image.
    public Vintasoft.Imaging.VintasoftImage DisplayedImage { get; } Gets the 8-bpp grayscale image, which is displayed in image viewer.
    public Vintasoft.Imaging.ImageProcessing.ProcessingCommandBase DisplayedImageProcessing { get; set; } Gets or sets the image processing command, which must be applied to the DisplayedImage.
    public System.Collections.Generic.IList<Vintasoft.Imaging.Wpf.UI.VisualTools.GraphicObjects.WpfGraphicObject> GraphicalOverlay { get; } Gets a collection of static graphic objects, which are displayed in viewer.
    public bool IsGraphicalOverlayVisible { get; set; } Gets or sets a value indicating whether the visual tool must show static graphic objects in image viewer.
    public bool IsImageNegative { get; set; } Gets or sets a value indicating whether the image must be inverted.
    public bool IsTextOverlayVisible { get; set; } Gets or sets a value indicating whether the visual tool must show information with DICOM metadata on image viewer.
    public Vintasoft.Imaging.Dicom.Wpf.UI.VisualTools.DicomViewerToolMouseWheelInteractionMode MouseWheelInteractionMode { get; set; } Gets or sets the interaction mode for the mouse wheel.
    public object RenderSyncObject { get; set; } Gets or sets the object for image rendering synchronization.
    public bool ShowDicomImageVoiLut { get; set; } This property is obsolete, use the TextOverlay property instead.
    public bool ShowPatientOrientationMetadata { get; set; } This property is obsolete, use the TextOverlay property instead.
    public Vintasoft.Imaging.Wpf.UI.VisualTools.WpfTextOverlayCollection TextOverlay { get; } Gets a collection of text overlays, which are displayed on viewer.
    public Vintasoft.Imaging.Dicom.Wpf.UI.VisualTools.WpfDicomImageVoiLutTextOverlay VoiLutInfoTextOverlay { get; set; } Gets or sets a text overlay, which must be used for previewing VOI LUT value.
    public string VoiLutTextFormat { get; set; } This property is obsolete, use the ImagingEnvironment.ResourceManager property instead.
    public int ZoomStep { get; set; } Gets or sets the zoom step of the image.
    Added constructors
    public void WpfDicomViewerTool(bool) Initializes a new instance of the WpfDicomViewerTool class.
    Added methods
    public Vintasoft.Imaging.VintasoftImage GetDisplayedImage() Returns a copy of 8-bpp grayscale image, which is displayed in image viewer.
    public void UpdateDisplayedImage() Updates the 8-bpp grayscale image, which is displayed in image viewer.
    public void UpdateImage() Updates the source image.




    New enumerations:

    public enum Vintasoft.Imaging.Dicom.Wpf.UI.VisualTools.DicomImageVoiLutMouseMoveDirection Specifies available mouse gestures, which are changing the VOI lookup table of DICOM image.
    public enum Vintasoft.Imaging.Dicom.Wpf.UI.VisualTools.DicomViewerToolMouseWheelInteractionMode Specifies available modes, which specify how user can interact with image using the WpfDicomViewerTool.




    New Vintasoft.Imaging.Dicom.Mpr.dll

    New assembly Vintasoft.Imaging.Dicom.Mpr.dll contains classes, which implement DICOM MPR (multi planar reconstruction) in .NET.


    New Vintasoft.Imaging.Dicom.Mpr.UI.dll

    New assembly Vintasoft.Imaging.Dicom.Mpr.UI.dll contains classes, which allow to view and transform DICOM MPR slices in WinForms image viewer.