DicomObjects.NET.V8
DicomObjects Namespace / DicomImage Class
Properties Methods Events

In This Topic
    DicomImage Class Members
    In This Topic

    The following tables list the members exposed by DicomImage.

    Public Constructors
     NameDescription
    Public ConstructorOverloaded. Creates a blank DicomImage object  
    Top
    Public Properties
     NameDescription
    Public PropertyThe Accession Number  
    Public Property Controls the rotation of an image  
    Public PropertyThe display area of DicomImage  
    Public PropertyThe Pen object for Image border  
    Public Property Controls how the pixel data is cached  
    Public PropertyUser defined background colour for image output of PrinterImage, Bitmap and SubImage methods Default is Black background  
    Public Property Style sheet used for displaying encapsulated CDA  
    Public Property The set of frames to display for cine modes  
    Public PropertyThe index of the currently displayed frame when using CineMode  
    Public PropertyEnumerated running modes for multi-frame image  
    Public PropertyControls the speed of autonomous cine runs  
    Public Property Boolean property indicating whether Smoothing is applied when Cine is being displayed.  
    Public PropertyThe colour lookup table of DicomImage  
    Public Property Parameter to control the degree of smoothing. The default value is �0.75, and normal values range from �0.5 to �1.25, though higher negative values may be used to produce deliberate edge enhancement.  
    Public PropertyThe underlying DICOM Dataset containing persistent data for the image  
    Public PropertyDate of birth of the patient  
    Public Propertystatic (Shared in Visual Basic)Default value for the ModalityLUT property  
    Public Propertystatic (Shared in Visual Basic)Default value for the PresentationLUT property  
    Public Propertystatic (Shared in Visual Basic) Controls the default for how cine images are displayed  
    Public Propertystatic (Shared in Visual Basic)Default value for the VoiLUT property  
    Public Property Controls how the image is rendered internal before transfer to the screen  
    Public Property Specify the DrawCacheMode to control how image is drawn/cached  
    Public Property An explicit modality Lookup Table to be used in place of one specified in the image or presentaiton state.  
    Public Property An explicit presentation Lookup Table to be used in place of one specified in the image or presentaiton state.  
    Public Property An explicit Values of Interest (VOI) Lookup Table to be used in place of one specified in the image or presentaiton state.  
    Public PropertyContains the length of the smoothing filter  
    Public Property The flip state of the image, allowing the orientation of the image, as displayed, to be altered  
    Public PropertyControls which frame of a multi-frame image is displayed  
    Public PropertyThe number of frames contained in a multi-frame image  
    Public PropertyA number that specifies a power  
    Public Property Unique identifier for the four levels of the DICOM Query/Retrieve hierarchy  
    Public PropertyControls whether the Image will be inverted.  
    Public PropertyOverloaded. Note: C# syntax for the "Item" property is wrongly represented in a VB.NET syntax. This is a bug in the help file generator, and will be corrected in a later version of our help file.  
    Public Propertystatic (Shared in Visual Basic) The size of the first request (in bytes) to make to a JPIP server.  
    Public Property The size of the requests other than the first (in bytes) to make to a JPIP server.  
    Public PropertyProvides access to the DicomLabelCollection, items of which are to be displayed over an image.  
    Public PropertyThe Window Level (also known as the centre) - which controls the greyscale mapping of a displayed image  
    Public Property Provides a means to modify the usage of a Values of Interest Lookup Table (VOI LUT) or other display mapping  
    Public PropertyControls how pixels are interpolated when the image is magnified  
    Public Property

    Contains an array of DicomMaskRange objects to be applied to this image.

    See the DicomMaskRange object for more information on how this is used.

     
    Public PropertyControls how pixels are interpolated when the image is minified  
    Public PropertyEnables or disables the Modality Lookup Table to be used in the DicomImage  
    Public PropertyThe Name of the patient  
    Public PropertyOriginal Transfer syntax of the underlying DataSet  
    Public PropertyControls how overlays embedded in the image are displayed  
    Public PropertyControls whether overlays embedded in the image are displayed  
    Public PropertyThe Patient ID  
    Public PropertyAccesses the raw pixel data as a typed array  
    Public PropertyEnables or disables the Presentation Lookup Table to be used in the DicomImage  
    Public PropertySupport for DICOM greyscale presentation state  
    Public Property The presentation state features to use  
    Public PropertySupport for a list of DICOM greyscale presentation state  
    Public PropertyAccesses the raw pixel data as an array  
    Public Property Controls how cine images are displayed  
    Public PropertyReturns the Image display size in output (normally screen) coordinates  
    Public Property The rotation state of the image, allowing the orientation of the image, as displayed, to be altered  
    Public Property Controls the baseline positioning of an image which is not stretched to fit and is rotated  
    Public PropertyControls the positioning of an image display  
    Public PropertyDescriptions for the series  
    Public Property Unique identifier for the four levels of the DICOM Query/Retrieve hierarchy  
    Public PropertySex of the patient  
    Public PropertyControls whether the image�s labels (annotations) are shown on screen  
    Public Property Controls whether image shutters (if specified in the image) are used.  
    Public Property Controls whether the images is updated when image display parameters change  
    Public PropertyThe dimensions of the image  
    Public PropertySOP class of the DicomDataSet.  
    Public PropertyControls the automatic zooming of an image.  
    Public PropertyDescription for the study  
    Public Property Unique identifier for the four levels of the DICOM Query/Retrieve hierarchy  
    Public PropertyA general purpose Tag for developer use  
    Public Property UnsharpLength and UnsharpEnhancement, allow use of unsharp masking, as simple method of image edge enhancement  
    Public Property UnsharpLength and UnsharpEnhancement, allow use of unsharp masking, as simple method of image edge enhancement  
    Public Property Means to override the matrix used to display 2D images  
    Public PropertyThe VOI Lookup Table to be used to display the DicomImage  
    Public Property Controls which VOILUT function to be used, default value is Linear  
    Public Property Indicates whether a Values of Interest Lookup Table is in use  
    Public PropertyThe Window "Width" - which controls the greyscale mapping of a displayed image  
    Public Property Provides a means to modify the usage of a Values of Interest Lookup Table (VOI LUT) or other display mapping  
    Public PropertyControls the magnification of an image display  
    Top
    Public Methods
     NameDescription
    Public MethodOverloaded. Creates and adds standard data elements to the underlying DicomDataSet  
    Public MethodOverloaded.  Add byte[] as attribute value to avoid copying large data  
    Public MethodOverloaded. Creates a Bitmap object from DicomImage  
    Public Method Image rendered as a System.Windows.Media.Imaging.BitmapImage object  
    Public Method Combine pixel data of source image into this image as a base image  
    Public MethodBurn all image Labels in Pixel data.

    This method modifies the underlying pixel data!

     
    Public Method Useful method to check if the image can be converted using a different compression specified by the TransferSyntax  
    Public Method The location of the top-left corner of the cell within which this image would be displayed in a particular viewer  
    Public Method The size of the cell within which this image would be displayed in a particular viewer  
    Public Method Simulate the effect of writing out as a Decompressed Image  
    Public MethodOverloaded. Clears the internal cache for compressed and uncompressed pixel data, lookup data and DirectX textures  
    Public MethodOverloaded. Returns a cloned copy of the DicomImage  
    Public Method Copies the image to the Windows clipboard  
    Public MethodThis method modifies the StretchMode, Zoom and Scroll properties such that the display output stays very similar while the display parameters have changed to suit the DicomObjects.Enums.StretchModes.NoStretch mode.  
    Public MethodOverloaded.  Encapsulate current display properties into a DICOM GreyScale Presentation State object  
    Public MethodCauses all the frames of an image to be decompressed.  
    Public MethodOverloaded. Methods to determine the size at which am image would be shown  
    Public MethodReleases the resources used by the DicomImage object This does not dispose the underlying DicomDataSet object which is DataSet, an explicit Dispose call will be needed to have that effect  
    Public Method Perpendicular distance from a Point to the plane of this image  
    Public MethodOverloaded. Methods to determine the degree to which part of an image has already been downloaded  
    Public MethodOverloaded. Explicitly request that some of the pixel information for this image should be retrieved via JPIP  
    Public MethodOverloaded. Export image to non-DICOM format  
    Public MethodGet cache size used by DicomObjects for the image - useful to help decide when to call ClearCaches method  
    Public MethodOverloaded. Find the maximum and minimum pixel data values in the pixel data  
    Public Method Extract individual frame from the pixel data  
    Public Method Returns an array containing the distribution of raw pixel values.  
    Public Method The currently displayed plane of this image.  
    Public Method Calculate where in screen (X,Y) space, a given image point lies  
    Public Method Calculate the real-world 3D coordinates of a point of the image currently displayed  
    Public MethodOverloaded. Copies the image data from an external image format  
    Public MethodOverloaded. Matrix specifying how the image is displayed  
    Public Method Matrix specifying how the image would be displayed with a Zoom of 1:1  
    Public Method Return the Text of DicomLabel of LabelType = special.  
    Public MethodCopies the Image Data from Windows Clipboard  
    Public Method Returns an array of pixel values for a frame, optionally transformed via the modality transformation  
    Public MethodOverloaded. Modifies current display properties to match the DICOM presentation state.  
    Public MethodOverloaded.  Creates a copy of the image for printing or other purposes  
    Public Method Returns an array of raw pixel values for a frame  
    Public MethodOverloaded. Read from a file, a system IO stream or a byte array  
    Public Method Reads from Web Address  
    Public MethodThis method returns a new DicomLabel object which represents the position of one DicomImage relative to another.  
    Public MethodOverloaded. Render the DicomImage to array.  
    Public Method Calculate where in image (X,Y) space, a given screen point lies  
    Public Method Calculate where in real world (X,Y,Z) space, a given screen point lies  
    Public MethodOverloaded. Sends an image to a remote Storage SCP  
    Public Method Recalculates the default windows used by DicomObjects as if the image had just been loaded  
    Public Method An external DirectX pixel shader to be used for custom filtering  
    Public Method Method to set pixel data directly from a stream  
    Public Method Method to import pixel data directly from a non-DICOM data  
    Public Method Maps an external file as the pixel data  
    Public MethodSets the Scroll and Zoom values to values reflecting the current display  
    Public MethodOverloaded.  Sets the frame number of the mask frame for subtraction.  
    Public MethodOverloaded. Get the pixel spacing of the DicomImage  
    Public MethodThis method returns the Pixel Spacing within the region specified by Area, in a particular viewer  
    Public MethodOverloaded. Creates a copy of part or all of the image  
    Public MethodCauses the image to be updated  
    Public Method Calculate the nearest image coordinates for a point in real world (X,Y,Z) space,  
    Public Method Calculate where in real world (X,Y,Z) space, a given screen point lies  
    Public MethodOverloaded. Write the data to a file, Stream or Byte Array  
    Top
    Public Events
     NameDescription
    Public Event An event which fires when the plane displayed by this image changes.  
    Public Event Setting this event enables a developer to specify his own smoothing algorithm.  
    Top
    Public Operators
    Implicit DicomImage to DicomDataSet cast
    Top
    See Also