2d data array More...

#include <oyArray2d_s.h>

Inheritance diagram for oyArray2d_s:

Collaboration diagram for oyArray2d_s:

Public Member Functions
OYAPI oyArray2d_s *OYEXPORT	oyArray2d_New (oyObject_s object)
	allocate a new Array2d object More...

OYAPI oyArray2d_s *OYEXPORT	oyArray2d_Copy (oyArray2d_s *array2d, oyObject_s object)
	Copy or Reference a Array2d object. More...

OYAPI int OYEXPORT	oyArray2d_Release (oyArray2d_s **array2d)
	release and possibly deallocate a oyArray2d_s object More...

OYAPI oyArray2d_s *OYEXPORT	oyArray2d_Create (oyPointer data, int width, int height, oyDATATYPE_e data_type, oyObject_s object)
	Allocate and initialise a oyArray2d_s object. More...

OYAPI oyPointer OYEXPORT	oyArray2d_GetData (oyArray2d_s *obj)
	Get the data blob. More...

OYAPI int OYEXPORT	oyArray2d_SetData (oyArray2d_s *obj, oyPointer data)
	Set the data blob and (re-)initialise the object. More...

OYAPI int OYEXPORT	oyArray2d_SetRows (oyArray2d_s obj, oyPointer rows, int do_copy)
	Set the data and (re-)initialise the object. More...

int	oyArray2d_SetFocus (oyArray2d_s array, oyRectangle_s rectangle)
	Move a arrays active area to a given rectangle. More...

OYAPI int OYEXPORT	oyArray2d_Reset (oyArray2d_s *array, int width, int height, oyDATATYPE_e data_type)
	Reinitialise Array. More...

OYAPI double OYEXPORT	oyArray2d_GetDataGeo1 (oyArray2d_s *array, int x_y_w_h)
	Get Geometry of the data rectangle. More...

OYAPI int OYEXPORT	oyArray2d_GetWidth (oyArray2d_s *array)
	Get data Width. More...

OYAPI int OYEXPORT	oyArray2d_GetHeight (oyArray2d_s *array)
	Get data Height. More...

OYAPI oyDATATYPE_e OYEXPORT	oyArray2d_GetType (oyArray2d_s *array)
	Get data Type. More...

OYAPI const char *OYEXPORT	oyArray2d_Show (oyArray2d_s *array, int channels)
	Print array geometries. More...

void	oyArray2d_Release__Members (oyArray2d_s_ *array2d)
	Custom Array2d destructor. More...

int	oyArray2d_Init__Members (oyArray2d_s_ *array2d OY_UNUSED)
	Custom Array2d constructor. More...

int	oyArray2d_Copy__Members (oyArray2d_s_ dst, oyArray2d_s_ src)
	Custom Array2d copy constructor. More...

int	oyArray2d_Init_ (oyArray2d_s_ *s, int width, int height, oyDATATYPE_e data_type)
	Initialise Array. More...

oyArray2d_s_ *	oyArray2d_Create_ (int width, int height, oyDATATYPE_e data_type, oyObject_s object)
	Allocate and initialise a oyArray2d_s object widthout pixel. More...

int	oyArray2d_ReleaseArray_ (oyArray2d_s *obj)
	Release Array2d::array member. More...

int	oyArray2d_ToPPM_ (oyArray2d_s_ array, const char file_name)
	Dump array to a netppm file. More...

Public Member Functions inherited from oyStruct_s
const char *	oyStruct_GetTextFromModule (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags)
	get object infos from a module More...

const char *	oyStruct_GetText (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags)
	Get a text dump. More...

int	oyStruct_RegisterStaticMessageFunc (int type, oyStruct_RegisterStaticMessageFunc_f msg, oyStruct_RegisterStaticFreeFunc_f free_func)
	register a function for verbosity More...

const char *	oyStruct_GetInfo (oyPointer context_object, oyNAME_e type, int flags)
	get a additional string from a object More...

const char *	oyStructTypeToText (oyOBJECT_e type)
	Objects type to small string. More...

Data Fields
const oyOBJECT_e	type_
	Type of object. More...

oyStruct_Copy_f	copy
	Copy function. More...

oyStruct_Release_f	release
	Release function. More...

oyObject_s	oy_
	Oyranos internal object. More...

Data Fields inherited from oyStruct_s
const oyOBJECT_e	type_
	Type of object. More...

oyStruct_Copy_f	copy
	Copy function. More...

oyStruct_Release_f	release
	Release function. More...

oyObject_s	oy_
	Oyranos internal object. More...

Detailed Description

2d data array

oyArray2d_s is a in memory data view. The array2d holds pointers to lines in the original memory blob. The arrays contained in array2d represent the samples. There is no information in which order the samples appear. No pixel layout or meaning is provided. Given the coordinates x and y, a samples memory adress can be accessed by &array2d[y][x] . This adress must be converted to the data type provided in oyArray2d_s::t.

The oyArray2d_s::data pointer should be observed in order to be signaled about its invalidation.

Version: Oyranos: 0.1.8

Since: 2008/08/23 (Oyranos: 0.1.8)

Date: 2008/08/23

Examples:: oyranos_cmm_oJPG.c.

Member Function Documentation

◆ oyArray2d_Copy()

OYAPI oyArray2d_s *OYEXPORT oyArray2d_Copy	(	oyArray2d_s *	array2d,
		oyObject_s	object
	)

Copy or Reference a Array2d object.

Function oyArray2d_Copy

The function is for copying and for referencing. The reference is the most often used way, which saves resourcs and time.

Parameters

[in]	array2d	Array2d struct object
	object	NULL - means reference, the optional object triggers a real copy

◆ oyArray2d_Copy__Members()

int oyArray2d_Copy__Members	(	oyArray2d_s_ *	dst,
		oyArray2d_s_ *	src
	)

Custom Array2d copy constructor.

Function oyArray2d_Copy__Members

◆ oyArray2d_Create()

OYAPI oyArray2d_s *OYEXPORT oyArray2d_Create	(	oyPointer	data,
		int	width,
		int	height,
		oyDATATYPE_e	data_type,
		oyObject_s	object
	)

Allocate and initialise a oyArray2d_s object.

Function oyArray2d_Create

Version: Oyranos: 0.1.8

Since: 2008/08/23 (Oyranos: 0.1.8)

Date: 2008/08/23

◆ oyArray2d_Create_()

oyArray2d_s_ * oyArray2d_Create_	(	int	width,
		int	height,
		oyDATATYPE_e	data_type,
		oyObject_s	object
	)

Allocate and initialise a oyArray2d_s object widthout pixel.

Function oyArray2d_Create_

◆ oyArray2d_GetData()

OYAPI oyPointer OYEXPORT oyArray2d_GetData ( oyArray2d_s * obj )

Get the data blob.

Function oyArray2d_GetData

Parameters

[in,out] obj struct object

Returns: the data, remains in the property of the object

Version: Oyranos: 0.5.0

Date: 2012/09/25

Since: 2012/09/25 (Oyranos: 0.5.0)

◆ oyArray2d_GetDataGeo1()

OYAPI double OYEXPORT oyArray2d_GetDataGeo1	(	oyArray2d_s *	array,
		int	x_y_w_h
	)

Get Geometry of the data rectangle.

Function oyArray2d_GetDataGeo1

The function informs about reserves and possible offsets.

Parameters

[in,out]	array	the channels array
[in]	x_y_w_h	dimension selector

Returns: the position or dimension

Version: Oyranos: 0.5.0

Date: 2012/10/05

Since: 2012/10/03 (Oyranos: 0.5.0)

◆ oyArray2d_GetHeight()

OYAPI int OYEXPORT oyArray2d_GetHeight ( oyArray2d_s * array )

Get data Height.

Function oyArray2d_GetHeight

Parameters

[in,out] array the channels array

Returns: the height

Version: Oyranos: 0.5.0

Date: 2012/10/05

Since: 2012/10/05 (Oyranos: 0.5.0)

◆ oyArray2d_GetType()

OYAPI oyDATATYPE_e OYEXPORT oyArray2d_GetType ( oyArray2d_s * array )

Get data Type.

Function oyArray2d_GetType

Parameters

[in,out] array the channels array

Returns: the data type

Version: Oyranos: 0.9.0

Date: 2012/10/11

Since: 2012/10/11 (Oyranos: 0.9.0)

◆ oyArray2d_GetWidth()

OYAPI int OYEXPORT oyArray2d_GetWidth ( oyArray2d_s * array )

Get data Width.

Function oyArray2d_GetWidth

Parameters

[in,out] array the channels array

Returns: the width

Version: Oyranos: 0.5.0

Date: 2012/10/05

Since: 2012/10/05 (Oyranos: 0.5.0)

◆ oyArray2d_Init_()

int oyArray2d_Init_	(	oyArray2d_s_ *	s,
		int	width,
		int	height,
		oyDATATYPE_e	data_type
	)

Initialise Array.

Function oyArray2d_Init_

Version: Oyranos: 0.9.0

Since: 2012/10/20 (Oyranos: 0.9.0)

Date: 2012/10/20

◆ oyArray2d_Init__Members()

int oyArray2d_Init__Members ( oyArray2d_s_ *array2d OY_UNUSED )

Custom Array2d constructor.

Function oyArray2d_Init__Members

◆ oyArray2d_New()

OYAPI oyArray2d_s *OYEXPORT oyArray2d_New ( oyObject_s object )

allocate a new Array2d object

Function oyArray2d_New

◆ oyArray2d_Release()

OYAPI int OYEXPORT oyArray2d_Release ( oyArray2d_s ** array2d )

release and possibly deallocate a oyArray2d_s object

Function oyArray2d_Release

Parameters

[in,out] array2d Array2d struct object

◆ oyArray2d_Release__Members()

void oyArray2d_Release__Members ( oyArray2d_s_ * array2d )

Custom Array2d destructor.

Function oyArray2d_Release__Members

◆ oyArray2d_ReleaseArray_()

int oyArray2d_ReleaseArray_ ( oyArray2d_s * obj )

Release Array2d::array member.

Function oyArray2d_ReleaseArray_

Parameters

[in,out] obj struct object

Version: Oyranos: 0.9.1

Date: 2012/11/02

Since: 2010/09/07 (Oyranos: 0.1.11)

◆ oyArray2d_Reset()

OYAPI int OYEXPORT oyArray2d_Reset	(	oyArray2d_s *	array,
		int	width,
		int	height,
		oyDATATYPE_e	data_type
	)

Reinitialise Array.

Function oyArray2d_Reset

Version: Oyranos: 0.9.0

Since: 2012/10/20 (Oyranos: 0.9.0)

Date: 2012/10/20

◆ oyArray2d_SetData()

OYAPI int OYEXPORT oyArray2d_SetData	(	oyArray2d_s *	obj,
		oyPointer	data
	)

Set the data blob and (re-)initialise the object.

Function oyArray2d_SetData

Parameters

[in,out]	obj	struct object
[in]	data	the data, remains in the property of the caller

Version: Oyranos: 0.1.8

Since: 2008/08/23 (Oyranos: 0.1.8)

Date: 2008/08/23

◆ oyArray2d_SetFocus()

int oyArray2d_SetFocus	(	oyArray2d_s *	array,
		oyRectangle_s *	rectangle
	)

Move a arrays active area to a given rectangle.

Function oyArray2d_SetFocus

The array works in absolute coordinates. For working in relative coordinates get first the current data_area by oyArray2d_GetDataGeo1().

Parameters

[in,out]	array	the channels array
[in]	rectangle	the new region in the array's wholes data

Returns: 0 - success, 1 - error, -1 - focus changed

Version: Oyranos: 0.9.6

Date: 2016/09/15

Since: 2011/04/19 (Oyranos: 0.3.0)

◆ oyArray2d_SetRows()

OYAPI int OYEXPORT oyArray2d_SetRows	(	oyArray2d_s *	obj,
		oyPointer *	rows,
		int	do_copy
	)

Set the data and (re-)initialise the object.

Function oyArray2d_SetRows

Parameters

[in,out]	obj	struct object
[in]	rows	the data
[in]	do_copy	- 0 : take the memory as is 1 : copy the memory monolithic 2 : copy the memory chunky

Version: Oyranos: 0.1.11

Since: 2010/09/07 (Oyranos: 0.1.11)

Date: 2010/09/07

◆ oyArray2d_Show()

OYAPI const char *OYEXPORT oyArray2d_Show	(	oyArray2d_s *	array,
		int	channels
	)

Print array geometries.

Function oyArray2d_Show

This function is not thread safe.

Parameters

[in]	array	the channel array
[in]	channels	the channel count

Returns: a description string

Version: Oyranos: 0.9.7

Date: 2017/10/11

Since: 2016/09/26 (Oyranos: 0.9.6)

◆ oyArray2d_ToPPM_()

int oyArray2d_ToPPM_	(	oyArray2d_s_ *	array,
		const char *	file_name
	)

Dump array to a netppm file.

Function oyArray2d_ToPPM_

Field Documentation

◆ copy

oyStruct_Copy_f oyArray2d_s::copy

Copy function.

◆ oy_

oyObject_s oyArray2d_s::oy_

Oyranos internal object.

Features name and hash. Do not change during object life time.

◆ release

oyStruct_Release_f oyArray2d_s::release

Release function.

◆ type_

const oyOBJECT_e oyArray2d_s::type_

Type of object.

The struct type tells Oyranos how to interprete hidden fields.

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ oyArray2d_Copy()

◆ oyArray2d_Copy__Members()

◆ oyArray2d_Create()

◆ oyArray2d_Create_()

◆ oyArray2d_GetData()

◆ oyArray2d_GetDataGeo1()

◆ oyArray2d_GetHeight()

◆ oyArray2d_GetType()

◆ oyArray2d_GetWidth()

◆ oyArray2d_Init_()

◆ oyArray2d_Init__Members()

◆ oyArray2d_New()

◆ oyArray2d_Release()

◆ oyArray2d_Release__Members()

◆ oyArray2d_ReleaseArray_()

◆ oyArray2d_Reset()

◆ oyArray2d_SetData()

◆ oyArray2d_SetFocus()

◆ oyArray2d_SetRows()

◆ oyArray2d_Show()

◆ oyArray2d_ToPPM_()

Field Documentation

◆ copy

◆ oy_

◆ release

◆ type_