DIPlib Documentation - ©1995-2009 Quantitative Imaging Group, Delft University of Technology.

# ImageFileInformationNew

Allocate an Image File Information structure (in dipIO)

## SYNOPSIS

dip_Error dipio_ImageFileInformationNew ( newImInfo, name, filetype, datatype, dims, resources )

## FUNCTION

Allocates a `dipio_ImageFileInformation` structure. It must be freed through `ImageFileInformationFree`, unless a `resources` parameter is given, in which case it will be freed automatically when freeing the resources. This structure is usually allocated by `ImageFileGetInfo`.

This function will fill out some of the values in the structure with the values given on the command line. All of these can be 0.

## ARGUMENTS

Data type | Name | Description
`dipio_ImageFileInformation *` | `newImInfo` | Output structure
`dip_String` | `name` | Initial value for `name`
`dip_String` | `filetype` | Initial value for `filetype`
`dip_DataType` | `datatype` | Initial value for `datatype`
`dip_IntegerArray` | `dims` | Initial value for `dimensions`
`dip_Resources` | `resources` | Resources tracking structure. See `ResourcesNew`

The structure `dipio_ImageFileInformation` contains the following elements:

Data type | Name | Description
`dip_String` | `name` | File name
`dip_String` | `filetype` | File format string
`dip_DataType` | `datatype` | Data type of image
`dip_int` | `sigbits` | Significant bits
`dip_IntegerArray` | `dimensions` | Dimensions of image
`dipio_PhotometricInterpretation` | `photometric` | Color space
`dip_PhysicalDimensions` | `physDims` | Physical dimensions structure. See `PhysicalDimensionsNew`
`dip_int` | `numberOfImages` | Number of images in a TIFF file. If `filetype` is not "TIFF", this number is not set
`dip_StringArray` | `history` | History tags
`dip_Resources` | `resources` | Resource tracking; all elements within this structure are tracked here

The enumerator `dipio_PhotometricInterpretation` contains the following constants:

Name | Description
`DIPIO_PHM_GREYVALUE` | No colour information present; it's a grey-value image.
`DIPIO_PHM_RGB` | RGB image (the first three planes are red, green and blue)
`DIPIO_PHM_RGB_NONLINEAR` | Non-linear R'G'B' image (RGB channels to the power of 0.4)
`DIPIO_PHM_CMY` | CMY image (the first three planes are cyan, magenta and yellow)
`DIPIO_PHM_CMYK` | CMYK image (the first four planes are cyan, magenta, yellow and black)
`DIPIO_PHM_CIELUV` | CIE L*u'v' image (the first three planes are luminosity, u* and v*)
`DIPIO_PHM_CIELAB` | CIE L*a*b* image (the first three planes are luminosity, a* and b*)
`DIPIO_PHM_CIEXYZ` | CIE XYZ (the first three planes are X, Y and Z)
`DIPIO_PHM_CIEYXY` | CIE Yxy (the first three planes are Y, x and y)
`DIPIO_PHM_HCV` | HCV image (the first three planes are hue, chroma and value)
`DIPIO_PHM_HSV` | HSV image (the first three planes are hue, saturation and value)
`DIPIO_PHM_DEFAULT` | Same as `DIPIO_PHM_GREYVALUE`
`DIPIO_PHM_GENERIC` | Anything can be coded in the channels; the same as `DIPIO_PHM_CMYK`

Most file formats support only some of these.

## SEE ALSO

`ImageFileInformationFree`, `ImageFileGetInfo`, `PhysicalDimensionsNew`

DIPlib on-line documentation | Function reference | Global function index