| Name | Description | |
|---|---|---|
 | DicomImage3D Constructor | Create a 3D image from a DicomVolume and with a defined rendering mode |
DicomImage3D Class Members
In This Topic
The following tables list the members exposed by DicomImage3D.
Public Constructors
Public Properties
| Name | Description | |
|---|---|---|
 | AccessionNumber | The Accession Number (Inherited from DicomObjects.DicomImage) |
| Angle | Controls the rotation of an image (Inherited from DicomObjects.DicomImage) |
| Area | The display area of DicomImage (Inherited from DicomObjects.DicomImage) |
| BorderPen | The Pen object for Image border (Inherited from DicomObjects.DicomImage) |
| CacheMode | Controls how the pixel data is cached (Inherited from DicomObjects.DicomImage) |
| CalculatedFrameCount | The number of frames recalculated for this image. This would trigger recalculation for frame count especially for video data (Inherited from DicomObjects.DicomImage) |
| CaptureBackColour | User defined background colour for image output of PrinterImage, Bitmap and SubImage methods |
| CDAStyleSheet | Style sheet used for displaying encapsulated CDA (Inherited from DicomObjects.DicomImage) |
| CineFramesToDisplay | The set of frames to display for cine modes (Inherited from DicomObjects.DicomImage) |
| CineIndex | The index of the currently displayed frame when using CineMode (Inherited from DicomObjects.DicomImage) |
| CineMode | Enumerated running modes for multi-frame image (Inherited from DicomObjects.DicomImage) |
| CineRate | Controls the speed of autonomous cine runs (Inherited from DicomObjects.DicomImage) |
| CineSmoothing | Boolean property indicating whether Smoothing is applied when Cine is being displayed. (Inherited from DicomObjects.DicomImage) |
| ColourTable | The colour lookup table of DicomImage (Inherited from DicomObjects.DicomImage) |
| CubicSplineAlpha | 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. (Inherited from DicomObjects.DicomImage) |
| CutPlanes | The list of cutplanes applied to the view of the object |
| DataSet | The underlying DICOM Dataset containing persistent data for the image (Inherited from DicomObjects.DicomImage) |
| DateOfBirth | Date of birth of the patient (Inherited from DicomObjects.DicomImage) |
| DiffuseReflection | Switches on and off diffuse reflection (shading) |
| DisplayMode | Controls how the image is rendered internal before transfer to the screen (Inherited from DicomObjects.DicomImage) |
| DownSample | A means to reduce the time time to render images, at the expense of reduced quality |
| DrawCacheMode | Specify the DrawCacheMode to control how image is drawn/cached (Inherited from DicomObjects.DicomImage) |
| EarlyRayTermination | The opacity at which to stop Ray Tracing (VR only) |
| ExplicitModalityLUT | An explicit modality Lookup Table to be used in place of one specified in the image or presentaiton state. (Inherited from DicomObjects.DicomImage) |
| ExplicitPresentationLUT | An explicit presentation Lookup Table to be used in place of one specified in the image or presentaiton state. (Inherited from DicomObjects.DicomImage) |
| ExplicitVOILUT | An explicit Values of Interest (VOI) Lookup Table to be used in place of one specified in the image or presentaiton state. (Inherited from DicomObjects.DicomImage) |
| FilterLength | Contains the length of the smoothing filter (Inherited from DicomObjects.DicomImage) |
| FlipState | The flip state of the image, allowing the orientation of the image, as displayed, to be altered (Inherited from DicomObjects.DicomImage) |
| Frame | Controls which frame of a multi-frame image is displayed (Inherited from DicomObjects.DicomImage) |
| FrameCount | The number of frames contained in a multi-frame image (Inherited from DicomObjects.DicomImage) |
| Gamma | A number that specifies a power (Inherited from DicomObjects.DicomImage) |
| InstanceUID | Unique identifier for the four levels of the DICOM Query/Retrieve hierarchy (Inherited from DicomObjects.DicomImage) |
| Invert | Controls whether the Image will be inverted. (Inherited from DicomObjects.DicomImage) |
| Item | Overloaded. Provides access to all attributes of the image (Inherited from DicomObjects.DicomImage) |
| JpipRequestSize | The size of the requests other than the first (in bytes) to make to a JPIP server. (Inherited from DicomObjects.DicomImage) |
| Labels | Provides access to the DicomLabelCollection, items of which are to be displayed over an image. (Inherited from DicomObjects.DicomImage) |
| Labels3D | Collection to hold DicomLabel3D objects for display over 3D images. |
| Level | The Window Level (also known as the centre) - which controls the greyscale mapping of a displayed image (Inherited from DicomObjects.DicomImage) |
| LevelShift | Provides a means to modify the usage of a Values of Interest Lookup Table (VOI LUT) or other display mapping (Inherited from DicomObjects.DicomImage) |
| LightDirection | The direction of the ambient light, relative to the eye position |
| LightIntensity | The intensity of the directional (as opposed to ambient) lighting. |
| MagnificationMode | Controls how pixels are interpolated when the image is magnified (Inherited from DicomObjects.DicomImage) |
| MaskRanges | Contains an array of DicomMaskRange objects to be applied to this image. See the DicomMaskRange object for more information on how this is used. (Inherited from DicomObjects.DicomImage) |
| Matrix3D | The Matrix relating real world coordinates (in mm) to the display space (with units -1 to +1 in each dimension) |
| MinificationMode | Controls how pixels are interpolated when the image is minified (Inherited from DicomObjects.DicomImage) |
| ModalityLUT | Enables or disables the Modality Lookup Table to be used in the DicomImage (Inherited from DicomObjects.DicomImage) |
| Name | The Name of the patient (Inherited from DicomObjects.DicomImage) |
| OriginalTs | Original Transfer syntax of the underlying DataSet (Inherited from DicomObjects.DicomImage) |
| OverlayColour | Controls how overlays embedded in the image are displayed (Inherited from DicomObjects.DicomImage) |
| OverlayVisible | Controls whether overlays embedded in the image are displayed (Inherited from DicomObjects.DicomImage) |
| PatientID | The Patient ID (Inherited from DicomObjects.DicomImage) |
| PhotometricInterpretation | The PhotometricInterpretation of the image (Inherited from DicomObjects.DicomImage) |
| Pixels | Accesses the raw pixel data as a typed array (Inherited from DicomObjects.DicomImage) |
| PresentationLUT | Enables or disables the Presentation Lookup Table to be used in the DicomImage (Inherited from DicomObjects.DicomImage) |
| PresentationState | Support for DICOM greyscale presentation state (Inherited from DicomObjects.DicomImage) |
| PresentationStateFeaturesUsed | The presentation state features to use (Inherited from DicomObjects.DicomImage) |
| PresentationStates | Support for a list of DICOM greyscale presentation state (Inherited from DicomObjects.DicomImage) |
| RawPixels | Accesses the raw pixel data as an array (Inherited from DicomObjects.DicomImage) |
| RealTimeCine | Controls how cine images are displayed (Inherited from DicomObjects.DicomImage) |
| RenderedSize | Overridden. Returns the Image display size in output (normally screen) coordinates |
| RenderMode | The mode used to display an image |
| RotateState | The rotation state of the image, allowing the orientation of the image, as displayed, to be altered (Inherited from DicomObjects.DicomImage) |
| RotationBehaviour | Controls the baseline positioning of an image which is not stretched to fit and is rotated (Inherited from DicomObjects.DicomImage) |
| Scroll | Controls the positioning of an image display (Inherited from DicomObjects.DicomImage) |
| SeriesDescription | Descriptions for the series (Inherited from DicomObjects.DicomImage) |
| SeriesUID | Unique identifier for the four levels of the DICOM Query/Retrieve hierarchy (Inherited from DicomObjects.DicomImage) |
| Sex | Sex of the patient (Inherited from DicomObjects.DicomImage) |
| ShowLabels | Controls whether the image�s labels (annotations) are shown on screen (Inherited from DicomObjects.DicomImage) |
| ShowShutter | Controls whether image shutters (if specified in the image) are used. (Inherited from DicomObjects.DicomImage) |
| ShowUpdates | Controls whether the images is updated when image display parameters change (Inherited from DicomObjects.DicomImage) |
| Size | The dimensions of the image (Inherited from DicomObjects.DicomImage) |
| SlabThickness | Thickness for rendering Minimum, Maximum and Average (slab) |
| SOPClass | SOP class of the DicomDataSet. (Inherited from DicomObjects.DicomImage) |
| SpecularExponent | Controls broadness of specular reflection component (VR only) |
| SpecularIntensity | Controls the intensity of specular reflection (VR only) |
| Step | Step to use when RayCasting (MIP & VR only) |
| StretchMode | Controls the automatic zooming of an image. (Inherited from DicomObjects.DicomImage) |
| StudyDescription | Description for the study (Inherited from DicomObjects.DicomImage) |
| StudyUID | Unique identifier for the four levels of the DICOM Query/Retrieve hierarchy (Inherited from DicomObjects.DicomImage) |
| Tag | A general purpose Tag for developer use (Inherited from DicomObjects.DicomImage) |
| UnsharpEnhancement | UnsharpLength and UnsharpEnhancement, allow use of unsharp masking, as simple method of image edge enhancement (Inherited from DicomObjects.DicomImage) |
| UnsharpLength | UnsharpLength and UnsharpEnhancement, allow use of unsharp masking, as simple method of image edge enhancement (Inherited from DicomObjects.DicomImage) |
| UserMatrix | Means to override the matrix used to display 2D images (Inherited from DicomObjects.DicomImage) |
| VoiLUT | The VOI Lookup Table to be used to display the DicomImage (Inherited from DicomObjects.DicomImage) |
| VOILUTFunction | Controls which VOILUT function to be used, default value is Linear (Inherited from DicomObjects.DicomImage) |
| VoiLUTInUse | Indicates whether a Values of Interest Lookup Table is in use (Inherited from DicomObjects.DicomImage) |
| Volume | The DicomVolume on which this DicomImage3D is based. |
| Width | The Window "Width" - which controls the greyscale mapping of a displayed image (Inherited from DicomObjects.DicomImage) |
| WidthMultiplier | Provides a means to modify the usage of a Values of Interest Lookup Table (VOI LUT) or other display mapping (Inherited from DicomObjects.DicomImage) |
| Zoom | Controls the magnification of an image display (Inherited from DicomObjects.DicomImage) |
Public Methods
| Name | Description | |
|---|---|---|
 | Add | Overloaded. Creates and adds standard data elements to the underlying DicomDataSet (Inherited from DicomObjects.DicomImage) |
| AddByReference | Overloaded. Add byte[] as attribute value to avoid copying large data (Inherited from DicomObjects.DicomImage) |
| Bitmap | Overloaded. Creates a Bitmap Image from DicomImage (Inherited from DicomObjects.DicomImage) |
| BitmapImage | Image rendered as a System.Windows.Media.Imaging.BitmapImage object (Inherited from DicomObjects.DicomImage) |
| Blt | Combine pixel data of source image into this image as a base image (Inherited from DicomObjects.DicomImage) |
| BurnAnnotations | Burn all image Labels in Pixel data.
This method modifies the underlying pixel data! (Inherited from DicomObjects.DicomImage) |
| CanConvertTo | Useful method to check if the image can be converted using a different compression specified by the TransferSyntax (Inherited from DicomObjects.DicomImage) |
| CellLocation | The location of the top-left corner of the cell within which this image would be displayed in a particular viewer (Inherited from DicomObjects.DicomImage) |
| CellSize | The size of the cell within which this image would be displayed in a particular viewer (Inherited from DicomObjects.DicomImage) |
| ChangeToDecompressed | Simulate the effect of writing out as a Decompressed Image (Inherited from DicomObjects.DicomImage) |
| ClearCaches | Overloaded. Clears the entire internal cache (Inherited from DicomObjects.DicomImage) |
| Clip | Apply clip planes to the display volume |
| Clone | Overloaded. Returns a cloned copy of the DicomImage (Inherited from DicomObjects.DicomImage) |
| Copy | Copies the image to the Windows clipboard (Inherited from DicomObjects.DicomImage) |
| CurrentPixelScale | Current Pixel Size |
| CurrentToNoStretch | This 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. (Inherited from DicomObjects.DicomImage) |
| CurrentToPresentationState | Overloaded. Encapsulate current display properties into a DICOM GreyScale Presentation State object (Inherited from DicomObjects.DicomImage) |
| DecompressAll | Causes all the frames of an image to be decompressed. (Inherited from DicomObjects.DicomImage) |
| DisplaySize | Overloaded. The size at which this image, using current values for StretchMode etc. will display in this viewer. (Inherited from DicomObjects.DicomImage) |
| Dispose | Overloaded. Standard Dispose patten (Inherited from DicomObjects.DicomImage) |
| DistanceFromPoint | Perpendicular distance from a Point to the plane of this image (Inherited from DicomObjects.DicomImage) |
| DistanceToFarVertex | Find distance to the furthest vertex of the volume |
| DownloadStatus | Overloaded. The download status of an image compared to specific attributes of the image (Inherited from DicomObjects.DicomImage) |
| ExplicitJpipRequest | Overloaded. Explicitly request that some of the pixel information for this image should be retrieved via JPIP (Inherited from DicomObjects.DicomImage) |
| Export | Overloaded. Copy the image data for external access, controlled by Format and Quality (Inherited from DicomObjects.DicomImage) |
| GetCacheSize | Get cache size used by DicomObjects for the image - useful to help decide when to call ClearCaches method (Inherited from DicomObjects.DicomImage) |
| GetColourTable | The colour lookup table of DicomImage (Inherited from DicomObjects.DicomImage) |
| GetMinAndMax | Overloaded. Find the maximum and minimum pixel data values in the pixel data (Inherited from DicomObjects.DicomImage) |
| GetRawFrame | Extract individual frame from the pixel data (Inherited from DicomObjects.DicomImage) |
| Histogram | Returns an array containing the distribution of raw pixel values. (Inherited from DicomObjects.DicomImage) |
| ImagePlane | Overridden. The currently displayed plane of this image. |
| ImageToScreen | Overridden. Calculate where in screen (X,Y) space, a given image point lies |
| ImageToWorld | Calculate the real-world 3D coordinates of a point of the image currently displayed (Inherited from DicomObjects.DicomImage) |
| Import | Overloaded. Copies the image data from an external generic image object (Inherited from DicomObjects.DicomImage) |
| Matrix | Overloaded. Matrix specifying how the image is displayed, applying correction if needed if pizels are not square (Inherited from DicomObjects.DicomImage) |
| MatrixBase | Matrix specifying how the image would be displayed with a Zoom of 1:1 (Inherited from DicomObjects.DicomImage) |
| OrientationText | Return the Text of DicomLabel of LabelType = special. (Inherited from DicomObjects.DicomImage) |
| Paste | Copies the Image Data from Windows Clipboard (Inherited from DicomObjects.DicomImage) |
| PixelToWorld | Calculate the real world location of a point displayed on a 3D image |
| PixelValuesByFrame | Returns an array of pixel values for a frame, optionally transformed via the modality transformation (Inherited from DicomObjects.DicomImage) |
| PresentationStateToCurrent | Overloaded. Modifies current display properties to match the DICOM presentation state. (Inherited from DicomObjects.DicomImage) |
| PrinterImage | Overloaded. Creates a copy of the image for printing or other purposes (Inherited from DicomObjects.DicomImage) |
| RawPixelValuesByFrame | Returns an array of raw pixel values for a frame (Inherited from DicomObjects.DicomImage) |
| Read | Overloaded. Reads from an external DICOM file (Inherited from DicomObjects.DicomImage) |
| ReadURL | Reads from Web Address (Inherited from DicomObjects.DicomImage) |
| ReferenceLine | This method returns a new DicomLabel object which represents the position of one DicomImage relative to another. (Inherited from DicomObjects.DicomImage) |
| RenderToArray | Overloaded. Render the DicomImage to array. The data returned will be exactly the same as the "presentation data" if the Image gets displayed on screen. (Inherited from DicomObjects.DicomImage) |
| Rotate | Rotate view around a defined axis and based on a DicomViewer if available |
| RotateWorld | Rotate the view by an angle around a vector in world orientation |
| Scale | Scale/Zoom the view |
| ScreenNormal | Screen normal in World units |
| ScreenToImage | Overridden. Calculate where in image (X,Y) space, a given screen point lies |
| ScreenToWorld(PointF,DicomViewer) | Calculate where in real world (X,Y,Z) space, a given screen point lies (Inherited from DicomObjects.DicomImage) |
| Send | Overloaded. Sends an image to a remote Storage SCP (Inherited from DicomObjects.DicomImage) |
| SetColourTable | The colour lookup table of DicomImage (Inherited from DicomObjects.DicomImage) |
| SetDefaultWindows | Recalculates the default windows used by DicomObjects as if the image had just been loaded (Inherited from DicomObjects.DicomImage) |
| SetExternalShader | An external DirectX pixel shader to be used for custom filtering (Inherited from DicomObjects.DicomImage) |
| SetPixelData | Method to set pixel data directly from a stream (Inherited from DicomObjects.DicomImage) |
| SetPixelDataAndImport | Method to import pixel data directly from a non-DICOM data (Inherited from DicomObjects.DicomImage) |
| SetPixelFile | Maps an external file as the pixel data (Inherited from DicomObjects.DicomImage) |
| SetScrollAndZoom | Sets the Scroll and Zoom values to values reflecting the current display (Inherited from DicomObjects.DicomImage) |
| SetSimpleMasking | Overloaded. Sets an int array as frame numbers of the mask frames for subtraction (Inherited from DicomObjects.DicomImage) |
| SetTransferFunction | Overloaded. Set the transfer function (Colour Map) for use in Volume Rendering |
| SetViewPlane | Overloaded. Set the view plane for the image, to one of 3 pre-defined views, with optional reset of centre and zoom |
| Spacing | Overloaded. The pixel spacing of the DicomImage (Inherited from DicomObjects.DicomImage) |
| SpacingInViewer | This method returns the Pixel Spacing within the region specified by Area, in a particular viewer (Inherited from DicomObjects.DicomImage) |
| SubImage | Overloaded. Overridden. Creates a copy of part or all of the image with controlled size |
| TranslateMm | Move the centre point of the view by the specified offset |
| TranslateNormal | Move the centre point of the view by the specified distance, normal to the current view plane |
| TranslatePixels | Move the display Offset pixels based on output size |
| Update | Causes the image to be updated (Inherited from DicomObjects.DicomImage) |
| WorldToImage(Point3D,DicomViewer,Int32) | Calculate the nearest image coordinates for a point in real world (X,Y,Z) space, (Inherited from DicomObjects.DicomImage) |
| WorldToScreen(Point3D,DicomViewer) | Calculate where in real world (X,Y,Z) space, a given screen point lies (Inherited from DicomObjects.DicomImage) |
| Write | Overloaded. Write the data to a file with specified transfer syntax and quality (Inherited from DicomObjects.DicomImage) |
Protected Methods
| Name | Description | |
|---|---|---|
 | ChangeView | Indicates that view has changed. |
| CoreMatrix | Overridden. Matrix specifying how the image is displayed onto display of the stated |
| Finalize | Standard finaliser - releases any files which may be held open by the image and its underlying DicomDatSet (Inherited from DicomObjects.DicomImage) |
| OnPositionChanged | An event fires when the displayed plane changes (Inherited from DicomObjects.DicomImage) |
| ScreenLUT | The lookup table used for rendering this image to the specified bit depth output (Inherited from DicomObjects.DicomImage) |
Public Events
| Name | Description | |
|---|---|---|
 | PositionChanged | An event which fires when the plane displayed by this image changes. (Inherited from DicomObjects.DicomImage) |
| UserSmoothing | Setting this event enables a developer to specify his own smoothing algorithm. (Inherited from DicomObjects.DicomImage) |
See Also