oyImage_s Struct Reference

a reference struct to gather information for image transformation More...

#include <oyranos_alpha.h>

Collaboration diagram for oyImage_s:

Public Member Functions
oyPointer	oyImage_GetArray2dPointContinous (oyImage_s *image, int point_x, int point_y, int channel, int *is_allocated)
	standard continous layout pixel accessor
oyPointer	oyImage_GetArray2dLineContinous (oyImage_s *image, int point_y, int *height, int channel, int *is_allocated)
	standard continous layout line accessor
int	oyImage_SetArray2dPointContinous (oyImage_s *image, int point_x, int point_y, int channel, oyPointer data)
	standard continous layout pixel accessor
int	oyImage_SetArray2dLineContinous (oyImage_s *image, int point_x, int point_y, int pixel_n, int channel, oyPointer data)
	standard continous layout line accessor
oyPointer	oyImage_GetArray2dPointPlanar (oyImage_s *image, int point_x, int point_y, int channel, int *is_allocated)
	standard planar layout pixel accessor
oyPointer	oyImage_GetArray2dLinePlanar (oyImage_s *image, int point_y, int *height, int channel, int *is_allocated)
	standard continus layout line accessor
oyImage_s *	oyImage_Create (int width, int height, oyPointer channels, oyPixel_t pixel_layout, oyProfile_s *profile, oyObject_s object)
	collect infos about a image
oyImage_s *	oyImage_CreateForDisplay (int width, int height, oyPointer channels, oyPixel_t pixel_layout, const char *display_name, int display_pos_x, int display_pos_y, int display_width, int display_height, oyObject_s object)
	collect infos about a image for showing one a display
oyImage_s *	oyImage_Copy (oyImage_s *image, oyObject_s object)
	copy a image
int	oyImage_Release (oyImage_s **obj)
	release a image
int	oyImage_SetCritical (oyImage_s *image, oyPixel_t pixel_layout, oyProfile_s *profile, oyOptions_s *options)
	set a image
int	oyImage_DataSet (oyImage_s *image, oyStruct_s **pixel_data, oyImage_GetPoint_f getPoint, oyImage_GetLine_f getLine, oyImage_GetTile_f getTile, oyImage_SetPoint_f setPoint, oyImage_SetLine_f setLine, oyImage_SetTile_f setTile)
	set a custom image data module
int	oyImage_FillArray (oyImage_s *image, oyRectangle_s *rectangle, int allocate_method, oyArray2d_s **array, oyRectangle_s *array_rectangle, oyObject_s obj)
	creata a array from a image and fill with data
int	oyImage_ReadArray (oyImage_s *image, oyRectangle_s *image_rectangle, oyArray2d_s *array, oyRectangle_s *array_rectangle)
	read a array into a image
oyPixel_t	oyImage_PixelLayoutGet (oyImage_s *image)
	get the pixel layout
oyProfile_s *	oyImage_ProfileGet (oyImage_s *image)
	get the image profile
oyOptions_s *	oyImage_TagsGet (oyImage_s *image)
	get object tags
Data Fields
oyStruct_Copy_f	copy
oyStruct_Release_f	release
oyRectangle_s *	viewport
double	resolution_x
double	resolution_y
oyCHANNELTYPE_e *	channel_layout
int	width
int	height
oyOptions_s *	tags
oyStruct_s *	pixel_data
oyImage_GetPoint_f	getPoint
oyImage_GetLine_f	getLine
oyImage_GetTile_f	getTile
oyImage_SetPoint_f	setPoint
oyImage_SetLine_f	setLine
oyImage_SetTile_f	setTile
int	tile_width
int	tile_height
uint16_t	subsampling [2]
int	sub_positioning
oyStruct_s *	user_data

---

Detailed Description

a reference struct to gather information for image transformation

as we dont target a complete imaging solution, only raster is supported

Resolution is in pixel per centimeter.

Requirements:

• to provide a view on the image data we look at per line arrays
• it should be possible to echange the to be processed data without altering the context
• oyImage_s should hold image dimensions,
• display rectangle information and
• a reference to the data for conversion

To set a image data module use oyImage_DataSet().

Should oyImage_s become internal and we provide a user interface?

Version:

Oyranos: 0.1.8

Since:

2007/11/00 (Oyranos: 0.1.8)

Date:

2008/08/23

---

Field Documentation

oyCHANNELTYPE_e* oyImage_s::channel_layout

non profile described channels

Referenced by oyImage_Release().

oyStruct_Copy_f oyImage_s::copy

copy function

oyImage_GetLine_f oyImage_s::getLine

the line interface

Referenced by oyImage_DataSet(), oyImage_FillArray(), and oyImage_SetCritical().

oyImage_GetPoint_f oyImage_s::getPoint

the point interface

Referenced by oyImage_DataSet(), oyImage_FillArray(), and oyImage_SetCritical().

oyImage_GetTile_f oyImage_s::getTile

the tile interface

Referenced by oyImage_DataSet(), and oyImage_FillArray().

int oyImage_s::height

data height

Referenced by oyFilterPlug_s::oyFilterPlug_ResolveImage(), oyImage_Release(), oyImage_SetCritical(), and oyRectangle_s::oyRectangle_SamplesFromImage().

oyStruct_s* oyImage_s::pixel_data

struct used by each subsequent call of g/set* pixel acessors

Referenced by oyImage_DataSet(), oyImage_GetArray2dLineContinous(), oyImage_GetArray2dLinePlanar(), oyImage_GetArray2dPointContinous(), oyImage_GetArray2dPointPlanar(), oyImage_Release(), oyImage_SetArray2dLineContinous(), and oyImage_SetArray2dPointContinous().

oyStruct_Release_f oyImage_s::release

release function

Referenced by oyImage_Create().

double oyImage_s::resolution_x

resolution in horizontal direction

double oyImage_s::resolution_y

resolution in vertical direction

oyImage_SetLine_f oyImage_s::setLine

the line interface

Referenced by oyImage_DataSet(), oyImage_ReadArray(), and oyImage_SetCritical().

oyImage_SetPoint_f oyImage_s::setPoint

the point interface

Referenced by oyImage_DataSet(), and oyImage_SetCritical().

oyImage_SetTile_f oyImage_s::setTile

the tile interface

Referenced by oyImage_DataSet().

int oyImage_s::sub_positioning

0 None, 1 Postscript, 2 CCIR 601-1

uint16_t oyImage_s::subsampling[2]

1, 2 or 4

oyOptions_s* oyImage_s::tags

display_rectangle, display_name ...

Referenced by oyImage_CreateForDisplay(), oyImage_SetCritical(), and oyImage_TagsGet().

int oyImage_s::tile_height

needed by the tile interface

int oyImage_s::tile_width

needed by the tile interface

oyStruct_s* oyImage_s::user_data

user provided pointer

Referenced by oyImage_Release().

oyRectangle_s* oyImage_s::viewport

intented viewing area, normalised to the pixel width == 1.0

int oyImage_s::width

data width

Referenced by oyFilterPlug_s::oyFilterPlug_ResolveImage(), oyImage_FillArray(), oyImage_GetArray2dLinePlanar(), oyImage_ReadArray(), oyImage_Release(), oyImage_SetArray2dLineContinous(), oyImage_SetCritical(), and oyRectangle_s::oyRectangle_SamplesFromImage().