# Visualization
TKService
Image

# Image_Image Class Reference

This class defined the general behavior of an Image from
Package Image .
.

`#include <Image_Image.hxx>`

Inheritance diagram for Image_Image:

[legend]

## Public Member Functions

virtual Standard_EXPORT void | Destroy ()
| Image destructor. .
| ~Image_Image ()
virtual Standard_EXPORT Standard_Boolean | isSamePixel (const Standard_Integer X, const Standard_Integer Y, const Handle(Image_Image)&anotherImage, const Standard_Integer anotherX, const Standard_Integer anotherY) const =0
| Returns True if me->Pixel(X,Y) is equal to anotherImage->Pixel(anotherX,anotherY) .
virtual Standard_EXPORT const Quantity_Color & | PixelColor (const Standard_Integer X, const Standard_Integer Y) const =0
| Returns the Color of an Image Pixel. .
virtual Standard_EXPORT Handle_Quantity_HArray1OfColor | RowColor (const Standard_Integer Y) const
| Returns the Color of an Image Pixel Row. .
virtual Standard_EXPORT void | RowColor (const Standard_Integer Y, Quantity_Array1OfColor &aArray1) const
| Stores the Color of an Image Pixel Row in aArray1. .
Standard_EXPORT Handle_Standard_Type | PixelType () const
| Returns the Image Pixel Type. .
Standard_EXPORT Standard_Integer | Size () const
| Returns the Image size in Pixel unit ( width*height) . .
virtual Standard_EXPORT void | InternalDup (const Handle(Image_Image)&anImage)=0
| Duplicates an Image. .
virtual Standard_EXPORT void | SetOrigin (const Standard_Integer x, const Standard_Integer y)=0
| Sets Image origin, for Rotation, copy between image ... Image origin is on the TOP LEFT . Y axis goes TOP to DOWN , X axis goes LEFT to RIGHT. .
virtual Standard_EXPORT Standard_Integer | LowerX () const =0
| Returns the lower X Image coordinate ( X Origin ). .
virtual Standard_EXPORT Standard_Integer | UpperX () const =0
| Returns the upper X Image coordinate ( X Origin + Image width - 1 ). .
virtual Standard_EXPORT Standard_Integer | Width () const =0
| Returns the Image width. .
virtual Standard_EXPORT Standard_Integer | LowerY () const =0
| Returns the lower Y Image coordinate ( Y Origin ). .
virtual Standard_EXPORT Standard_Integer | UpperY () const =0
| Returns the upper Y Image coordinate ( Y Origin + Image height - 1 ). .
virtual Standard_EXPORT Standard_Integer | Height () const =0
| Returns the Image height. .
virtual Standard_EXPORT void | Resize (const Standard_Real XOffset, const Standard_Real XScale, const Standard_Real YOffset, const Standard_Real YScale)=0
| Resize an Image. Image Pixel are left unchanged at there absolute positon. Resulting Image can be clipped. newLowerX = LowerX()*XScale + XOffset newLowerY = LowerY()*YScale + YOffset newUpperX = UpperX()*XScale + XOffset newUpperY = UpperY()*YScale + YOffset newWidth = Width() *XScale newHeight = Height()*YScale .
virtual Standard_EXPORT Image_TypeOfImage | Type () const =0
| Returns the ImageType TOI_ColorImage or TOI_PseudoColorImage .
virtual Standard_EXPORT void | Pixel (const Standard_Integer X, const Standard_Integer Y, Aspect_Pixel &aPixel) const =0
| Get the Image Pixel Value at X,Y coordinate in aPixel. Warning: aPixel must have the same type than Image Pixel. .
virtual Standard_EXPORT void | SetPixel (const Standard_Integer X, const Standard_Integer Y, const Aspect_Pixel &aPixel)=0
| Store aPixel in the Image at X,Y coordinate . Warning: aPixel must have the same type than Image Pixel. .
virtual Standard_EXPORT void | Pixel (const Standard_Integer X, const Standard_Integer Y, Image_PixelAddress &aPixel) const =0
| Get the Image Pixel Value at X,Y coordinate in aPixel. Warning: aPixel must have the same type than Image Pixel. .
virtual Standard_EXPORT void | SetPixel (const Standard_Integer X, const Standard_Integer Y, const Image_PixelAddress &aPixel)=0
| Store aPixel in the Image at X,Y coordinate . Warning: aPixel must have the same type than Image Pixel. .
virtual Standard_EXPORT void | Transpose (const Image_FlipType aType)=0
| Transpose an Image( flipping across horizontal axis or vertical axis, or across diagonal... ) This geometric transformation preserves all Image Pixels. We don't need to interpolate pixels . Warning : Image size change during Transpose. .
virtual Standard_EXPORT void | Clip (const Standard_Integer X, const Standard_Integer Y, const Standard_Integer Width, const Standard_Integer Height)=0
| Extract a SubImage starting at coordinate X,Y to (X+Width-1),(Y+Height-1). Warning : the Image size and origin change, new origin is X,Y ; new size is Width,Height. .
virtual Standard_EXPORT void | Shift (const Standard_Integer XShift, const Standard_Integer YShift)=0
| Translate an Image XShift pixel Right, YShift Down . Shift parameter are Integer value. .
virtual Standard_EXPORT void | Fill (const Handle(Image_Image)&SrcImage)=0
| Fill me with SrcImage. SrcImage pixel are copied starting at SrcImage->LowerX(),SrcImage->LowerY() in MyPixelField. SrcImage Pixel are clipped outside <me>. .
virtual Standard_EXPORT void | Fill (const Handle(Image_Image)&SrcImage, const Standard_Integer SrcX, const Standard_Integer SrcY, const Standard_Integer SrcWidth, const Standard_Integer SrcHeight, const Standard_Integer X, const Standard_Integer Y)=0
| Fill me with a SubImage of SrcImage starting from SrcX, SrcY to (SrcX+SrcWidth-1),(SrcY+SrcHeight-1) in Src Image coordinate. SrcImage SubImage pixels are copied starting at X,Y in MyPixelField. SrcImage Pixel are clipped outside <me>. .
virtual Standard_EXPORT void | Clear ()=0
| Fill the entire Image with the BackgroundPixel. .
virtual Standard_EXPORT Handle_Image_Image | Dup () const =0
| Duplicate an Image. .
virtual Standard_EXPORT void | Dump () const =0
| Debug .
Standard_EXPORT const | Handle (Standard_Type)&DynamicType() const

## Protected Member Functions

Standard_EXPORT | Image_Image (const Handle(Standard_Type)&aPixelType)
| Image constructor ,initialise the Image PixelType. .

## Private Attributes

Handle_Standard_Type | myPixelType

## Constructor & Destructor Documentation

Image_Image::~Image_Image | ( |  | ) | `[inline]`

Standard_EXPORT Image_Image::Image_Image | ( | const Handle(Standard_Type)& | aPixelType | ) | `[protected]`

## Member Function Documentation

virtual Standard_EXPORT void Image_Image::Clear | ( |  | ) | `[pure virtual]`

| Implemented in Image_DColorImage, and Image_DIndexedImage.

virtual Standard_EXPORT void Image_Image::Clip | ( | const Standard_Integer | X,
|  | const Standard_Integer | Y,
|  | const Standard_Integer | Width,
|  | const Standard_Integer | Height
| ) | `[pure virtual]`

| Implemented in Image_DColorImage, and Image_DIndexedImage.

virtual Standard_EXPORT void Image_Image::Destroy | ( |  | ) | `[virtual]`

| Reimplemented in Image_DColorImage, and Image_DIndexedImage.

virtual Standard_EXPORT void Image_Image::Dump | ( |  | ) | const`[pure virtual]`

| Implemented in Image_DColorImage, and Image_DIndexedImage.

virtual Standard_EXPORT Handle_Image_Image Image_Image::Dup | ( |  | ) | const`[pure virtual]`

| Implemented in Image_ColorImage, and Image_PseudoColorImage.

virtual Standard_EXPORT void Image_Image::Fill | ( | const Handle(Image_Image)& | SrcImage,
|  | const Standard_Integer | SrcX,
|  | const Standard_Integer | SrcY,
|  | const Standard_Integer | SrcWidth,
|  | const Standard_Integer | SrcHeight,
|  | const Standard_Integer | X,
|  | const Standard_Integer | Y
| ) | `[pure virtual]`

| Implemented in Image_DColorImage, and Image_DIndexedImage.

virtual Standard_EXPORT void Image_Image::Fill | ( | const Handle(Image_Image)& | SrcImage | ) | `[pure virtual]`

| Implemented in Image_DColorImage, and Image_DIndexedImage.

Standard_EXPORT const Image_Image::Handle | ( | Standard_Type |  | ) | const

| Reimplemented in Image_ColorImage, Image_DColorImage, Image_DIndexedImage, and Image_PseudoColorImage.

virtual Standard_EXPORT Standard_Integer Image_Image::Height | ( |  | ) | const`[pure virtual]`

| Implemented in Image_DColorImage, and Image_DIndexedImage.

virtual Standard_EXPORT void Image_Image::InternalDup | ( | const Handle(Image_Image)& | anImage | ) | `[pure virtual]`

| Implemented in Image_DColorImage, and Image_DIndexedImage.

virtual Standard_EXPORT Standard_Boolean Image_Image::isSamePixel | ( | const Standard_Integer | X,
|  | const Standard_Integer | Y,
|  | const Handle(Image_Image)& | anotherImage,
|  | const Standard_Integer | anotherX,
|  | const Standard_Integer | anotherY
| ) | const`[pure virtual]`

| Implemented in Image_DColorImage, and Image_DIndexedImage.

virtual Standard_EXPORT Standard_Integer Image_Image::LowerX | ( |  | ) | const`[pure virtual]`

| Implemented in Image_DColorImage, and Image_DIndexedImage.

virtual Standard_EXPORT Standard_Integer Image_Image::LowerY | ( |  | ) | const`[pure virtual]`

| Implemented in Image_DColorImage, and Image_DIndexedImage.

virtual Standard_EXPORT void Image_Image::Pixel | ( | const Standard_Integer | X,
|  | const Standard_Integer | Y,
|  | Image_PixelAddress & | aPixel
| ) | const`[pure virtual]`

| Implemented in Image_DColorImage, and Image_DIndexedImage.

virtual Standard_EXPORT void Image_Image::Pixel | ( | const Standard_Integer | X,
|  | const Standard_Integer | Y,
|  | Aspect_Pixel & | aPixel
| ) | const`[pure virtual]`

| Implemented in Image_DColorImage, and Image_DIndexedImage.

virtual Standard_EXPORT const Quantity_Color& Image_Image::PixelColor | ( | const Standard_Integer | X,
|  | const Standard_Integer | Y
| ) | const`[pure virtual]`

| Implemented in Image_ColorImage, and Image_PseudoColorImage.

Standard_EXPORT Handle_Standard_Type Image_Image::PixelType | ( |  | ) | const

virtual Standard_EXPORT void Image_Image::Resize | ( | const Standard_Real | XOffset,
|  | const Standard_Real | XScale,
|  | const Standard_Real | YOffset,
|  | const Standard_Real | YScale
| ) | `[pure virtual]`

| Implemented in Image_DColorImage, and Image_DIndexedImage.

virtual Standard_EXPORT void Image_Image::RowColor | ( | const Standard_Integer | Y,
|  | Quantity_Array1OfColor & | aArray1
| ) | const`[virtual]`

| Reimplemented in Image_PseudoColorImage.

virtual Standard_EXPORT Handle_Quantity_HArray1OfColor Image_Image::RowColor | ( | const Standard_Integer | Y | ) | const`[virtual]`

| Reimplemented in Image_PseudoColorImage.

virtual Standard_EXPORT void Image_Image::SetOrigin | ( | const Standard_Integer | x,
|  | const Standard_Integer | y
| ) | `[pure virtual]`

| Implemented in Image_DColorImage, and Image_DIndexedImage.

virtual Standard_EXPORT void Image_Image::SetPixel | ( | const Standard_Integer | X,
|  | const Standard_Integer | Y,
|  | const Image_PixelAddress & | aPixel
| ) | `[pure virtual]`

| Implemented in Image_DColorImage, and Image_DIndexedImage.

virtual Standard_EXPORT void Image_Image::SetPixel | ( | const Standard_Integer | X,
|  | const Standard_Integer | Y,
|  | const Aspect_Pixel & | aPixel
| ) | `[pure virtual]`

| Implemented in Image_DColorImage, and Image_DIndexedImage.

virtual Standard_EXPORT void Image_Image::Shift | ( | const Standard_Integer | XShift,
|  | const Standard_Integer | YShift
| ) | `[pure virtual]`

| Implemented in Image_DColorImage, and Image_DIndexedImage.

Standard_EXPORT Standard_Integer Image_Image::Size | ( |  | ) | const

virtual Standard_EXPORT void Image_Image::Transpose | ( | const Image_FlipType | aType | ) | `[pure virtual]`

| Implemented in Image_DColorImage, and Image_DIndexedImage.

virtual Standard_EXPORT Image_TypeOfImage Image_Image::Type | ( |  | ) | const`[pure virtual]`

| Implemented in Image_ColorImage, Image_DColorImage, Image_DIndexedImage, and Image_PseudoColorImage.

virtual Standard_EXPORT Standard_Integer Image_Image::UpperX | ( |  | ) | const`[pure virtual]`

| Implemented in Image_DColorImage, and Image_DIndexedImage.

virtual Standard_EXPORT Standard_Integer Image_Image::UpperY | ( |  | ) | const`[pure virtual]`

| Implemented in Image_DColorImage, and Image_DIndexedImage.

virtual Standard_EXPORT Standard_Integer Image_Image::Width | ( |  | ) | const`[pure virtual]`

| Implemented in Image_DColorImage, and Image_DIndexedImage.

## Field Documentation

Handle_Standard_Type Image_Image::myPixelType `[private]`

The documentation for this class was generated from the following file:

- Image_Image.hxx