Class ImageBox

Color or gray scale basic image box

Inheritance
Object
DicomDataset
ImageBox
Inherited Members
Namespace: Dicom.Printing
Assembly: cs.temp.dll.dll
Syntax
public class ImageBox : DicomDataset, IEnumerable<DicomItem>, IEnumerable

Constructors

ImageBox(FilmBox, DicomUID, DicomUID)

Construct new ImageBox for specified filmBox using specified SOP class UID and SOP instance UID

Declaration
public ImageBox(FilmBox filmBox, DicomUID sopClass, DicomUID sopInstance)
Parameters
Type Name Description
FilmBox filmBox

Film box in which image box should be constained.
DicomUID sopClass

SOP Class UID for the image.
DicomUID sopInstance

SOP instance UID for the image.

Fields

BORDER

Declaration
protected const float BORDER = 7.874016F
Field Value
Type Description
Single

ColorSOPClassUID

Basic color image box SOP

Declaration
public static readonly DicomUID ColorSOPClassUID
Field Value
Type Description
DicomUID

GraySOPClassUID

Basic gray scale image box SOP

Declaration
public static readonly DicomUID GraySOPClassUID
Field Value
Type Description
DicomUID

Properties

ConfigurationInformation

Character string that contains either the ID of the printer configuration table that contains a set of values for implementation specific print parameters (e.g. perception LUT related parameters) or one or more configuration data values, encoded as characters. If there are multiple configuration data values encoded in the string, they shall be separated by backslashes. The definition of values shall be contained in the SCP's Conformance Statement.

Declaration
public string ConfigurationInformation { get; set; }
Property Value
Type Description
String
Remarks

Defined Terms:

Note: It is recommended that for SCPs, CS000 represent the lowest contrast and CS999 the highest contrast levels available.

FilmBox

Declaration
public FilmBox FilmBox { get; }
Property Value
Type Description
FilmBox

ImageBoxPosition

Gets or sets the position of the image on the film, based on image display format. See C.13.5.1 for specification.

Declaration
public ushort ImageBoxPosition { get; set; }
Property Value
Type Description
UInt16

ImageSequence

Gets or sets the color or grayscale basic image sequence

Declaration
public DicomDataset ImageSequence { get; set; }
Property Value
Type Description
DicomDataset

MagnificationType

Interpolation type by which the printer magnifies or decimates the image in order to fit the image in the image box on film

Declaration
public string MagnificationType { get; set; }
Property Value
Type Description
String
Remarks

Defined Terms:

  • REPLICATE
  • BILINEAR
  • CUBIC
  • NONE

MaxDensity

Maximum density of the images on the film, expressed in hundredths of OD. If Max Density is higher than maximum printer density than Max Density is set to maximum printer density.

Declaration
public ushort MaxDensity { get; set; }
Property Value
Type Description
UInt16

MinDensity

Minimum density of the images on the film, expressed in hundredths of OD. If Min Density is lower than minimum printer density than Min Density is set to minimum printer density.

Declaration
public ushort MinDensity { get; set; }
Property Value
Type Description
UInt16

Polarity

Specifies whether minimum pixel values (after VOI LUT transformation) are to printed black or white.

Declaration
public string Polarity { get; set; }
Property Value
Type Description
String
Remarks

Enumerated Values:

    NORMAL pixels shall be printed as specified by the Photometric Interpretation (0028,0004) REVERSE pixels shall be printed with the opposite polarity as specified by the Photometric Interpretation (0028,0004)

    If Polarity (2020,0020) is not specified by the SCU, the SCP shall print with NORMAL polarity.

    RequestedDecimateCropBehavior

    Specifies whether image pixels are to be decimated or cropped if the image rows or columns is greater than the available printable pixels in an Image Box.

    Declaration
    public string RequestedDecimateCropBehavior { get; set; }
    Property Value
    Type Description
    String
    Remarks

    Decimation means that a magnification factor <1 is applied to the image. The method of decimation shall be that specified by Magnification Type (2010,0060) or the SCP default if not specified.

    Cropping means that some image rows and/or columns are deleted before printing.

    Enumerated Values:

    • DECIMATEa magnification factor <1 to be applied to the image.
    • CROPsome image rows and/or columns are to be deleted before printing. The specific algorithm for cropping shall be described in the SCP Conformance Statement.
    • FAILthe SCP shall not crop or decimate

    RequestedImageSize

    Width (x-dimension) in mm of the image to be printed. This value overrides the size that corresponds with optimal filling of the Image Box.

    Declaration
    public double RequestedImageSize { get; set; }
    Property Value
    Type Description
    Double

    SmoothingType

    Further specifies the type of the interpolation function. Values are defined in Conformance Statement. Only valid for Magnification Type (2010,0060) = CUBIC

    Declaration
    public string SmoothingType { get; set; }
    Property Value
    Type Description
    String

    SOPClassUID

    Image box SOP class UID

    Declaration
    public DicomUID SOPClassUID { get; }
    Property Value
    Type Description
    DicomUID

    SOPInstanceUID

    Image box SOP instance UID

    Declaration
    public DicomUID SOPInstanceUID { get; }
    Property Value
    Type Description
    DicomUID

    Methods

    Clone(FilmBox)

    Clone the current IamgeBox and return new object

    Declaration
    public ImageBox Clone(FilmBox filmBox)
    Parameters
    Type Name Description
    FilmBox filmBox
    Returns
    Type Description
    ImageBox

    Cloned ImageBox

    Load(FilmBox, String)

    Load image box for a specified filmBox from a specified file.

    Declaration
    public static ImageBox Load(FilmBox filmBox, string imageBoxFile)
    Parameters
    Type Name Description
    FilmBox filmBox

    Film box.
    String imageBoxFile

    Name of the image box file.
    Returns
    Type Description
    ImageBox

    Image box for a specified filmBox from a file named imageBoxFile.

    Save(String)

    Save the image box contents to file.

    Declaration
    public void Save(string imageBoxFile)
    Parameters
    Type Name Description
    String imageBoxFile

    Name of the image box file.

    Implements