Table of Contents

Class FilmSession

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

Basic film session

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

Constructors

FilmSession(DicomUID, DicomUID, DicomDataset, bool)

Construct new film session for specified SOP instance UID

public FilmSession(DicomUID sopClassUID, DicomUID sopInstance, DicomDataset dataset, bool isColor = false)

Parameters

sopClassUID DicomUID

Film session SOP Class UID

sopInstance DicomUID

Film session SOP instance UID

dataset DicomDataset

Film session dataset

isColor bool

Color images?

FilmSession(DicomUID, DicomUID, bool)

Construct new film session from scratch

public FilmSession(DicomUID sopClassUID, DicomUID sopInstance = null, bool isColor = false)

Parameters

sopClassUID DicomUID

Film session SOP Class UID

sopInstance DicomUID

Film session SOP instance UID

isColor bool

Color images?

Properties

BasicFilmBoxes

Basic Film Boxes list

public IList<FilmBox> BasicFilmBoxes { get; }

Property Value

IList<FilmBox>

FilmDestination

Film destination.

public string FilmDestination { get; set; }

Property Value

string

Remarks

Defined Terms:

  • MAGAZINEthe exposed film is stored in film magazine
  • PROCESSORthe exposed film is developed in film processor
  • BIN_i The exposed film is deposited in a sorter bin where “I” represents the bin number. Film sorter BINs shall be numbered sequentially starting from one and no maxium is placed on the number of BINs. The encoding of the BIN number shall not contain leading zeros.

FilmSessionLabel 

public string FilmSessionLabel { get; set; }

Property Value

string

IsColor 

public bool IsColor { get; set; }

Property Value

bool

MediumType

Type of medium on which the print job will be printed.

public string MediumType { get; set; }

Property Value

string

Remarks

Defined Terms:

  • PAPER
  • CLEAR FILM
  • BLUE FILM
  • MAMMO CLEAR FILM
  • MAMMO BLUE FILM

MemoryAllocation

Human readable label that identifies the film session.

public int MemoryAllocation { get; set; }

Property Value

int

NumberOfCopies

Number of copies to be printed for each film of the film session.

public int NumberOfCopies { get; set; }

Property Value

int

PresentationLuts 

public IList<PresentationLut> PresentationLuts { get; }

Property Value

IList<PresentationLut>

PrintPriority

Specifies the priority of the print job.

public string PrintPriority { get; set; }

Property Value

string

Remarks

Enumerated values:

  • HIGH
  • MED
  • LOW

SOPClassUID

Basic film session SOP class UID

public DicomUID SOPClassUID { get; }

Property Value

DicomUID

SOPInstanceUID

Basic film session SOP instance uID

public DicomUID SOPInstanceUID { get; }

Property Value

DicomUID

Methods

CloneFilmSession()

Create a cloned film session of this film session instance

public FilmSession CloneFilmSession()

Returns

FilmSession

Cloned film session instance

CreateFilmBox(DicomUID, DicomDataset)

Create new basic film box and add it to the film session

public FilmBox CreateFilmBox(DicomUID sopInstance, DicomDataset dataset)

Parameters

sopInstance DicomUID

The new film box SOP instance UID

dataset DicomDataset

The new film box dataset

Returns

FilmBox

The created film box instance

CreatePresentationLut(DicomUID, DicomDataset) 

public PresentationLut CreatePresentationLut(DicomUID sopInstance, DicomDataset dataset)

Parameters

sopInstance DicomUID
dataset DicomDataset

Returns

PresentationLut

DeleteFilmBox(DicomUID)

Delete film box with specified SOP instance UID

public bool DeleteFilmBox(DicomUID sopInstance)

Parameters

sopInstance DicomUID

Target film box SOP instance UID

Returns

bool

DeletePresentationLut(DicomUID) 

public void DeletePresentationLut(DicomUID sopInstance)

Parameters

sopInstance DicomUID

FindFilmBox(DicomUID)

Find film box instance with specified SOP instance UID

public FilmBox FindFilmBox(DicomUID sopInstance)

Parameters

sopInstance DicomUID

Target film box SOP instance UID

Returns

FilmBox

Target film box instance or null if no matching found

FindImageBox(DicomUID)

Find image box instance with specified SOP instance UID

public ImageBox FindImageBox(DicomUID sopInstnace)

Parameters

sopInstnace DicomUID

Target image box SOP instance UID

Returns

ImageBox

Target image box instance or null if no matching found

FindPresentationLut(DicomUID) 

public PresentationLut FindPresentationLut(DicomUID sopInstance)

Parameters

sopInstance DicomUID

Returns

PresentationLut

Load(string) 

public static FilmSession Load(string filmSessionFile)

Parameters

filmSessionFile string

Returns

FilmSession