| Name | Description | |
|---|---|---|
 | DicomImage3D Constructor | constructor |
DicomImage3D Class Members
In This Topic
The following tables list the members exposed by DicomImage3D.
Public Constructors
Public Fields
| Name | Description | |
|---|---|---|
 | CutPolygon | The list of cut planes for a polgon applied to the view of the object |
Public Properties
| Name | Description | |
|---|---|---|
 | AccessionNumber | The Accession Number (Inherited from DicomObjects.DicomImage) |
| AmbientIntesity | Gets or sets the ambient intensity for lighting in VR mode. |
| Angle | Controls the rotation of an image (Inherited from DicomObjects.DicomImage) |
| Area | The display area of DicomImage (Inherited from DicomObjects.DicomImage) |
| BorderPaint | The Paint object for Image border (Inherited from DicomObjects.DicomImage) |
| CacheMode | Controls how the pixel data is cached (Inherited from DicomObjects.DicomImage) |
| CaptureBackColour | User defined background colour for image output of PrinterImage, SKBitmap and SubImage methods |
| 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) |
| CustomSmoothingFunction | User defined DX smoothing function (Inherited from DicomObjects.DicomImage) |
| CutPlanes | List of cut planes applied to the 3D volume. |
| 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 | Gets or sets the diffuse reflection coefficient for lighting in VR mode. |
| DisplayMode | Controls how the image is rendered internal before transfer to the screen (Inherited from DicomObjects.DicomImage) |
| DownSample | Gets or sets the downsampling factor for rendering. |
| DrawCacheMode | Specify the DrawCacheMode to control how image is drawn/cached (Inherited from DicomObjects.DicomImage) |
| EarlyRayTermination | Gets or sets the opacity threshold for early ray termination in VR mode. |
| 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) |
| GammaTransfer | Controls the gamma applied to transfer function lookups during volume rendering. |
| 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) |
| IsViewDirty | to check if image has been upl |
| Item | Overloaded. Provides access to all attributes of the image (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 of 3D labels associated with the image. |
| 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 | Gets or sets the direction of the light source relative to the eye in VR mode. |
| LightIntensity | Gets or sets the directional light intensity for VR mode. |
| 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 | Gets or sets the 3D transformation matrix. |
| MinificationMode | Controls how pixels are interpolated when the image is minified (Inherited from DicomObjects.DicomImage) |
| Modality | The Modality of the image (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) |
| ParallelView | Gets or sets a value indicating whether parallel projection is used. |
| PatientID | The Patient ID (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) |
| 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. Gets the rendered size of the 3D image. |
| RenderMode | Gets or sets the rendering mode for the 3D 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) |
| Roughness | Controls the white point used during tone mapping. |
| SampleSize | Performance option to control sampling quality of volume renderer. Similar to Downsample. Controls the distance between samples the volume render creates. A higher value will mean greater distance between samples. A greater distance will mean less samples are taken and therefore higher performance at the expense of quality. |
| 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 | Gets or sets the slab thickness for slab rendering modes. |
| SOPClass | SOP class of the DicomDataSet. (Inherited from DicomObjects.DicomImage) |
| SpecularExponent | Gets or sets the specular exponent for lighting in VR mode. |
| SpecularIntensity | Gets or sets the specular intensity for lighting in VR mode. |
| Step | Gets or sets the step size for ray casting in MIP and VR modes. |
| 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) |
| ValidationOptions | The default DicomObjects.Validation.ValidationOptions to apply to newly created DicomImage objects (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 | Gets the underlying DICOM volume. |
| WhitePoint | Controls the white point used during tone mapping. |
| 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 SKBitmap Image from DicomImage (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 | Overloaded. Applies clipping planes based on a label. |
| Clone | Overloaded. Returns a cloned copy of the DicomImage (Inherited from DicomObjects.DicomImage) |
| CurrentPixelScale | Gets the current pixel scale in world units. |
| CurrentToPresentationState | 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 DicomImage.StretchMode etc. will display in this viewer. (Inherited from DicomObjects.DicomImage) |
| Dispose() | Standard Dispose methods (Inherited from DicomObjects.DicomImage) |
| DistanceFromPoint | Perpendicular distance from a Point to the plane of this image (Inherited from DicomObjects.DicomImage) |
| DistanceToFarVertex | Calculates the distance to the farthest vertex from the current view plane. |
| DownloadStatus | Overloaded. The download status of an image compared to specific attributes of the image (Inherited from DicomObjects.DicomImage) |
| Exclude | Overloaded. Applies clipping planes based on a label. |
| Export | Overloaded. Export DicomImage to supported Format (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) |
| GetUniformScale | Extracts the uniform scale from the transformation matrix |
| Histogram | Returns an array containing the distribution of raw pixel values. (Inherited from DicomObjects.DicomImage) |
| ImagePlane | Overridden. Gets the current image plane for the 3D view. |
| ImageToScreen | Overridden. Converts image coordinates to screen coordinates. |
| 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 image (Inherited from DicomObjects.DicomImage) |
| MarkViewAsClean | MarkViewAsClean helper method |
| Matrix | Overloaded. Matrix specifying how the image is displayed onto the specified DicomViewer (Inherited from DicomObjects.DicomImage) |
| MatrixBase | Matrix specifying how the image would be displayed with a Zoom of 1:1 (Inherited from DicomObjects.DicomImage) |
| PixelToWorld | Converts a pixel coordinate to world coordinate. |
| PixelValuesByFrame | Returns a float array of pixel values for a frame, optionally transformed via the modality transformation (Inherited from DicomObjects.DicomImage) |
| PixelValuesByFrameGeneric | Returns an array of pixel values for a frame, optionally transformed via the modality transformation (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 | Rotates the view by a specified angle around an axis. |
| RotateWorld | Rotates the world view. |
| Scale | Scales the view by a specified factor. |
| ScreenNormal | Gets the current screen normal in world coordinates. |
| ScreenToImage | Overridden. Converts screen coordinates to image coordinates. |
| ScreenToWorld(SKPoint,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) |
| 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) |
| SetSimpleMasking | Overloaded. Sets an int array as frame numbers of the mask frames for subtraction (Inherited from DicomObjects.DicomImage) |
| SetTransferFunction | Overloaded. Sets the transfer function for volume rendering. |
| SetViewPlane | Overloaded. Sets the view to a standard anatomical plane. |
| 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 sub-image from the 3D volume. |
| TranslateMm | Translates the view by a specified offset in millimeters. |
| TranslateNormal | Translates the view along the normal direction. |
| TranslatePixels | Translates the view by a specified pixel offset. |
| Update | Causes the image to be updated (Inherited from DicomObjects.DicomImage) |
| Write | Overloaded. Write the data to a file with specified transfer syntax and quality (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) |
See Also