JBoss

JMX MBean View
Back to Agent View Refresh MBean View

MBean description:

Lossy Compression Service. The Lossy Compression Service supports delayed, JPEG Lossy compression of received images.

List of MBean attributes:

Name Type Access Value Description
Name java.lang.String R LossyCompressionService The class name of the MBean
State int R 3 The status of the MBean
StateString java.lang.String R Started The status of the MBean in text form
SourceFileSystemGroupID java.lang.String RW Group ID of file systems which are scanned for image files to compress in configured TaskInterval.
DestinationFileSystemGroupID java.lang.String RW Group ID of writable file systems to which lossy compressed images are stored.
TaskInterval java.lang.String RW Interval in which the database is checked for image files located on file systems of the configured SourceFileSystemGroupID to compress.
Format:
interval!from-to or NEVER
interval = ##s (in seconds), ##m (in minutes), ##h (in hours).
from = start hour (0-23) when no compression should be performed
to = end hour (0-23) when no compression should be performed
NEVER = disable automatic compression
Example:10s!9-17 means every 10 seconds, poll the database and check for images to compress, except between the hours of 9:00am and 5:00pm. By setting this type of TaskInterval, you can ensure compression of images happens outside of peak imaging hours.
isRunning boolean R False Current state if compression task is running. Used to avoid concurrency!
LimitNumberOfFilesPerTask int RW Maximum number of files that are compressed in one task.
CompressionRules java.lang.String RW Specifies compression rules for particular SOP Class, Body Part Examined, Source AE Title.

Format: sop-class-name-or-uid:body-part:source-aet:delay:quality:description:ratio:near

sop-class-name-or-uid = the UID of the SOP class, or a string name defined in the dictionary.xml file under uids type="SOPClass"

body-part = Body Part Examined or '*'

source-aet = Source AE Title

delay = compression delay in minutes (##m), hours (##h) or days (##d)

quality = compression quality between 0 (= lowest image quality / highest compression ratio) and 1.0 (= highest quality / lowest compression ratio)

description = description stored in attribute Derivation Description (0008,2111) of compressed DICOM image

ratio = estimated compression ratio stored in attribute Lossy Image Compression Ratio (0028,2112) of compressed DICOM image

near = maximal absolute derivation of pixel sample values by lossy compression+decompression. -1 = disables validation of compressed images
ExternalRetrieveAETitle java.lang.String RW Constrains lossy compression to objects which are external retrievable from specified Application Entity.
'-' = no such constrain.
CopyOnOtherFileSystemGroupID java.lang.String RW Constrains lossy compression to objects for which there is a copy available on a file system of the specified file system group. Only effective if ExternalRetrieveAETitle = '-'.
'-' = no such constrain.
SourceAETitle java.lang.String RW Source AE Title used by operation compressSeriesJPEGLossy for new created Series.
SeriesDescription java.lang.String RW Series Description used by operation compressSeriesJPEGLossy for new created Series. '{}' will be replaced by Series Description of uncompressed objects.
BufferSize int RW Size of write byte buffer.
TempDirectory java.lang.String RW Directory to spool decompressed already lossless compressed files for its lossy compression. Relative path names are resolved relative to $DCM4CHEE_HOME/server/default/.
FetchSize int RW JDBC Fetch size.
StoreScpServiceName javax.management.ObjectName RW View MBean Used internally. Do NOT modify.
SchedulerServiceName javax.management.ObjectName RW View MBean Used internally. Do NOT modify.
FileSystemMgtServiceNamePrefix java.lang.String RW Used internally. Do NOT modify.
TimerIDCheckFilesToCompress java.lang.String RW Used internally. Do NOT modify.

List of MBean operations:

void create()

Standard MBean lifecycle method

void start()

The start lifecycle operation

void stop()

The stop lifecycle operation

void destroy()

The destroy lifecycle operation

void jbossInternalLifecycle()

The detyped lifecycle operation (for internal use only)

Param ParamType ParamValue ParamDescription
method java.lang.String The lifecycle operation

java.lang.String compressFileJPEGLossy()

Compress specified file JPEG Lossy with specified quality. Prompts Compression Ratio, measured on file length and on bits per pixel.

Param ParamType ParamValue ParamDescription
inFilePath java.lang.String (no description)
outFilePath java.lang.String (no description)
compressionQuality float (no description)
derivationDescription java.lang.String (no description)
estimatedCompressionRatio float (no description)
newSOPInstanceUID boolean True False (no description)
newSeriesInstanceUID boolean True False (no description)

java.lang.String compressSeriesJPEGLossy()

Compress specified Series located on file systems of the configured SourceFileSystemGroupID JPEG Lossy with specified quality. Prompts number of compressed images and minimum/average/maximum Compression Ratio, measured on file length and on bits per pixel. If decompress = True, also prompts minimum/average/maximum of maximal absolute derivation of pixel sample values in decompressed images.

Param ParamType ParamValue ParamDescription
seriesIUID java.lang.String Series Instance UID of Series to compress
compressionQuality float Compression quality in the range 0.0 - 1.0.
derivationDescription java.lang.String Description stored in Derivation Description (0008,2111) of compressed images.
estimatedCompressionRatio float Estimated Compression Ratio stored in Lossy Image Compression Ratio (0028,2112) of compressed images.
decompress boolean True False Decompress lossy compressed images and calculate maximal absolute derivation of pixel sample values.
archive boolean True False Archive lossy compressed image as additional Series of the same Study.

void checkForFilesToCompress()

Checked for image files located on file systems of the configured SourceFileSystemGroupID to compress according the configured CompressionRules.