|
Mako 7.5.0 API
|
|
Mako 7.5.0 API
|
A transform for downsampling images above a given effective resolution to a desired target effective resolution. More...
#include <transforms.h>
Public Member Functions | |
| virtual void | setColorDownsamplingMethod (IDOMImageDownsamplerFilter::eDownsamplingMethod method)=0 |
| Set the desired downsampling method for color images. The default is bicubic. | |
| virtual IDOMImageDownsamplerFilter::eDownsamplingMethod | getColorDownsamplingMethod () const =0 |
| Get the downsampling method to be used for color images. | |
| virtual void | setGrayDownsamplingMethod (IDOMImageDownsamplerFilter::eDownsamplingMethod method)=0 |
| Set the desired downsampling method for gray images The default is bicubic. | |
| virtual IDOMImageDownsamplerFilter::eDownsamplingMethod | getGrayDownsamplingMethod () const =0 |
| Get the downsampling method to be used for gray images. | |
| virtual void | setMonoDownsamplingMethod (IDOMImageDownsamplerFilter::eDownsamplingMethod method)=0 |
| Set the desired downsampling method for monochrome images. The default is subsample. NB: using any other method other than subsampling for monochrome images will result in grayscale output. | |
| virtual IDOMImageDownsamplerFilter::eDownsamplingMethod | getMonoDownsamplingMethod () const =0 |
| Get the downsampling method to be used for mono images. | |
| virtual void | setTargetResolution (float resolution)=0 |
| Set a blanket target resolution (dpi) for downsampling all images. This will also set the threshold resolution to the same value. | |
| virtual void | setThresholdResolution (float resolution)=0 |
| Set a blanket threshold resolution (dpi) for downsampling all images. Only images with an effective resolution of at least this value will be downsampled. | |
| virtual void | setColorTargetResolution (float resolution)=0 |
| Set a target resolution (dpi) for downsampling color images. This will also set the threshold resolution to the same value. Setting this to 0.0 will result in no downsampling for this image type. The default is 0.0. | |
| virtual float | getColorTargetResolution ()=0 |
| Get the target resolution (dpi) for downsampling color images. | |
| virtual void | setColorThresholdResolution (float resolution)=0 |
| Set a threshold resolution (dpi) for downsampling color images. Only images with an effective resolution of at least this value will be downsampled. | |
| virtual float | getColorThresholdResolution ()=0 |
| Get the theshold resolution (dpi) for downsampling color images. | |
| virtual void | setGrayTargetResolution (float resolution)=0 |
| Set a target resolution (dpi) for downsampling gray images. This will also set the threshold resolution to the same value. The default is 300dpi. Setting this to 0.0 will result in no downsampling for this image type. The default is 0.0. | |
| virtual float | getGrayTargetResolution ()=0 |
| Get the target resolution (dpi) for downsampling gray images. | |
| virtual void | setGrayThresholdResolution (float resolution)=0 |
| Set a threshold resolution (dpi) for downsampling gray images. Only images with an effective resolution of at least this value will be downsampled. | |
| virtual float | getGrayThresholdResolution ()=0 |
| Get the theshold resolution (dpi) for downsampling gray images. | |
| virtual void | setMonoTargetResolution (float resolution)=0 |
| Set a target resolution (dpi) for downsampling monochrome images. This will also set the threshold resolution to the same value. The default is 1200dpi. Setting this to 0.0 will result in no downsampling for this image type. The default is 0.0. | |
| virtual float | getMonoTargetResolution ()=0 |
| Get the target resolution (dpi) for downsampling mono images. | |
| virtual void | setMonoThresholdResolution (float resolution)=0 |
| Set a threshold resolution (dpi) for downsampling monochrome images. Only images with an effective resolution of at least this value will be downsampled. | |
| virtual float | getMonoThresholdResolution ()=0 |
| Get the theshold resolution (dpi) for downsampling mono images. | |
| virtual void | setDownsampleMaskedImages (bool downsampleMaskedImages)=0 |
| Set whether or not to downsample masked images. | |
| virtual void | setUseMaskResolutionForMaskedImages (bool useMaskResolutionSettingForMaskedImages)=0 |
| Set whether or not the mask resolution setting should be applied to the image portion of a masked image. | |
 Public Member Functions inherited from JawsMako::ITransform | |
| virtual IDOMBrushPtr | transform (const IDOMBrushPtr &brush, eBrushUsage usage=eBUGeneral, const CTransformState &state=CTransformState())=0 |
| Apply the transform to the given brush, if applicable. These transforms are thread safe. | |
| virtual IDOMImagePtr | transform (const IDOMImagePtr &image, const CTransformState &state=CTransformState())=0 |
| Apply the transform to the given image, if applicable. These transforms are thread safe. | |
| virtual IDOMColorPtr | transform (const IDOMColorPtr &color, const CTransformState &state=CTransformState())=0 |
| Apply the transform to the given color, if applicable. These transforms are thread safe. | |
| virtual IDOMColorSpacePtr | transform (const IDOMColorSpacePtr &colorSpace, const CTransformState &state=CTransformState())=0 |
| Apply the transform to the given colorspace, if applicable. These transforms are thread safe. | |
| virtual IDOMNodePtr | transform (const IDOMNodePtr &node, bool &changed, bool transformChildren=true, const CTransformState &state=CTransformState())=0 |
| Apply the transform to the given node, if applicable. These transforms are thread safe, providing no other transforms are being applied to the same nodes at the same time. | |
| virtual void | transformPage (const IPagePtr &page, bool transformContent=true, bool transformAnnotations=true)=0 |
| Apply the transform to the given page, if applicable. These transforms are thread safe, providing no other transforms are being applied to the same nodes at the same time. The transform will also apply to the annotations appearances. | |
| virtual void | flushCaches ()=0 |
| Flush the caches used by the transform. Most transforms cache recently transformed results to improve the performance of repeated transformations of equivalent results. However, it is possible that some cached results may point to entities that no longer exist, such as content inside an XPS file that no longer exists. If you are deleting or replacing files where transforms have been used, it is advisable to invoke this routine to clear the caches. | |
| virtual void | setProgressMonitor (const IProgressMonitorPtr &progressMonitor)=0 |
| Set the IProgressMonitor object for this transform to allow for monitoring the progress of the transform. | |
| Public Member Functions inherited from IRCObject | |
| virtual void | addRef () const =0 |
| Increases the reference count of the actual object pointed to. This would take place during an assignment or copying. | |
| virtual bool | decRef () const =0 |
| Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to. | |
| virtual int32 | getRefCount () const =0 |
| Retrieve the current reference count of the actual object pointed to. | |
Static Public Member Functions | |
| static JAWSMAKO_API IImageDownsamplerTransformPtr | create (const IJawsMakoPtr &jawsMako, const IAbortPtr &abort=IAbortPtr()) |
| Create the transform. | |
Additional Inherited Members | |
| Protected Member Functions inherited from IRCObject | |
| virtual | ~IRCObject () |
| Virtual destructor. | |
A transform for downsampling images above a given effective resolution to a desired target effective resolution.
|
static |
Create the transform.
| jawsMako | The JawsMako instance. |
|
pure virtual |
Set whether or not to downsample masked images.
This applies to cases where an image is masked by a separate masked image, such as types of PDF masked or soft-masked images. These are represented in the DOM using IDOMMaskedBrush, where the sub-brush is an image. The default is true.
|
pure virtual |
Set whether or not the mask resolution setting should be applied to the image portion of a masked image.
This applies to cases where an image is masked by a separate masked image, such as types of PDF masked or soft-masked images. These are represented in the DOM using IDOMMaskedBrush, where the sub-brush is an image.
If false, then the mask and the image are evaluated separately and a downsampling resolution and threshold are chosen. For the mask, this is normally either grayscale or monochrome. The image data can be anything. In this mode it is possible for the downsampled image and mask to be downsampled to different resolutions.
If true, then whatever target resolution and threshold is applied to the mask will also be applied to the image samples. If these images have the same effective resolution before downsampling, then they will also share the same effective resolution after downsampling.
The default is false.