ImGearLayeredPage Class Methods

For a list of all members of this type, see ImGearLayeredPage members.

Public Methods

	Name	Description
	clone	Clones the layered page object.
	createFromDIB	Creates new page with same image data as given DIB. (Inherited from com.accusoft.imagegear.core.ImGearRasterPage)
	createFromImage	Creates a new com.accusoft.imagegear.core.ImGearRasterPage using the image data from incoming `Image`. (Inherited from com.accusoft.imagegear.core.ImGearRasterPage)
	duplicateRect	Returns a new raster page object representing a part of the com.accusoft.imagegear.core.ImGearRasterPage object limited by the specified rectangle. (Inherited from com.accusoft.imagegear.core.ImGearRasterPage)
	flatten	This method renders all the visible layers into the raster composition DIB. This method can be used to flatten the layered page into the raster page. As a result of this method, the base com.accusoft.imagegear.core.ImGearRasterPage class object is regenerated and can be used to access the result of the flattening operation. com.accusoft.imagegear.core.ImGearRasterPage
	getColorProfile	Returns a local color profile associated with the image. If a color profile is set here, and profiles are enabled in com.accusoft.imagegear.core.ImGearColorProfileManager class, the local color profile will be used for color space conversions (instead of a global color profile). The default value is null. (Inherited from com.accusoft.imagegear.core.ImGearRasterPage)
	getComposition	Gets layered page composition. com.accusoft.imagegear.core.ImGearPage class object as layers composition. Method renders all the visible layers into the raster composition DIB.
	getCompositionChanellDepths	Gets chanell depths composition.
	getCompositionColorSpace	Returns raster composition com.accusoft.imagegear.core.ImGearColorSpace value.
	getCompositionDimensions	Gets dimensions composition.
	getDIB	Gets a reference to the com.accusoft.imagegear.core.ImGearDIB class object. This object contains the page's pixel data. Non-null reference to an instance of com.accusoft.imagegear.core.ImGearDIB class. Provides access to image properties and image pixel data. The `getDIB` method always returns a non-null reference. However, an com.accusoft.imagegear.formats.xmp.pagedtext.ImGearPagedTextXMPMetadata object can also be used without allocating its DIB's pixel store. The method com.accusoft.imagegear.core.ImGearDIB.isEmpty is available to detect whether the pixel store has been allocated. com.accusoft.imagegear.core.ImGearDIB (Inherited from com.accusoft.imagegear.core.ImGearPage)
	getDICOMDisplaySettings	Returns DICOM specific display contrast settings. com.accusoft.imagegear.core.IImGearDICOMDisplaySettings interface. The DICOM specification defines several contrast transformations including Modality LUT, VOI LUT... When ImageGear loads a DICOM image, it initializes `getDICOMDisplaySettings()` method of com.accusoft.imagegear.core.ImGearRasterPage class with the settings found in the file. During display, ImageGear checks for the presence of `DICOMDisplaySettings`, and if it is present, uses it in display processing pipeline. This allows the user to load and display DICOM images with proper contrast, without the need for extra application code. DICOMDisplaySettings can be attached to an com.accusoft.imagegear.core.ImGearRasterPage class or to a com.accusoft.imagegear.display.ImGearPageDisplay class. If com.accusoft.imagegear.core.IImGearDICOMDisplaySettings property is not null, ImageGear uses it for display. If com.accusoft.imagegear.core.ImGearRasterPage method returns null, ImageGear checks `ImGearRasterPage` class for presence of `DICOMDisplaySettings` value, and if it is not null, uses it for display. In other words, `DICOMDisplaySettings` property attached to `ImGearPageDisplay` class has higher priority than `DICOMDisplaySettings` property attached to `ImGearRasterPage` class. setDICOMDisplaySettings/setDICOMDisplaySettings methods can be also used if the image was not loaded from a DICOM file. It can be useful for non-medical images. This property affects grayscale images with bit depths from 2 to 31. The type of this method is an interface with only the members necessary for displaying the page with specific DICOM display settings. If the application needs to retrieve or modify DICOM Display Settings, it shall cast com.accusoft.imagegear.core.IImGearDICOMDisplaySettings interface to the actual com.accusoft.imagegear.formats.dicom.ImGearDICOMDisplaySettings class. The default value is null. com.accusoft.imagegear.core.IImGearDICOMDisplaySettings For more information about multiple JAR components, see 'Using Multiple Packages'. (Inherited from com.accusoft.imagegear.core.ImGearRasterPage)
	getDocument	Gets the document to which the page belongs, or null if the page is stand-alone. com.accusoft.imagegear.core.ImGearDocument class instance or null, if page is stand-alone. (Inherited from com.accusoft.imagegear.core.ImGearPage)
	getLayers	Gets the array of layers from the layered page. ImGearLayerArray class object. ImGearLayerArray
	getMetadata	Gets the head, com.accusoft.imagegear.core.ImGearMetadataHead, of the page's metadata tree. Non-null reference to com.accusoft.imagegear.core.ImGearMetadataHead class object. (Inherited from com.accusoft.imagegear.core.ImGearPage)
	getROI	Returns region of interest. The region of interest may have either rectangular or non-rectangular shape. If the ROI is null the region of interest is assumed to be the entire image area. com.accusoft.imagegear.core.ImGearROI (Inherited from com.accusoft.imagegear.core.ImGearRasterPage)
	setColorProfile	Sets a local color profile associated with the image. If a color profile is set here, and profiles are enabled in com.accusoft.imagegear.core.ImGearColorProfileManager class, the local color profile will be used for color space conversions (instead of a global color profile). The default value is null. (Inherited from com.accusoft.imagegear.core.ImGearRasterPage)
	setCompositionChanellDepths	Sets chanell depths composition.
	setCompositionColorSpace	Sets raster composition com.accusoft.imagegear.core.ImGearColorSpace value.
	setCompositionDimensions	Sets dimensions composition.
	setDICOMDisplaySettings	Sets DICOM specific display contrast settings. com.accusoft.imagegear.core.IImGearDICOMDisplaySettings interface. The DICOM specification defines several contrast transformations including Modality LUT, VOI LUT... When ImageGear loads a DICOM image, it initializes DICOMDisplaySettings property of com.accusoft.imagegear.core.ImGearRasterPage class with the settings found in the file. During display, ImageGear checks for the presence of `DICOMDisplaySettings`, and if it is present, uses it in display processing pipeline. This allows the user to load and display DICOM images with proper contrast, without the need for extra application code. DICOMDisplaySettings can be attached to an com.accusoft.imagegear.core.ImGearRasterPage class or to a com.accusoft.imagegear.display.ImGearPageDisplay class. If com.accusoft.imagegear.display.ImGearPageDisplay.getDICOMDisplaySettings property is not null, ImageGear uses it for display. If `ImGearPageDisplay.DICOMDisplaySettings` property is null, ImageGear checks `ImGearRasterPage` class for presence of `DICOMDisplaySettings`, and if it is not null, uses it for display. In other words, `DICOMDisplaySettings` property attached to `ImGearPageDisplay` class has higher priority than `DICOMDisplaySettings` property attached to `ImGearRasterPage` class. DICOMDisplaySettings property can be also used if the image was not loaded from a DICOM file. It can be useful for non-medical images. This property affects grayscale images with bit depths from 2 to 31. The type of this property is an interface with only the members necessary for displaying the page with specific DICOM display settings. If the application needs to retrieve or modify DICOM Display Settings, it shall cast com.accusoft.imagegear.core.IImGearDICOMDisplaySettings interface to the actual com.accusoft.imagegear.formats.dicom.ImGearDICOMDisplaySettings class. The default value is null. com.accusoft.imagegear.core.IImGearDICOMDisplaySettings (Inherited from com.accusoft.imagegear.core.ImGearRasterPage)
	setROI	Sets region of interest. The region of interest may have either rectangular or non-rectangular shape. If the ROI is null the region of interest is assumed to be the entire image area. com.accusoft.imagegear.core.ImGearROI (Inherited from com.accusoft.imagegear.core.ImGearRasterPage)

Top

Reference

ImGearLayeredPage Class
com.accusoft.imagegear.processing.layers Package