com.pixelmed.doseocr

Class OCR

java.lang.Object

com.pixelmed.doseocr.OCR

public class OCR
extends java.lang.Object

A class for OCR of GE and Siemens modality dose report screen saves.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	defaultFileNameOfKnownGlyphs

Constructor Summary

Constructors

Constructor and Description
OCR(AttributeList list) Perform OCR on the supplied image AttributeList.
OCR(AttributeList list, java.lang.String fileNameOfKnownGlyphs, java.lang.String fileNameToRecordNewGlyphs) Perform OCR on the supplied image AttributeList.
OCR(java.awt.image.BufferedImage image, java.lang.String fileNameOfKnownGlyphs, java.lang.String fileNameToRecordNewGlyphs) Perform OCR on the supplied image.
OCR(java.util.List<java.lang.String> screenFilesPaths) Perform OCR on the supplied image files.
OCR(java.util.List<java.lang.String> screenFilesPaths, java.lang.String fileNameOfKnownGlyphs, java.lang.String fileNameToRecordNewGlyphs) Perform OCR on the supplied image files.
OCR(java.lang.String screenFilesPath)
OCR(java.lang.String screenFilesPath, java.lang.String fileNameOfKnownGlyphs, java.lang.String fileNameToRecordNewGlyphs) Perform OCR on the supplied image files.

Method Summary

Modifier and Type	Method and Description
protected void	doCommonConstructorStuff(AttributeList list, java.awt.image.BufferedImage image, java.lang.String fileNameOfKnownGlyphs, java.lang.String fileNameToRecordNewGlyphs) Perform OCR on the supplied image with AttributeList.
protected void	doCommonConstructorStuff(AttributeList list, java.lang.String fileNameOfKnownGlyphs, java.lang.String fileNameToRecordNewGlyphs) Perform OCR on the supplied image AttributeList.
AttributeList	getCommonAttributeList()
static CTDose	getCTDoseFromOCROfDoseScreen(OCR ocr, CTIrradiationEventDataFromImages eventDataFromImages, boolean buildSR) Create a CTDose instance from the OCR already performed on a dose screen image.
static CTDose	getCTDoseFromOCROfGEDoseScreen(OCR ocr, java.lang.String startDateTime, java.lang.String endDateTime, CTIrradiationEventDataFromImages eventDataFromImages, boolean buildSR) Create a CTDose instance from the OCR already performed on a GE dose screen image.
static CTDose	getCTDoseFromOCROfSiemensDoseScreen(OCR ocr, java.lang.String startDateTime, java.lang.String endDateTime, CTIrradiationEventDataFromImages eventDataFromImages, boolean buildSR) Create a CTDose instance from the OCR already performed on a Siemens dose screen image.
static CTDose	getCTDoseFromOCROfToshibaDoseScreen(OCR ocr, java.lang.String startDateTime, java.lang.String endDateTime, CTIrradiationEventDataFromImages eventDataFromImages, boolean buildSR) Create a CTDose instance from the OCR already performed on a Toshiba dose screen image.
static java.awt.image.BufferedImage	getEightBitImageSuitableForThresholding(AttributeList list) Get an 8 bit image suitable for thresholding.
static boolean	isDoseScreenInstance(AttributeList list)
static boolean	isGEDoseScreenInstance(AttributeList list)
protected static boolean	isGEDoseScreenSeriesNumber(java.lang.String seriesNumber)
static boolean	isPossiblyDoseScreenInstance(AttributeList list)
static boolean	isPossiblyDoseScreenInstance(java.lang.String manufacturer, java.lang.String sopClassUID, java.lang.String imageType)
static boolean	isPossiblyDoseScreenSeries(AttributeList list)
static boolean	isPossiblyDoseScreenSeries(java.lang.String manufacturer, java.lang.String modality, java.lang.String seriesNumber, java.lang.String seriesDescription)
static boolean	isPossiblyGEDoseScreenInstance(AttributeList list)
static boolean	isPossiblyGEDoseScreenInstance(java.lang.String manufacturer, java.lang.String sopClassUID, java.lang.String imageType)
static boolean	isPossiblyGEDoseScreenSeries(AttributeList list)
static boolean	isPossiblyGEDoseScreenSeries(java.lang.String manufacturer, java.lang.String modality, java.lang.String seriesNumber, java.lang.String seriesDescription)
static boolean	isPossiblySiemensDoseScreenInstance(AttributeList list)
static boolean	isPossiblySiemensDoseScreenInstance(java.lang.String manufacturer, java.lang.String sopClassUID, java.lang.String imageType)
static boolean	isPossiblySiemensDoseScreenSeries(AttributeList list)
static boolean	isPossiblySiemensDoseScreenSeries(java.lang.String manufacturer, java.lang.String modality, java.lang.String seriesNumber, java.lang.String seriesDescription)
static boolean	isPossiblyToshibaDoseScreenInstance(AttributeList list)
static boolean	isPossiblyToshibaDoseScreenInstance(java.lang.String manufacturer, java.lang.String sopClassUID, java.lang.String imageType)
static boolean	isPossiblyToshibaDoseScreenSeries(AttributeList list)
static boolean	isPossiblyToshibaDoseScreenSeries(java.lang.String manufacturer, java.lang.String modality, java.lang.String seriesNumber, java.lang.String seriesDescription)
static boolean	isSiemensDoseScreenInstance(AttributeList list)
static boolean	isToshibaDoseScreenInstance(AttributeList list)
static void	main(java.lang.String[] arg) Extract the CT dose information in a screen save image using optical character recognition, correlate it with any acquired CT slice images.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

defaultFileNameOfKnownGlyphs

public static java.lang.String defaultFileNameOfKnownGlyphs

Constructor Detail

OCR

public OCR(AttributeList list)
    throws java.io.IOException,
           javax.xml.parsers.ParserConfigurationException,
           org.xml.sax.SAXException,
           java.lang.Exception

Perform OCR on the supplied image AttributeList.

Parameters:

list - the AttributeList of the dose screen image file on which to perform OCR

Throws:

java.io.IOException

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.lang.Exception

OCR

public OCR(AttributeList list,
           java.lang.String fileNameOfKnownGlyphs,
           java.lang.String fileNameToRecordNewGlyphs)
    throws java.io.IOException,
           javax.xml.parsers.ParserConfigurationException,
           org.xml.sax.SAXException,
           java.lang.Exception

Perform OCR on the supplied image AttributeList.

Parameters:

list - the AttributeList of the dose screen image file on which to perform OCR

fileNameOfKnownGlyphs - file of known glyphs

fileNameToRecordNewGlyphs - where to record new glyphs

Throws:

java.io.IOException

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.lang.Exception

OCR

public OCR(java.awt.image.BufferedImage image,
           java.lang.String fileNameOfKnownGlyphs,
           java.lang.String fileNameToRecordNewGlyphs)
    throws java.io.IOException,
           javax.xml.parsers.ParserConfigurationException,
           org.xml.sax.SAXException,
           java.lang.Exception

Perform OCR on the supplied image.

Parameters:

image - the dose screen image on which to perform OCR

fileNameOfKnownGlyphs - file of known glyphs

fileNameToRecordNewGlyphs - where to record new glyphs

Throws:

java.io.IOException

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.lang.Exception

OCR

public OCR(java.util.List<java.lang.String> screenFilesPaths)
    throws java.io.IOException,
           javax.xml.parsers.ParserConfigurationException,
           org.xml.sax.SAXException,
           java.lang.Exception

Perform OCR on the supplied image files.

Parameters:

screenFilesPaths - the paths to the dose screen image files on which to perform OCR

Throws:

java.io.IOException

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.lang.Exception

OCR

public OCR(java.util.List<java.lang.String> screenFilesPaths,
           java.lang.String fileNameOfKnownGlyphs,
           java.lang.String fileNameToRecordNewGlyphs)
    throws java.io.IOException,
           javax.xml.parsers.ParserConfigurationException,
           org.xml.sax.SAXException,
           java.lang.Exception

Perform OCR on the supplied image files.

Parameters:

screenFilesPaths - the paths to the dose screen image files on which to perform OCR

fileNameOfKnownGlyphs - file of known glyphs

fileNameToRecordNewGlyphs - where to record new glyphs

Throws:

java.io.IOException

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.lang.Exception

OCR

public OCR(java.lang.String screenFilesPath)
    throws java.io.IOException,
           javax.xml.parsers.ParserConfigurationException,
           org.xml.sax.SAXException,
           java.lang.Exception

Throws:

java.io.IOException

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.lang.Exception

OCR

public OCR(java.lang.String screenFilesPath,
           java.lang.String fileNameOfKnownGlyphs,
           java.lang.String fileNameToRecordNewGlyphs)
    throws java.io.IOException,
           javax.xml.parsers.ParserConfigurationException,
           org.xml.sax.SAXException,
           java.lang.Exception

Perform OCR on the supplied image files.

Parameters:

screenFilesPath - the path to the dose screen image files on which to perform OCR

fileNameOfKnownGlyphs - file of known glyphs

fileNameToRecordNewGlyphs - where to record new glyphs

Throws:

java.io.IOException

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.lang.Exception

Method Detail

doCommonConstructorStuff

protected void doCommonConstructorStuff(AttributeList list,
                                        java.awt.image.BufferedImage image,
                                        java.lang.String fileNameOfKnownGlyphs,
                                        java.lang.String fileNameToRecordNewGlyphs)
                                 throws java.io.IOException,
                                        javax.xml.parsers.ParserConfigurationException,
                                        org.xml.sax.SAXException,
                                        java.lang.Exception

Perform OCR on the supplied image with AttributeList.

Parameters:

list - the AttributeList of the dose screen image file on which to perform OCR

image - the dose screen image on which to perform OCR

fileNameOfKnownGlyphs - file of known glyphs

fileNameToRecordNewGlyphs - where to record new glyphs

Throws:

java.io.IOException

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.lang.Exception

doCommonConstructorStuff

protected void doCommonConstructorStuff(AttributeList list,
                                        java.lang.String fileNameOfKnownGlyphs,
                                        java.lang.String fileNameToRecordNewGlyphs)
                                 throws java.io.IOException,
                                        javax.xml.parsers.ParserConfigurationException,
                                        org.xml.sax.SAXException,
                                        java.lang.Exception

Perform OCR on the supplied image AttributeList.

Parameters:

list - the AttributeList of the dose screen image file on which to perform OCR

fileNameOfKnownGlyphs - file of known glyphs

fileNameToRecordNewGlyphs - where to record new glyphs

Throws:

java.io.IOException

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.lang.Exception

getCommonAttributeList

public AttributeList getCommonAttributeList()

getCTDoseFromOCROfDoseScreen

public static CTDose getCTDoseFromOCROfDoseScreen(OCR ocr,
                                                  CTIrradiationEventDataFromImages eventDataFromImages,
                                                  boolean buildSR)
                                           throws java.io.IOException

Create a CTDose instance from the OCR already performed on a dose screen image.

Also extracts start and end date and time and default anatomical information.

Parameters:

ocr - the object from the OCR performed in the image

eventDataFromImages - the pre event data from the reconstructed images

buildSR - whether or not to extract composite context from the list for use later to build an RDSR

Throws:

java.io.IOException

getCTDoseFromOCROfGEDoseScreen

public static CTDose getCTDoseFromOCROfGEDoseScreen(OCR ocr,
                                                    java.lang.String startDateTime,
                                                    java.lang.String endDateTime,
                                                    CTIrradiationEventDataFromImages eventDataFromImages,
                                                    boolean buildSR)
                                             throws java.io.IOException

Create a CTDose instance from the OCR already performed on a GE dose screen image.

Parameters:

ocr - the object from the OCR performed in the image

startDateTime - the acquisition start date and time

endDateTime - the acquisition end date and time

eventDataFromImages - the pre event data from the reconstructed images

buildSR - whether or not to extract composite context from the list for use later to build an RDSR

Throws:

java.io.IOException

getCTDoseFromOCROfSiemensDoseScreen

public static CTDose getCTDoseFromOCROfSiemensDoseScreen(OCR ocr,
                                                         java.lang.String startDateTime,
                                                         java.lang.String endDateTime,
                                                         CTIrradiationEventDataFromImages eventDataFromImages,
                                                         boolean buildSR)
                                                  throws java.io.IOException

Create a CTDose instance from the OCR already performed on a Siemens dose screen image.

Parameters:

ocr - the object from the OCR performed in the image

startDateTime - the acquisition start date and time

endDateTime - the acquisition end date and time

eventDataFromImages - the pre event data from the reconstructed images

buildSR - whether or not to extract composite context from the list for use later to build an RDSR

Throws:

java.io.IOException

getCTDoseFromOCROfToshibaDoseScreen

public static CTDose getCTDoseFromOCROfToshibaDoseScreen(OCR ocr,
                                                         java.lang.String startDateTime,
                                                         java.lang.String endDateTime,
                                                         CTIrradiationEventDataFromImages eventDataFromImages,
                                                         boolean buildSR)
                                                  throws java.io.IOException

Create a CTDose instance from the OCR already performed on a Toshiba dose screen image.

Parameters:

ocr - the object from the OCR performed in the image

startDateTime - the acquisition start date and time

endDateTime - the acquisition end date and time

eventDataFromImages - the pre event data from the reconstructed images

buildSR - whether or not to extract composite context from the list for use later to build an RDSR

Throws:

java.io.IOException

getEightBitImageSuitableForThresholding

public static java.awt.image.BufferedImage getEightBitImageSuitableForThresholding(AttributeList list)
                                                                            throws DicomException

Get an 8 bit image suitable for thresholding.

Parameters:

list - the list

Returns:

the image

Throws:

DicomException

isDoseScreenInstance

public static boolean isDoseScreenInstance(AttributeList list)

isGEDoseScreenInstance

public static boolean isGEDoseScreenInstance(AttributeList list)

isGEDoseScreenSeriesNumber

protected static boolean isGEDoseScreenSeriesNumber(java.lang.String seriesNumber)

isPossiblyDoseScreenInstance

public static boolean isPossiblyDoseScreenInstance(AttributeList list)

isPossiblyDoseScreenInstance

public static boolean isPossiblyDoseScreenInstance(java.lang.String manufacturer,
                                                   java.lang.String sopClassUID,
                                                   java.lang.String imageType)

isPossiblyDoseScreenSeries

public static boolean isPossiblyDoseScreenSeries(AttributeList list)

isPossiblyDoseScreenSeries

public static boolean isPossiblyDoseScreenSeries(java.lang.String manufacturer,
                                                 java.lang.String modality,
                                                 java.lang.String seriesNumber,
                                                 java.lang.String seriesDescription)

isPossiblyGEDoseScreenInstance

public static boolean isPossiblyGEDoseScreenInstance(AttributeList list)

isPossiblyGEDoseScreenInstance

public static boolean isPossiblyGEDoseScreenInstance(java.lang.String manufacturer,
                                                     java.lang.String sopClassUID,
                                                     java.lang.String imageType)

isPossiblyGEDoseScreenSeries

public static boolean isPossiblyGEDoseScreenSeries(AttributeList list)

isPossiblyGEDoseScreenSeries

public static boolean isPossiblyGEDoseScreenSeries(java.lang.String manufacturer,
                                                   java.lang.String modality,
                                                   java.lang.String seriesNumber,
                                                   java.lang.String seriesDescription)

isPossiblySiemensDoseScreenInstance

public static boolean isPossiblySiemensDoseScreenInstance(AttributeList list)

isPossiblySiemensDoseScreenInstance

public static boolean isPossiblySiemensDoseScreenInstance(java.lang.String manufacturer,
                                                          java.lang.String sopClassUID,
                                                          java.lang.String imageType)

isPossiblySiemensDoseScreenSeries

public static boolean isPossiblySiemensDoseScreenSeries(AttributeList list)

isPossiblySiemensDoseScreenSeries

public static boolean isPossiblySiemensDoseScreenSeries(java.lang.String manufacturer,
                                                        java.lang.String modality,
                                                        java.lang.String seriesNumber,
                                                        java.lang.String seriesDescription)

isPossiblyToshibaDoseScreenInstance

public static boolean isPossiblyToshibaDoseScreenInstance(AttributeList list)

isPossiblyToshibaDoseScreenInstance

public static boolean isPossiblyToshibaDoseScreenInstance(java.lang.String manufacturer,
                                                          java.lang.String sopClassUID,
                                                          java.lang.String imageType)

isPossiblyToshibaDoseScreenSeries

public static boolean isPossiblyToshibaDoseScreenSeries(AttributeList list)

isPossiblyToshibaDoseScreenSeries

public static boolean isPossiblyToshibaDoseScreenSeries(java.lang.String manufacturer,
                                                        java.lang.String modality,
                                                        java.lang.String seriesNumber,
                                                        java.lang.String seriesDescription)

isSiemensDoseScreenInstance

public static boolean isSiemensDoseScreenInstance(AttributeList list)

isToshibaDoseScreenInstance

public static boolean isToshibaDoseScreenInstance(AttributeList list)

main

public static final void main(java.lang.String[] arg)

Extract the CT dose information in a screen save image using optical character recognition, correlate it with any acquired CT slice images.

Parameters:

arg - an array of 1 to 6 strings - the path to a dose screen save image or folder of screens (or "-" if to search for dose screens amongst acquired images), then optionally the path to a DICOMDIR or folder containing acquired CT slice images (or "-" if none and more arguments) then optionally the name of Dose SR file to write (or "-" if none and more arguments) then optionally the file containing the text glyphs to use during recognition rather than the default (or "-" if none and more arguments), then optionally the name of a file to write any newly trained glyphs to

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object