ImageGear for Java
com.accusoft.imagegear.core Package
Inheritance Hierarchy
This package is the basis of the ImageGear for Java toolkit. This package contains classes to operate with graphics primitives, license the product and, most importantly, primary ImageGear entities like page and document.
Classes
ClassDescription
ImGearArray Container of an array of arbitrary type.
ImGearArrayRef Represents a reference to a particular location in an array.
ImGearChannelRange Describes channels to be processed with com.accusoft.imagegear.processing.ImGearProcessing class methods.

This structure is passed to some processing methods such as com.accusoft.imagegear.processing.ImGearRasterProcessing.adjustContrast.

com.accusoft.imagegear.processing.ImGearRasterProcessing

ImGearColorBook Represents a color book.
ImGearColorBookColor Represents a color in the color book.
ImGearColorBooks Represents a static collection of color books.
ImGearColorChannelInfo Spot channel class that uses regular color space like RGB, CMYK, etc.
ImGearColorProfile Represents a color profile.

ImGearColorProfileManager

ImGearColorProfileManager Provides global profile storage and allows enabling and disabling the automatic use of global color profiles for color space conversion and display operations.
ImGearColorSpace Defines semantics of information, stored in all image channels.
ImGearCommonMetadataDictRecord Contains data for a common metadata dictionary record.

This structure is used with most ImageGear supported formats.

ImGearDIB Encapsulates an image, which consists of the pixel data and its attributes.

This class does not have public constructors. Instances of ImGearDIB exist only as a member objects of ImGearPage or ImGearROIMask classes.

ImGearDICOMMetadataDictRecord Represents basic information about DICOM Data Element.

See PS 3.6 2008, Registry of DICOM data elements table. The names of properties are equivalents to corresponding columns of the table.

ImGearDisplayChannel Represents display attributes for individual channel.
ImGearDisplayChannels Represents a collection of ImGearDisplayChannel class objects.
ImGearDocument Represents a collection of ImGearPage objects.

In addition to pages the object provides access to document level metadata.

In case of PDF or PS, ImGearDocument object may be associated with an external file.

ImGearDocumentPageArray Represents a collection of pages within ImGearDocument object.

On adding pages, checks that the new page is not attached to any other document. The remove(Object) method detaches a page from the document. If it is referenced from anywhere else, it remains a valid stand-alone page.

Well-formed page array may contain any number of null entries. An exception is made for the formats where pages are physically continuous (i.e., PDF). Note that setting a page to null is different from removing a page from the document - the former does not change page count, whereas the latter does.

ImGearEvaluationManager Provides an evaluation licensing manager.

This class must be initialized prior to using any other licensing call when the product is running in evaluation mode.

ImGearException Base class for all exceptions thrown by the ImageGear for Java library. Contains error codes and optionally supplied data.

Contains detailed information about the error that occurred.

This class does not have any public constructors. All instances are created implicitly by overloads of throwError static method.

ImGearExtraChannelInfo This is a general extra channel class.

Each extra channel in image has ImGearExtraChannelInfo object associated with it.

ImGearFullLUT Represents a lookup table that contains a full table of values for each possible input index.

Lookup table contains values for entire input range. Table of values can be accessed directly.

ImGearLicense Manages licensing data (i.e., license type and key).
ImGearLinearLUT This class represents a lookup table that does not store the actual LUT values, but calculates output values dynamically using a linear formula.

Such LUTs can be used for window levelling of 17-32 bit per channel images.

ImGearLUT Provides a base for lookup tables (LUTs) that are used in ImageGear.

A LUT is characterized by input depth and output depth; both input and output of the LUT can be signed or unsigned.

ImGearMaskColorChannelInfo Represents mask color channel info.

Class uses regular color space like RGB, CMYK, etc.

ImGearMaskSpotChannelInfo Represents a mask spot channel that uses a special (like Pantone) color.
ImGearMemoryStream Basic in-memory stream functionality
ImGearMetadataDictionary Provides access to Metadata Dictionary that is used in ImageGear.
ImGearMetadataHead Head of metadata tree.

ImGearMetadataHead is a special kind of metadata node with a null Parent field and not more than one child. It is present in every instance of ImGearPage class and ImGearDocument class as class member.

If the page or document has metadata, an instance of ImGearMetadataTree class is attached to the head as a child node. Otherwise, child is null.

ImGearMetadataHead may only be the root of metadata tree. Attempting to attach this class to any node causes ImageGear to throw an exception.

ImGearMetadataLeaf Represents metadata node that contains a data value and cannot reference other metadata nodes.
ImGearMetadataNode Provides generic functionality for the ImageGear metadata objects.

An ImGearMetadataNode can be referenced from one parent node or can be unreferenced. It cannot however be referenced from multiple parents. A node can never refer to itself either directly or indirectly.

ImGearMetadataNodeList Collection of metadata nodes. Processes additional verifications concerning collection structure. Used as a part of ImGearMetadataTree.

Represents container (list) of ImGearMetadataNode instances and provides additional verifications for stored objects. For example, on adding, new MetadataNode is checked to be non-null, stand-alone ( ImGearMetadataNode.getParent == null) and not the same as the top node of the tree to which it is added.

Nodes with different Format values are allowed to be present in the same list. Multiple nodes with the same Tag value are also allowed. The list is not sorted automatically because the order of items may be significant for a particular format.

This class does not have any public constructor. Instances exist only as members of ImGearMetadataTree objects.

ImGearMetadataTree Encapsulates entity of file format metadata tree.

Represents metadata tree with structure of any complexity. Similar to ImGearMetadataHead, ImGearMetadataTree, this is a special case of metadata node when getParent() returns null.

ImGearMultichannelLUT Represents a multichannel lookup table (LUT).

An ImGearMultichannelLUT object contains an array of single-channel ImGearLUT class objects.

ImGearNativePath This class obtains a path and manages the loading of native libraries associated with ImageGear Java on Windows systems.

At the first use of ImGearLicense it automatically looks for a path containing ImageGear Java's igjcommonnative2 native library. It does this by first finding the operating system architecture and then looking for either the environment variable, IMAGE_GEAR_64BIT_PATH, for 64 bits, or IMAGE_GEAR_32BIT_PATH, for 32 bits. These are expected to contain paths to the appropriate folder of native libraries.

If the variable does not exist, it looks in the components of the java.library.path System property. You can set the path to the native libraries to appear in this property in two ways:

  1. by adding the path to the operating system's path environment variable
  2. by invoking the Java Virtual Machine with the argument -D java.library.path=<path to native binaries>

Setting the operating system's path in the first way will prevent you from using the 32 and 64 bit SDKs simultaneously, since it will always find the version that is first.

The last place it looks is in a bin peer folder of the one the SDK jars were loaded from.

You can specify the native library location programmatically by calling the method, setPath before calling any licensing code, like ImGearLicense.setSolutionName, or after, if the search above does not find a path.

ImGearOrientation Specifies orientation of page or display.

This structure defines the orientation of an image. It works on the image representation and thus allows you to flip and rotate an image without modification of its data (pixels).

It is useful to manipulate the orientation of scanned black-and-white images. Since ImageGear for Java stores such images using lossless compression, this may avoid significant expansion of memory usage while operating on these images.

ImGearARTMark file formats support orientation natively and this allows you to save flipped or rotated images without loss of pixel data or file size enlargement when using compression.

ImGearPage Represents single-page image. In addition to image pixels, contains other attributes like ROI and metadata.

Represents the image and consists of three main parts:

  • Image data (pixels)
  • Metadata (non-image data)
  • Region of interest

The page can be either stand-alone (not referenced from any ImGearDocument classinstance) or attached to a document.

Region of interest ( ImGearROI class) represents free-shape image area (rectangular, non-rectangular or entire space) and specifies a meaningful part of an image. For example, it may be set up for some image processing functions to define the area to which the filter should be applied.

Metadata is non-image data. It is available for most image file formats. In some formats, such as TIFF or PNG, it can be very complex. It can include data of various types and can use a complex structure. ImageGear for Java offers a set of classes designed specifically to manipulate this data consisting of ImGearMetadataNode class, ImGearMetadataNodeList class, ImGearMetadataTree class and their descendants. The metadata for each instance of com.accusoft.imagegear.formats.xmp.pagedtext.ImGearPagedTextXMPMetadata may be accessed through its getMetadata method.

The Image data (or simply, image) is available through the getDIB method. Color Space, channels, width and height are among the major attributes that define the image structure.

ImGearPixel Encapsulates all attributes and operations for an image pixel.

This class encapsulates an image pixel and represents the color store for each channel value.

For simplicity, com.accusoft.imagegear.processing.ImGearPixelateFillMethod does not contain any information about channels depths and color space. Therefore pixels that are identical in structure ( ImGearPixel constructor parameters) may belong to images with significantly different channels, structure and color space.

ImGearPixelArray One dimensional array of image pixels.
ImGearRasterPage The class represents a raster image.

ImGearPage

ImGearRationalInt Specifies rational fraction as an indicated division of Numerator/Denominator.
ImGearRationalUInt Specifies rational fraction as an indicated division of Numerator/Denominator. The 4 most significant bytes of Numerator and Denominator are assumed to be 0.
ImGearResolution Stores ImageGear resolution data.

Specifies image resolution attributes.

ImGearRGBLUT Represents RGB lookup table (LUT).
ImGearRGBQuad Specifies an RGB value.
ImGearROI Region of interest associated with an ImGearPage instance.

The region of interest (ROI) represents freely shaped image area (rectangular, non-rectangular or entire space) that specifies the meaningful part of an image. For example - it may be used to define the area of an image to which an image processing method's filter should be applied.

ImGearROIMask 1-bit (binary) raster image that specifies a free shaped region of interest.

You can create an ImGearROIMask class object from a binary raster image or from a shape. If the mask is created from a shape, it represents a rasterized version of the shape.

ImGearROIRectangle Rectangular region of interest.
ImGearSize Implements a relative coordinate or position.
ImGearSpotChannelInfo Spot channel class that uses a special color, such as Pantone.

This class does not store a color name, but looks it up from the loaded color books when necessary.

ImGearStream Basic stream functionality.
ImGearStreams Factory for stream implementations.

The memory streams are always readable, until ImGearStream.close is called.

ImGearTransparency Specifies image transparency attributes like transparent color for display.
ImGearVersion This class provides static properties to retrieve version info for the product package.
ImGearWarning Base class for all warnings handled by the ImageGear for Java library. Contains error code and optionally supplied data.
Interfaces
InterfaceDescription
IImGearAddWarning Specifies the warning processing routine to be called when the warning is added.
IImGearColorBook Defines color book interface.
IImGearColorBookColor Defines color book color interface.
IImGearDICOMDisplaySettings Specifies baseline features for DICOM display settings.

This interface specifies baseline features for DICOM display settings. This interface is declared in the Core package, allowing you to attach DICOM Display settings to ImGearPage class and com.accusoft.imagegear.display.ImGearPageDisplay class. However, DICOM Display Settings are only available when the DICOM component is attached. Cast IImGearDICOMDisplaySettings interface to com.accusoft.imagegear.formats.dicom.ImGearDICOMDisplaySettings class to access its features.

com.accusoft.imagegear.formats.dicom.ImGearDICOMDisplaySettings

IImGearMetadataDictRecord Specifies baseline features for a metadata dictionary record.
IImGearOrientation Defines Orientation interface.
IImGearResolution Represents image resolution interface.
IImGearRGBQuad Defines palette entry interface.
IImGearSize Defines Size interface.
Enumerations
EnumerationDescription
ImGearColorSpaceIDs Specifies ImageGear color space IDs.

Specifies color space IDs. All colorspaces listed in this enumeration are supported for internal image storage.

ImageGear also supports colorspaces corresponding to valid combinations of ImGearColorSpaceIDs identifiers. Valid values are composed of a color identifier, such as RGB, Gy, Lab, etc, an optional Alpha and premulultiplied Alpha channel identifiers, and an optional Extra channel identifier. If Premultiplied Alpha bit is set, Alpha bit shall also be set. Only RGB and Gy colorspaces are currently allowed to be combined with Alpha or Premultiplied Alpha.

ImGearErrorCodes Specifies ImageGear error codes.
ImGearEvaluationMode Gets or sets the product evaluation mode.

Currently, only allowsWatermark.

ImGearExtraChannelType Specifies all the supported types of extra channels.
ImGearFlipModes Specifies ImageGear flip modes.
ImGearMaskChannelModes Specifies whether the color indicates masked or selected area.
ImGearOrientationModes Specifies ImageGear orientation modes.
ImGearRenderingIntents Lists identifiers that controls how colors are transformed during color space conversion using color profiles.
ImGearResolutionUnits Specifies the measurements of image resolution units.
ImGearRotationValues Specifies the value of the rotation angle.
ImGearSeekOrigin Provides the fields that represent reference points in streams for seeking.
ImGearSpotColorVendorID Specifies all supported vendor IDs.
See Also

Reference

ImageGearJava Project

 

 


©2016. Accusoft Corporation. All Rights Reserved.

Send Feedback