Table of Contents

Class ImageBox

Namespace
FellowOakDicom.Printing
Assembly
fo-dicom.core.dll

Color or gray scale basic image box

public class ImageBox : DicomDataset, IEnumerable<DicomItem>, IEnumerable, IEquatable<DicomDataset>
Inheritance
ImageBox
Implements
Inherited Members
Extension Methods

Constructors

ImageBox(FilmBox, DicomUID, DicomUID)

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

public ImageBox(FilmBox filmBox, DicomUID sopClass, DicomUID sopInstance)

Parameters

filmBox FilmBox

Film box in which image box should be constained.

sopClass DicomUID

SOP Class UID for the image.

sopInstance DicomUID

SOP instance UID for the image.

Fields

BORDER 

protected const float BORDER = 7.874016

Field Value

float

ColorSOPClassUID

Basic color image box SOP

public static readonly DicomUID ColorSOPClassUID

Field Value

DicomUID

GraySOPClassUID

Basic gray scale image box SOP

public static readonly DicomUID GraySOPClassUID

Field Value

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.

public string ConfigurationInformation { get; set; }

Property Value

string

Remarks

Defined Terms:

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

FilmBox 

public FilmBox FilmBox { get; }

Property Value

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.

public ushort ImageBoxPosition { get; set; }

Property Value

ushort

ImageSequence

Gets or sets the color or grayscale basic image sequence

public DicomDataset ImageSequence { get; set; }

Property Value

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

public string MagnificationType { get; set; }

Property Value

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.

public ushort MaxDensity { get; set; }

Property Value

ushort

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.

public ushort MinDensity { get; set; }

Property Value

ushort

Polarity

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

public string Polarity { get; set; }

Property Value

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.

    public string RequestedDecimateCropBehavior { get; set; }

    Property Value

    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.

    public double RequestedImageSize { get; set; }

    Property Value

    double

    SOPClassUID

    Image box SOP class UID

    public DicomUID SOPClassUID { get; }

    Property Value

    DicomUID

    SOPInstanceUID

    Image box SOP instance UID

    public DicomUID SOPInstanceUID { get; }

    Property Value

    DicomUID

    SmoothingType

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

    public string SmoothingType { get; set; }

    Property Value

    string

    Methods

    Clone(FilmBox)

    Clone the current IamgeBox and return new object

    public ImageBox Clone(FilmBox filmBox)

    Parameters

    filmBox FilmBox

    Returns

    ImageBox

    Cloned ImageBox

    Load(FilmBox, string)

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

    public static ImageBox Load(FilmBox filmBox, string imageBoxFile)

    Parameters

    filmBox FilmBox

    Film box.

    imageBoxFile string

    Name of the image box file.

    Returns

    ImageBox

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

    Save(string)

    Save the image box contents to file.

    public void Save(string imageBoxFile)

    Parameters

    imageBoxFile string

    Name of the image box file.