DLImageHead Class Reference

Image header object for DLImage. More...

#include <DLImageHead.h>

List of all members.

Public Types

enum  DLBitDepths { DL_BITDEPTH_UNKNOWN = -1, DL_BITDEPTH_1 = 1, DL_BITDEPTH_8 = 8, DL_BITDEPTH_24 = 24 }
enum  DLDataAlignments { DL_UNKNOWN_ALIGN = -1, DL_1BYTE_ALIGN = 1, DL_4BYTE_ALIGN = 4 }

Public Member Functions

 DLImageHead ()
 DLImageHead (const DLImageHead &orig)
const DLImageHeadoperator= (const DLImageHead &right)
virtual ~DLImageHead ()
int dlGetRowSize () const
 
Returns:
Number of bytes used to store the raw data for each row of this image.


Public Attributes

DLTagList imageTags
 image tags
int width
 image width
int height
 image height
DLBitDepths depth
 image bit depth
int channels
 image channels
DLColor::DLColorTypes colorModel
 image color model
int rowSize
 image row size
DLDataAlignments dataAlignment
 image data alignment
int dataOrder
 Not currently used.
float horizontalResolution
 horizontal resolution
float verticalResolution
 vertical resolution
bool resolutionFlag
 image resolution flag


Detailed Description

Image header object for DLImage.

The DLImageHead class holds all of the generic image header information needed to perform image processing functions

Definition at line 14 of file DLImageHead.h.


Member Enumeration Documentation

enum DLImageHead::DLBitDepths

A selection of possible image bit depths

Enumerator:
DL_BITDEPTH_UNKNOWN 
DL_BITDEPTH_1 
DL_BITDEPTH_8 
DL_BITDEPTH_24 

Definition at line 30 of file DLImageHead.h.

enum DLImageHead::DLDataAlignments

A selection of possible data alignments

Enumerator:
DL_UNKNOWN_ALIGN 
DL_1BYTE_ALIGN 
DL_4BYTE_ALIGN 

Definition at line 41 of file DLImageHead.h.


Constructor & Destructor Documentation

DLImageHead::DLImageHead (  ) 

DLImageHead Default Constructor

DLImageHead::DLImageHead ( const DLImageHead orig  ) 

DLImageHead Copy Constructor

virtual DLImageHead::~DLImageHead (  )  [virtual]

DLImageHead destructor


Member Function Documentation

const DLImageHead& DLImageHead::operator= ( const DLImageHead right  ) 

Assignment operator

Parameters:
right DLImageHead

int DLImageHead::dlGetRowSize (  )  const [inline]

Returns:
Number of bytes used to store the raw data for each row of this image.

Definition at line 135 of file DLImageHead.h.

References depth, DL_BITDEPTH_1, DL_BITDEPTH_24, DL_BITDEPTH_8, and width.


Member Data Documentation

DLTagList DLImageHead::imageTags

image tags

A set of user-defined tags containing image metadata.

Definition at line 62 of file DLImageHead.h.

Referenced by DLImage::dlClearTags(), DLImage::dlFindTag(), DLImage::dlGetTagListBegin(), DLImage::dlGetTagListEnd(), and DLImage::dlIsTagListEmpty().

int DLImageHead::width

image width

Definition at line 65 of file DLImageHead.h.

Referenced by dlGetRowSize(), and DLImage::dlGetWidth().

int DLImageHead::height

image height

Definition at line 68 of file DLImageHead.h.

Referenced by DLImage::dlGetHeight().

DLBitDepths DLImageHead::depth

image bit depth

Number of bits per image pixel; can be one of:

Definition at line 78 of file DLImageHead.h.

Referenced by DLImage::dlGetDepth(), and dlGetRowSize().

int DLImageHead::channels

image channels

Number of data channels in the image; usually 3 for 24-bit color RGB images, and 1 for binary, grayscale or palettized images.

Definition at line 84 of file DLImageHead.h.

Referenced by DLImage::dlGetChannels().

DLColor::DLColorTypes DLImageHead::colorModel

image color model

Can be one of:

Definition at line 95 of file DLImageHead.h.

Referenced by DLImage::dlGetColorModel().

int DLImageHead::rowSize

image row size

Number of bytes needed to store the raw data of a single row of the image.

Definition at line 100 of file DLImageHead.h.

Referenced by DLImage::dlGetRowSize().

DLDataAlignments DLImageHead::dataAlignment

image data alignment

Can be either:

Definition at line 109 of file DLImageHead.h.

Referenced by DLImage::dlGetDataAlignment().

int DLImageHead::dataOrder

Not currently used.

Definition at line 112 of file DLImageHead.h.

Referenced by DLImage::dlGetDataOrder().

float DLImageHead::horizontalResolution

horizontal resolution

Measurement units are indicated by DLImageHead::resolutionFlag.

Definition at line 117 of file DLImageHead.h.

Referenced by DLImage::dlGetHorizontalResolution(), and DLImage::dlSetHorizontalResolution().

float DLImageHead::verticalResolution

vertical resolution

Measurement units are indicated by DLImageHead::resolutionFlag.

Definition at line 122 of file DLImageHead.h.

Referenced by DLImage::dlGetVerticalResolution(), and DLImage::dlSetVerticalResolution().

bool DLImageHead::resolutionFlag

image resolution flag

Indicates the units of measurement for the image resolution values. Upon opening an image of any format containing resolution information, DOCLIB automatically converts the resolution to dots-per-inch (or unitless, if the image does not indicate the units used).

Definition at line 132 of file DLImageHead.h.

Referenced by DLImage::dlGetResolutionFlag(), and DLImage::dlSetResolutionFlag().


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

DOCLIB is being developed under contract by a collaboration between:
The Laboratory for Language and Media Processing
Unviersity of Maryland, College Park
and
Booz | Allen | Hamilton

All Rights Reserved, 2003-2007