ExtractTextTableFromPRData

MacroModule

author	wspindler
package	FMEstable/ReleaseMeVis
definition	ExtractTextTableFromPRData.def
see also	MultiFileVolumeListPROutput
keywords	Dicom, Presentation, States, PR, json, cardio, cardiac, ventriicular, function

Purpose

ExtractTextTableFromPRData scans a DICOM tree from connected MultiFileVolume, looks for text information in the GraphicAnnotationSequence (0070,0001), and tries to format it as table. Results are three versions of the extracted text information, as text string, JSON, and comma separated values. Additional settings can be applied to extract table information only if a number of tags match specific substrings to prevent that text tables are created from undesired structures.

Windows

Default Panel

Input Fields

inBase

name: inBase, type: MLBase

Either a MultiFileVolumeList from whose DCMTree, or a DCMTree itself, from which the textual information shall be extracted

Parameter Fields

Field Index

[]: Trigger	JSON: String	Text: String
Clear: Trigger	On (inEnableTagToCheck00): Bool	Update: Trigger
CSV: String	On (inEnableTagToCheck01): Bool	Value (inValueOfTagToCheck00): String
doNotClearOnFailedUpdate: Bool	On (inEnableTagToCheck02): Bool	Value (inValueOfTagToCheck01): String
Has Valid Output: Bool	On (inEnableTagToCheck03): Bool	Value (inValueOfTagToCheck02): String
ID (inIDOfTagToCheck00): String	On (inEnableTagToCheck04): Bool	Value (inValueOfTagToCheck03): String
ID (inIDOfTagToCheck01): String	On (inEnableTagToCheck05): Bool	Value (inValueOfTagToCheck04): String
ID (inIDOfTagToCheck02): String	On (inEnableTagToCheck06): Bool	Value (inValueOfTagToCheck05): String
ID (inIDOfTagToCheck03): String	On (inEnableTagToCheck07): Bool	Value (inValueOfTagToCheck06): String
ID (inIDOfTagToCheck04): String	On (inEnableTagToCheck08): Bool	Value (inValueOfTagToCheck07): String
ID (inIDOfTagToCheck05): String	On (inEnableTagToCheck09): Bool	Value (inValueOfTagToCheck08): String
ID (inIDOfTagToCheck06): String	On (inEnableTagToCheck10): Bool	Value (inValueOfTagToCheck09): String
ID (inIDOfTagToCheck07): String	On Input Change Behavior: Enum	Value (inValueOfTagToCheck10): String
ID (inIDOfTagToCheck08): String	Restriction Mode: Enum	Volume index: Integer
ID (inIDOfTagToCheck09): String	Status Code: Enum
ID (inIDOfTagToCheck10): String	Status Message: String

Visible Fields

Update

name: update, type: Trigger

Initiates update of all output field values.

Clear

name: clear, type: Trigger

Clears all output field values to a clean initial state.

On Input Change Behavior

name: onInputChangeBehavior, type: Enum, default: Clear, deprecated name: shouldAutoUpdate,shouldUpdateAutomatically

Declares how the module should react if a value of an input field changes.

Values:

Title	Name	Deprecated Name
​Update	​Update	​TRUE
​Clear	​Clear	​FALSE

[]

name: updateDone, type: Trigger, persistent: no

Notifies that an update was performed (Check status interface fields to identify success or failure).

Has Valid Output

name: hasValidOutput, type: Bool, persistent: no

Indicates validity of output field values (success of computation).

Status Code

name: statusCode, type: Enum, persistent: no

Reflects module’s status (successful or failed computations) as one of some predefined enumeration values.

Values:

Title	Name
​Ok	​Ok
​Invalid input object	​Invalid input object
​Invalid input parameter	​Invalid input parameter
​Internal error	​Internal error

Status Message

name: statusMessage, type: String, persistent: no

Gives additional, detailed information about status code as human-readable message.

Volume index

name: inVolumeIndex, type: Integer, default: 0, minimum: 0

Index of the MultiFileVolume from which the table shall be extracted.

ID (inIDOfTagToCheck00)

name: inIDOfTagToCheck00, type: String

Id of a DICOM tag in format (GroupId,ElementId) with both hexadecimal values such as (0008,103e), which must exist and whose string-converted content must contain Value.

Value (inValueOfTagToCheck00)

name: inValueOfTagToCheck00, type: String

String which must be part of the string-converted value ID.

On (inEnableTagToCheck00)

name: inEnableTagToCheck00, type: Bool, default: FALSE

If enabled then the tag with ID Value must contain Value, otherwise no textual information is extracted.

ID (inIDOfTagToCheck01)

name: inIDOfTagToCheck01, type: String

See ID.

Value (inValueOfTagToCheck01)

name: inValueOfTagToCheck01, type: String

See Value.

On (inEnableTagToCheck01)

name: inEnableTagToCheck01, type: Bool, default: FALSE

See On.

ID (inIDOfTagToCheck02)

name: inIDOfTagToCheck02, type: String

See ID.

Value (inValueOfTagToCheck02)

name: inValueOfTagToCheck02, type: String

See Value.

On (inEnableTagToCheck02)

name: inEnableTagToCheck02, type: Bool, default: FALSE

See On.

ID (inIDOfTagToCheck03)

name: inIDOfTagToCheck03, type: String

See ID.

Value (inValueOfTagToCheck03)

name: inValueOfTagToCheck03, type: String

See Value.

On (inEnableTagToCheck03)

name: inEnableTagToCheck03, type: Bool, default: FALSE

See On.

ID (inIDOfTagToCheck04)

name: inIDOfTagToCheck04, type: String

See ID.

Value (inValueOfTagToCheck04)

name: inValueOfTagToCheck04, type: String

See Value.

On (inEnableTagToCheck04)

name: inEnableTagToCheck04, type: Bool, default: FALSE

See On.

ID (inIDOfTagToCheck05)

name: inIDOfTagToCheck05, type: String

See ID.

Value (inValueOfTagToCheck05)

name: inValueOfTagToCheck05, type: String

See Value.

On (inEnableTagToCheck05)

name: inEnableTagToCheck05, type: Bool, default: FALSE

See On.

ID (inIDOfTagToCheck06)

name: inIDOfTagToCheck06, type: String

See ID.

Value (inValueOfTagToCheck06)

name: inValueOfTagToCheck06, type: String

See Value.

On (inEnableTagToCheck06)

name: inEnableTagToCheck06, type: Bool, default: FALSE

See On.

ID (inIDOfTagToCheck07)

name: inIDOfTagToCheck07, type: String

See ID.

Value (inValueOfTagToCheck07)

name: inValueOfTagToCheck07, type: String

See Value.

On (inEnableTagToCheck07)

name: inEnableTagToCheck07, type: Bool, default: FALSE

See On.

ID (inIDOfTagToCheck08)

name: inIDOfTagToCheck08, type: String

See ID.

Value (inValueOfTagToCheck08)

name: inValueOfTagToCheck08, type: String

See Value.

On (inEnableTagToCheck08)

name: inEnableTagToCheck08, type: Bool, default: FALSE

See On.

ID (inIDOfTagToCheck09)

name: inIDOfTagToCheck09, type: String

See ID.

Value (inValueOfTagToCheck09)

name: inValueOfTagToCheck09, type: String

See Value.

On (inEnableTagToCheck09)

name: inEnableTagToCheck09, type: Bool, default: FALSE

See On.

ID (inIDOfTagToCheck10)

name: inIDOfTagToCheck10, type: String

See ID.

Value (inValueOfTagToCheck10)

name: inValueOfTagToCheck10, type: String

See Value.

On (inEnableTagToCheck10)

name: inEnableTagToCheck10, type: Bool, default: FALSE

See On.

Restriction Mode

name: inRestrictionsModes, type: Enum, default: Clear

Setup restrictions for special text tables.

Values:

Title	Name	Description
​Clear	​Clear	​Resets and disables all restricting tags.
​User	​User	​Leaves the restriction settings unchanged, the fields can be modified as desired.
​Siemens Cardio Cine SAX Ventricular Function	​Siemens_Cardio_Cine_SAX_Ventricular_Function	​A special set of restrictions is set up which matches a propriatry Cardio SAYX sequence of the manufacturer Siemens.

JSON

name: outJSON, type: String, persistent: no

Text field showing the extracted table in JSON format.

CSV

name: outCSV, type: String, persistent: no

Text field showing the extracted table in comma separated values format.

Text

name: outText, type: String, persistent: no

Text field showing the extracted table as pure formated text.

Hidden Fields

doNotClearOnFailedUpdate

name: doNotClearOnFailedUpdate, type: Bool, persistent: no

Prevents automated clear after update failed. This does not affect status fields. It enables the developer to analyze module’s state after failure.