Generic File and Image Header Information. More...

#include <DPXHeader.h>

Inheritance diagram for dpx::GenericHeader:

Collaboration diagram for dpx::GenericHeader:

Public Member Functions
	GenericHeader ()
	Constructor.
void	Reset ()
	Reset class to initial state.
int	ImageElementCount () const
	Number of Active Elements in the Image.
void	CalculateNumberOfElements ()
	Set member numberOfElements based on channel structure.
int	ImageElementComponentCount (const int element) const
	Number of components for the element.
DataSize	ComponentDataSize (const int element) const
	DataSize required for individual image element components.
int	ComponentByteCount (const int element) const
	Byte count of data element components.
File Information Methods
U32	MagicNumber () const
	Get magic number, used for byte ordering identification.
U32	ImageOffset () const
	Get the offset in bytes to the start of the first image element.
void	SetImageOffset (const U32 offset)
	Set the offset in bytes to the start of the first image element.
void	Version (char *v) const
	Get current version string of header.
void	SetVersion (const char *v)
	Set the version string.
U32	FileSize () const
	Get the size of the entire file.
void	SetFileSize (const U32 fs)
	Set the size of the entire file.
U32	DittoKey () const
	Get the ditto key.
void	SetDittoKey (const U32 key)
	Set the ditto key.
U32	GenericSize () const
	Get the size of the generic section within the header.
U32	IndustrySize () const
	Get the size of the industry section within the header.
U32	UserSize () const
	Get the size of the user data.
void	SetUserSize (const U32 size)
	Set the size of the user data.
void	FileName (char *fn) const
	Get the file name.
void	SetFileName (const char *fn)
	Set the file name.
void	CreationTimeDate (char *ct) const
	Get the creation time/date.
void	SetCreationTimeDate (const char *ct)
	Set the creation time/date.
void	SetCreationTimeDate (const long secs)
	Set the creation time/date.
void	Creator (char *creat) const
	Get the creator.
void	SetCreator (const char *creat)
	Set the creator.
void	Project (char *prj) const
	Get the project.
void	SetProject (const char *prj)
	Set the project.
void	Copyright (char *copy) const
	Get the copyright information.
void	SetCopyright (const char *copy)
	Set the copyright information.
U32	EncryptKey () const
	Get the encryption key (no encryption is 0xffffffff)
void	SetEncryptKey (const U32 key)
	Set the encryption key (no encryption is 0xffffffff)
Image Information Methods
Orientation	ImageOrientation () const
	Get the image orientation.
void	SetImageOrientation (const Orientation orient)
	Set the image orientation.
U16	NumberOfElements () const
	Get the number of elements.
void	SetNumberOfElements (const U16 num)
	Set the number of elements.
U32	PixelsPerLine () const
	Get the pixels per line.
void	SetPixelsPerLine (const U32 ppl)
	Set the pixels per line.
U32	LinesPerElement () const
	Get the lines per element.
void	SetLinesPerElement (const U32 lpe)
	Set the lines per element.
U32	DataSign (const int i) const
	Get the data sign (0 = unsigned, 1 = signed)
void	SetDataSign (const int i, const U32 sign)
	Set the data sign (0 = unsigned, 1 = signed)
U32	LowData (const int i) const
	Get the minimum data value.
void	SetLowData (const int i, const U32 data)
	Set the minimum data value.
R32	LowQuantity (const int i) const
	Get the quantity of minimum data value.
void	SetLowQuantity (const int i, const R32 quant)
	Set the quantity of minimum data value.
U32	HighData (const int i) const
	Get the maximum data value.
void	SetHighData (const int i, const U32 data)
	Set the maximum data value.
R32	HighQuantity (const int i) const
	Get the quantity of maximum data value.
void	SetHighQuantity (const int i, const R32 quant)
	Set the quantity of maximum data value.
Descriptor	ImageDescriptor (const int i) const
	Get the component defintion.
void	SetImageDescriptor (const int i, const Descriptor desc)
	Set the component defintion.
Characteristic	Transfer (const int i) const
	Get the amplitude transfer function.
void	SetTransfer (const int i, const Characteristic ch)
	Set the amplitude transfer function.
Characteristic	Colorimetric (const int i) const
	Get the color reference.
void	SetColorimetric (const int i, const Characteristic c)
	Set the color reference.
U8	BitDepth (const int i) const
	Get the bit size of each component.
void	SetBitDepth (const int i, const U8 depth)
	Set the bit size of each component.
Packing	ImagePacking (const int i) const
	Get the data packing mode.
void	SetImagePacking (const int i, const Packing pack)
	Set the data packing mode.
Encoding	ImageEncoding (const int i) const
	Get the encoding method.
void	SetImageEncoding (const int i, const Encoding enc)
	Set the encoding method.
U32	DataOffset (const int i) const
	Get the offset to element.
void	SetDataOffset (const int i, const U32 offset)
	Set the offset to element.
U32	EndOfLinePadding (const int i) const
	Get the number of bytes padding the end of each line.
void	SetEndOfLinePadding (const int i, const U32 eolp)
	Set the number of bytes padding the end of each line.
U32	EndOfImagePadding (const int i) const
	Get the number of bytes padding the end of the image element.
void	SetEndOfImagePadding (const int i, const U32 eoip)
	Set the number of bytes padding the end of the image element.
void	Description (const int i, char *desc) const
	Get the element description.
void	SetDescription (const int i, const char *desc)
	Set the element description.
Image Origination Methods
U32	XOffset () const
	Get the line offset (in pixels) from the first pixel in original image.
void	SetXOffset (const U32 offset)
	Set the line offset (in pixels) from the first pixel in original image.
U32	YOffset () const
	Get the frame offset (in lines) from the first line in original image.
void	SetYOffset (const U32 offset)
	Set the frame offset (in lines) from the first line in original image.
R32	XCenter () const
	Get the X image center in pixels.
void	SetXCenter (const R32 center)
	Set the X image center in pixels.
R32	YCenter () const
	Get the Y image center in pixels.
void	SetYCenter (const R32 center)
	Set the Y image center in pixels.
U32	XOriginalSize () const
	Get the number of pixels per line in the original image.
void	SetXOriginalSize (const U32 size)
	GSt the number of pixels per line in the original image.
U32	YOriginalSize () const
	Get the number of lines per image in the original image.
void	SetYOriginalSize (const U32 size)
	Set the number of lines per image in the original image.
void	SourceImageFileName (char *fn) const
	Get the source image file name that this image was extracted.
void	SetSourceImageFileName (const char *fn)
	Set the source image file name that this image was extracted.
void	SourceTimeDate (char *td) const
	Get the source image time and date that this image was extracted.
void	SetSourceTimeDate (const char *td)
	Set the source image time and date that this image was extracted.
void	SetSourceTimeDate (const long secs)
	Set the source image time and date that this image was extracted.
void	InputDevice (char *dev) const
	Get the input device name.
void	SetInputDevice (const char *dev)
	Set the input device name.
void	InputDeviceSerialNumber (char *sn) const
	Get the input device serial number.
void	SetInputDeviceSerialNumber (const char *sn)
	Set the input device serial number.
U16	Border (const int i) const
	Get the pixel offset for the border region.
void	SetBorder (const int i, const U16 bord)
	Set the pixel offset for the border region.
U32	AspectRatio (const int i) const
	Get the pixel aspect ratio (horizontal:vertical)
void	SetAspectRatio (const int i, const U32 ar)
	Set the pixel aspect ratio (horizontal:vertical)
R32	XScannedSize () const
	Get the horizontal size of the original scanned optical image.
void	SetXScannedSize (const R32 size)
	Set the horizontal size of the original scanned optical image.
R32	YScannedSize () const
	Get the vertical size of the original scanned optical image.
void	SetYScannedSize (const R32 size)
	Set the vertical size of the original scanned optical image.
Static Public Member Functions
static int	DataSizeByteCount (const DataSize ds)
Data Fields
File Information Members
U32	magicNumber
	Indicates start of DPX image file and is used to determine byte order.
U32	imageOffset
	Offset to image data (in bytes)
ASCII	version [8]
	Version number of header format.
U32	fileSize
	Total file size (in bytes)
U32	dittoKey
	Ditto Key (0 = same as previous frame, 1 = new)
U32	genericSize
	Generic Header length (in bytes)
U32	industrySize
	Industry Header length (in bytes)
U32	userSize
	User defined header length (in bytes)
ASCII	fileName [100]
	File name.
ASCII	creationTimeDate [24]
	Create date time /see DateTimeFormat.
ASCII	creator [100]
	Creator.
ASCII	project [200]
	Project name.
ASCII	copyright [200]
	Copyright statement.
U32	encryptKey
	Encryption Key (0xffffffff if unencrypted)
ASCII	reserved1 [104]
	Reserved.
Image Information Members
U16	imageOrientation
	Image orientation.
U16	numberOfElements
	Number of elements (1-8)
U32	pixelsPerLine
	Pixels per line.
U32	linesPerElement
	Lines per element.
ImageElement	chan [MAX_ELEMENTS]
	Image element data structures.
ASCII	reserved2 [52]
	Reserved.
Image Origination Members
U32	xOffset
	X offset.
U32	yOffset
	Y offset.
R32	xCenter
	X center.
R32	yCenter
	Y center.
U32	xOriginalSize
	X original size.
U32	yOriginalSize
	Y original size.
ASCII	sourceImageFileName [100]
	Source image file name.
ASCII	sourceTimeDate [24]
	Source date and time /see DateTimeFormat.
ASCII	inputDevice [32]
	Input device name.
ASCII	inputDeviceSerialNumber [32]
	Input device serial number.
U16	border [4]
	Border validity.
U32	aspectRatio [2]
	Pixel aspect ratio (horizontal:vertical)
R32	xScannedSize
	X scanned size.
R32	yScannedSize
	Y scanned size.
ASCII	reserved3 [20]
	Reserved.

Detailed Description

Generic File and Image Header Information.

Definition at line 293 of file DPXHeader.h.

Constructor & Destructor Documentation

dpx::GenericHeader::GenericHeader ( )

Constructor.

Definition at line 71 of file DPXHeader.cpp.

Member Function Documentation

U32 dpx::GenericHeader::AspectRatio ( const int i ) const [inline]

Get the pixel aspect ratio (horizontal:vertical)

Parameters:

i	aspect ratio index (0-1)

Returns:: ratio quantity

Definition at line 2030 of file DPXHeader.h.

References aspectRatio.

U8 dpx::GenericHeader::BitDepth ( const int i ) const [inline]

Get the bit size of each component.

Parameters:

i	element index (0-7)

Returns:: bit size

Definition at line 1801 of file DPXHeader.h.

References dpx::ImageElement::bitDepth, chan, and MAX_ELEMENTS.

Referenced by dpx::ElementReadStream::EndianDataCheck(), dpx::RunLengthEncoding::Read(), dpx::Codec::Read(), dpx::ReadImageBlock(), and dpx::ReadPacked().

U16 dpx::GenericHeader::Border ( const int i ) const [inline]

Get the pixel offset for the border region.

There are 4 border pixel offsets that define a region -- X-left, X-right, Y-top, Y-bottom

Parameters:

i	border index (0-3)

Returns:: offset in pixels

Definition at line 2015 of file DPXHeader.h.

References border.

void dpx::GenericHeader::CalculateNumberOfElements ( )

Set member numberOfElements based on channel structure.

Definition at line 519 of file DPXHeader.cpp.

Characteristic dpx::GenericHeader::Colorimetric ( const int i ) const [inline]

Get the color reference.

Parameters:

i	element index (0-7)

Returns:: colorimetric specification

Definition at line 1787 of file DPXHeader.h.

References chan, and MAX_ELEMENTS.

int dpx::GenericHeader::ComponentByteCount ( const int element ) const

Byte count of data element components.

Returns:: byte count

Definition at line 579 of file DPXHeader.cpp.

References dpx::kByte, and MAX_ELEMENTS.

Referenced by dpx::RunLengthEncoding::Read(), and dpx::ReadBlockTypes().

dpx::DataSize dpx::GenericHeader::ComponentDataSize ( const int element ) const

DataSize required for individual image element components.

Returns:: datasize of element

Definition at line 546 of file DPXHeader.cpp.

References dpx::kByte, dpx::kDouble, dpx::kFloat, dpx::kWord, and MAX_ELEMENTS.

Referenced by dpx::ReadImageBlock().

void dpx::GenericHeader::Copyright ( char * copy ) const [inline]

Get the copyright information.

Parameters:

copy	buffer to store copyright string (200+1 chars)

Definition at line 1627 of file DPXHeader.h.

References copyright.

void dpx::GenericHeader::CreationTimeDate ( char * ct ) const [inline]

Get the creation time/date.

Parameters:

ct	buffer to store creation time/date (24+1 chars)

Definition at line 1594 of file DPXHeader.h.

References creationTimeDate.

void dpx::GenericHeader::Creator ( char * creat ) const [inline]

Get the creator.

Parameters:

creat buffer to store creator (100+1 chars)

Definition at line 1605 of file DPXHeader.h.

References creator.

U32 dpx::GenericHeader::DataOffset ( const int i ) const [inline]

Get the offset to element.

Parameters:

i	element index (0-7)

Returns:: offset in bytes from the start of the file

Definition at line 1850 of file DPXHeader.h.

References chan, dpx::ImageElement::dataOffset, and MAX_ELEMENTS.

Referenced by dpx::ElementReadStream::Read(), dpx::RunLengthEncoding::Read(), and dpx::ElementReadStream::ReadDirect().

U32 dpx::GenericHeader::DataSign ( const int i ) const [inline]

Get the data sign (0 = unsigned, 1 = signed)

Parameters:

i	element index (0-7)

Returns:: data sign

Definition at line 1689 of file DPXHeader.h.

References chan, dpx::ImageElement::dataSign, and MAX_ELEMENTS.

int dpx::GenericHeader::DataSizeByteCount ( const DataSize ds ) [static]

Definition at line 612 of file DPXHeader.cpp.

References dpx::kByte, dpx::kDouble, dpx::kFloat, dpx::kInt, and dpx::kWord.

Referenced by dpx::WriteBuffer(), and dpx::WriteFloatBuffer().

void dpx::GenericHeader::Description	(	const int	i,
		char *	desc
	)		const `[inline]`

Get the element description.

Parameters:

i	element index (0-7)
desc	buffer to write description string (32+1 chars)

Definition at line 1896 of file DPXHeader.h.

References chan, and MAX_ELEMENTS.

U32 dpx::GenericHeader::DittoKey ( ) const [inline]

Get the ditto key.

Returns:: ditto key

Definition at line 1553 of file DPXHeader.h.

References dittoKey.

U32 dpx::GenericHeader::EncryptKey ( ) const [inline]

Get the encryption key (no encryption is 0xffffffff)

Returns:: encryption key

Definition at line 1638 of file DPXHeader.h.

References encryptKey.

U32 dpx::GenericHeader::EndOfImagePadding ( const int i ) const [inline]

Get the number of bytes padding the end of the image element.

Parameters:

i	element index (0-7)

Returns:: count

Definition at line 1880 of file DPXHeader.h.

References chan, dpx::ImageElement::endOfImagePadding, and MAX_ELEMENTS.

U32 dpx::GenericHeader::EndOfLinePadding ( const int i ) const [inline]

Get the number of bytes padding the end of each line.

Parameters:

i	element index (0-7)

Returns:: count

Definition at line 1864 of file DPXHeader.h.

References chan, dpx::ImageElement::endOfLinePadding, and MAX_ELEMENTS.

Referenced by dpx::RunLengthEncoding::Read(), dpx::Read10bitFilled(), dpx::Read12bitFilledMethodB(), dpx::ReadBlockTypes(), and dpx::ReadPacked().

void dpx::GenericHeader::FileName ( char * fn ) const [inline]

Get the file name.

Parameters:

fn	buffer to store filename (100+1 chars)

Definition at line 1583 of file DPXHeader.h.

References fileName.

U32 dpx::GenericHeader::FileSize ( ) const [inline]

Get the size of the entire file.

Returns:: file size in bytes

Definition at line 1543 of file DPXHeader.h.

References fileSize.

U32 dpx::GenericHeader::GenericSize ( ) const [inline]

Get the size of the generic section within the header.

Returns:: generic header size in bytes

Definition at line 1563 of file DPXHeader.h.

References genericSize.

U32 dpx::GenericHeader::HighData ( const int i ) const [inline]

Get the maximum data value.

Parameters:

i	element index (0-7)

Returns:: maximum value

Definition at line 1731 of file DPXHeader.h.

References chan, dpx::ImageElement::highData, and MAX_ELEMENTS.

R32 dpx::GenericHeader::HighQuantity ( const int i ) const [inline]

Get the quantity of maximum data value.

Parameters:

i	element index (0-7)

Returns:: quantity

Definition at line 1745 of file DPXHeader.h.

References chan, dpx::ImageElement::highQuantity, and MAX_ELEMENTS.

Descriptor dpx::GenericHeader::ImageDescriptor ( const int i ) const [inline]

Get the component defintion.

Parameters:

i	element index (0-7)

Returns:: component descriptor

Definition at line 1759 of file DPXHeader.h.

References chan, and MAX_ELEMENTS.

int dpx::GenericHeader::ImageElementComponentCount ( const int element ) const

Number of components for the element.

Returns:: number of components

Definition at line 433 of file DPXHeader.cpp.

References dpx::kABGR, dpx::kAlpha, dpx::kBlue, dpx::kCbYACrYA, dpx::kCbYCr, dpx::kCbYCrA, dpx::kCbYCrY, dpx::kColorDifference, dpx::kCompositeVideo, dpx::kDepth, dpx::kGreen, dpx::kLuma, dpx::kRed, dpx::kRGB, dpx::kRGBA, dpx::kUserDefined2Comp, dpx::kUserDefined3Comp, dpx::kUserDefined4Comp, dpx::kUserDefined5Comp, dpx::kUserDefined6Comp, dpx::kUserDefined7Comp, dpx::kUserDefined8Comp, and dpx::kUserDefinedDescriptor.

Referenced by dpx::Codec::Read(), dpx::RunLengthEncoding::Read(), dpx::Read10bitFilled(), dpx::Read12bitFilledMethodB(), dpx::ReadBlockTypes(), and dpx::ReadPacked().

int dpx::GenericHeader::ImageElementCount ( ) const

Number of Active Elements in the Image.

Returns:: element count

Definition at line 498 of file DPXHeader.cpp.

References dpx::kUndefinedDescriptor, and MAX_ELEMENTS.

Encoding dpx::GenericHeader::ImageEncoding ( const int i ) const [inline]

Get the encoding method.

Parameters:

i	element index (0-7)

Returns:: encoding method

Definition at line 1829 of file DPXHeader.h.

References chan, dpx::kNone, dpx::kRLE, and MAX_ELEMENTS.

Referenced by dpx::RunLengthEncoding::Read().

U32 dpx::GenericHeader::ImageOffset ( ) const [inline]

Get the offset in bytes to the start of the first image element.

Returns:: offset

Definition at line 1522 of file DPXHeader.h.

References imageOffset.

Orientation dpx::GenericHeader::ImageOrientation ( ) const [inline]

Get the image orientation.

Returns:: orientation enum

Definition at line 1649 of file DPXHeader.h.

References imageOrientation.

Packing dpx::GenericHeader::ImagePacking ( const int i ) const [inline]

Get the data packing mode.

Parameters:

i	element index (0-7)

Returns:: packing method

Definition at line 1815 of file DPXHeader.h.

References chan, and MAX_ELEMENTS.

Referenced by dpx::ElementReadStream::EndianDataCheck(), and dpx::ReadImageBlock().

U32 dpx::GenericHeader::IndustrySize ( ) const [inline]

Get the size of the industry section within the header.

Returns:: industry header size in bytes

Definition at line 1568 of file DPXHeader.h.

References industrySize.

void dpx::GenericHeader::InputDevice ( char * dev ) const [inline]

Get the input device name.

Parameters:

dev	buffer to write device (32+1)

Definition at line 1993 of file DPXHeader.h.

References inputDevice.

void dpx::GenericHeader::InputDeviceSerialNumber ( char * sn ) const [inline]

Get the input device serial number.

Parameters:

sn	buffer to write device serial number (32+1)

Definition at line 2004 of file DPXHeader.h.

References inputDeviceSerialNumber.

U32 dpx::GenericHeader::LinesPerElement ( ) const [inline]

Get the lines per element.

Returns:: lines count

Definition at line 1679 of file DPXHeader.h.

References linesPerElement.

U32 dpx::GenericHeader::LowData ( const int i ) const [inline]

Get the minimum data value.

Parameters:

i	element index (0-7)

Returns:: minimum value

Definition at line 1703 of file DPXHeader.h.

References chan, dpx::ImageElement::lowData, and MAX_ELEMENTS.

R32 dpx::GenericHeader::LowQuantity ( const int i ) const [inline]

Get the quantity of minimum data value.

Parameters:

i	element index (0-7)

Returns:: quantity

Definition at line 1717 of file DPXHeader.h.

References chan, dpx::ImageElement::lowQuantity, and MAX_ELEMENTS.

U32 dpx::GenericHeader::MagicNumber ( ) const [inline]

Get magic number, used for byte ordering identification.

Returns:: magic number

Definition at line 1517 of file DPXHeader.h.

References magicNumber.

U16 dpx::GenericHeader::NumberOfElements ( ) const [inline]

Get the number of elements.

Returns:: element count

Definition at line 1659 of file DPXHeader.h.

References numberOfElements.

U32 dpx::GenericHeader::PixelsPerLine ( ) const [inline]

Get the pixels per line.

Returns:: pixel count

Definition at line 1669 of file DPXHeader.h.

References pixelsPerLine.

void dpx::GenericHeader::Project ( char * prj ) const [inline]

Get the project.

Parameters:

prj	buffer to store project (200+1 chars)

Definition at line 1616 of file DPXHeader.h.

References project.

void dpx::GenericHeader::Reset ( )

Reset class to initial state.

Reimplemented in dpx::Header.

Definition at line 77 of file DPXHeader.cpp.

References EmptyString(), dpx::kUndefinedOrientation, MAGIC_COOKIE, and SMPTE_VERSION.

Referenced by dpx::Header::Reset().

Here is the call graph for this function:

void dpx::GenericHeader::SetAspectRatio	(	const int	i,
		const U32	ar
	)		`[inline]`

Set the pixel aspect ratio (horizontal:vertical)

Parameters:

i	aspect ratio index (0-1)
ar	ratio quantity

Definition at line 2038 of file DPXHeader.h.

References aspectRatio.

void dpx::GenericHeader::SetBitDepth	(	const int	i,
		const U8	depth
	)		`[inline]`

Set the bit size of each component.

Parameters:

i	element index (0-7)
depth	bit size

Definition at line 1808 of file DPXHeader.h.

References dpx::ImageElement::bitDepth, chan, and MAX_ELEMENTS.

void dpx::GenericHeader::SetBorder	(	const int	i,
		const U16	bord
	)		`[inline]`

Set the pixel offset for the border region.

There are 4 border pixel offsets that define a region -- X-left, X-right, Y-top, Y-bottom

Parameters:

i	border index (0-3)
bord	offset in pixels

Definition at line 2023 of file DPXHeader.h.

References border.

void dpx::GenericHeader::SetColorimetric	(	const int	i,
		const Characteristic	c
	)		`[inline]`

Set the color reference.

Parameters:

i	element index (0-7)
c	colorimetric specification

Definition at line 1794 of file DPXHeader.h.

References chan, dpx::ImageElement::colorimetric, and MAX_ELEMENTS.

void dpx::GenericHeader::SetCopyright ( const char * copy ) [inline]

Set the copyright information.

Parameters:

copy	buffer with copyright string

Definition at line 1633 of file DPXHeader.h.

References copyright.

void dpx::GenericHeader::SetCreationTimeDate ( const char * ct ) [inline]

Set the creation time/date.

Parameters:

ct	buffer with creation time/date

Definition at line 1600 of file DPXHeader.h.

References creationTimeDate.

void dpx::GenericHeader::SetCreationTimeDate ( const long secs )

Set the creation time/date.

Parameters:

secs	number of seconds since January 1, 1970 00:00

Definition at line 761 of file DPXHeader.cpp.

void dpx::GenericHeader::SetCreator ( const char * creat ) [inline]

Set the creator.

Parameters:

creat buffer with creator

Definition at line 1611 of file DPXHeader.h.

References creator.

void dpx::GenericHeader::SetDataOffset	(	const int	i,
		const U32	offset
	)		`[inline]`

Set the offset to element.

Parameters:

i	element index (0-7)
offset	offset in bytes from the start of the file

Definition at line 1857 of file DPXHeader.h.

References chan, dpx::ImageElement::dataOffset, and MAX_ELEMENTS.

void dpx::GenericHeader::SetDataSign	(	const int	i,
		const U32	sign
	)		`[inline]`

Set the data sign (0 = unsigned, 1 = signed)

Parameters:

i	element index (0-7)
sign	data sign

Definition at line 1696 of file DPXHeader.h.

References chan, dpx::ImageElement::dataSign, and MAX_ELEMENTS.

void dpx::GenericHeader::SetDescription	(	const int	i,
		const char *	desc
	)		`[inline]`

Set the element description.

Parameters:

i	element index (0-7)
desc	buffer

Definition at line 1903 of file DPXHeader.h.

References chan, and MAX_ELEMENTS.

void dpx::GenericHeader::SetDittoKey ( const U32 key ) [inline]

Set the ditto key.

Parameters:

key ditto key

Definition at line 1558 of file DPXHeader.h.

References dittoKey.

void dpx::GenericHeader::SetEncryptKey ( const U32 key ) [inline]

Set the encryption key (no encryption is 0xffffffff)

Parameters:

key	encryption key

Definition at line 1643 of file DPXHeader.h.

References encryptKey.

void dpx::GenericHeader::SetEndOfImagePadding	(	const int	i,
		const U32	eoip
	)		`[inline]`

Set the number of bytes padding the end of the image element.

Parameters:

i	element index (0-7)
eoip	count

Definition at line 1889 of file DPXHeader.h.

References chan, dpx::ImageElement::endOfImagePadding, and MAX_ELEMENTS.

void dpx::GenericHeader::SetEndOfLinePadding	(	const int	i,
		const U32	eolp
	)		`[inline]`

Set the number of bytes padding the end of each line.

Parameters:

i	element index (0-7)
eolp	count

Definition at line 1873 of file DPXHeader.h.

References chan, dpx::ImageElement::endOfLinePadding, and MAX_ELEMENTS.

void dpx::GenericHeader::SetFileName ( const char * fn ) [inline]

Set the file name.

Parameters:

fn	buffer with filename

Definition at line 1589 of file DPXHeader.h.

References fileName.

void dpx::GenericHeader::SetFileSize ( const U32 fs ) [inline]

Set the size of the entire file.

Parameters:

fs	file size in bytes

Definition at line 1548 of file DPXHeader.h.

References fileSize.

void dpx::GenericHeader::SetHighData	(	const int	i,
		const U32	data
	)		`[inline]`

Set the maximum data value.

Parameters:

i	element index (0-7)
data	maximum value

Definition at line 1738 of file DPXHeader.h.

References chan, dpx::ImageElement::highData, and MAX_ELEMENTS.

void dpx::GenericHeader::SetHighQuantity	(	const int	i,
		const R32	quant
	)		`[inline]`

Set the quantity of maximum data value.

Parameters:

i	element index (0-7)
quant	quantity

Definition at line 1752 of file DPXHeader.h.

References chan, dpx::ImageElement::highQuantity, and MAX_ELEMENTS.

void dpx::GenericHeader::SetImageDescriptor	(	const int	i,
		const Descriptor	desc
	)		`[inline]`

Set the component defintion.

Parameters:

i	element index (0-7)
desc	component descriptor

Definition at line 1766 of file DPXHeader.h.

References chan, dpx::ImageElement::descriptor, and MAX_ELEMENTS.

void dpx::GenericHeader::SetImageEncoding	(	const int	i,
		const Encoding	enc
	)		`[inline]`

Set the encoding method.

Parameters:

i	element index (0-7)
enc	encoding method

Definition at line 1842 of file DPXHeader.h.

References chan, dpx::ImageElement::encoding, dpx::kNone, and MAX_ELEMENTS.

void dpx::GenericHeader::SetImageOffset ( const U32 offset ) [inline]

Set the offset in bytes to the start of the first image element.

Parameters:

offset offset in bytes

Definition at line 1527 of file DPXHeader.h.

References imageOffset.

void dpx::GenericHeader::SetImageOrientation ( const Orientation orient ) [inline]

Set the image orientation.

Parameters:

orient orientation

Definition at line 1654 of file DPXHeader.h.

References imageOrientation.

void dpx::GenericHeader::SetImagePacking	(	const int	i,
		const Packing	pack
	)		`[inline]`

Set the data packing mode.

Parameters:

i	element index (0-7)
pack	packing method

Definition at line 1822 of file DPXHeader.h.

References chan, MAX_ELEMENTS, and dpx::ImageElement::packing.

void dpx::GenericHeader::SetInputDevice ( const char * dev ) [inline]

Set the input device name.

Parameters:

dev	buffer with device name

Definition at line 1999 of file DPXHeader.h.

References inputDevice.

void dpx::GenericHeader::SetInputDeviceSerialNumber ( const char * sn ) [inline]

Set the input device serial number.

Parameters:

sn	buffer with device serial number

Definition at line 2010 of file DPXHeader.h.

References inputDeviceSerialNumber.

void dpx::GenericHeader::SetLinesPerElement ( const U32 lpe ) [inline]

Set the lines per element.

Parameters:

lpe	lines count

Definition at line 1684 of file DPXHeader.h.

References linesPerElement.

void dpx::GenericHeader::SetLowData	(	const int	i,
		const U32	data
	)		`[inline]`

Set the minimum data value.

Parameters:

i	element index (0-7)
data	minimum value

Definition at line 1710 of file DPXHeader.h.

References chan, dpx::ImageElement::lowData, and MAX_ELEMENTS.

void dpx::GenericHeader::SetLowQuantity	(	const int	i,
		const R32	quant
	)		`[inline]`

Set the quantity of minimum data value.

Parameters:

i	element index (0-7)
quant	quantity

Definition at line 1724 of file DPXHeader.h.

References chan, dpx::ImageElement::lowQuantity, and MAX_ELEMENTS.

void dpx::GenericHeader::SetNumberOfElements ( const U16 num ) [inline]

Set the number of elements.

Parameters:

num	element count

Definition at line 1664 of file DPXHeader.h.

References numberOfElements.

void dpx::GenericHeader::SetPixelsPerLine ( const U32 ppl ) [inline]

Set the pixels per line.

Parameters:

ppl	pixel count

Definition at line 1674 of file DPXHeader.h.

References pixelsPerLine.

void dpx::GenericHeader::SetProject ( const char * prj ) [inline]

Set the project.

Parameters:

prj	buffer with project

Definition at line 1622 of file DPXHeader.h.

References project.

void dpx::GenericHeader::SetSourceImageFileName ( const char * fn ) [inline]

Set the source image file name that this image was extracted.

Parameters:

fn	buffer with source file name

Definition at line 1977 of file DPXHeader.h.

References sourceImageFileName.

void dpx::GenericHeader::SetSourceTimeDate ( const char * td ) [inline]

Set the source image time and date that this image was extracted.

Parameters:

td	buffer with time/date string

Definition at line 1988 of file DPXHeader.h.

References sourceTimeDate.

void dpx::GenericHeader::SetSourceTimeDate ( const long secs )

Set the source image time and date that this image was extracted.

Parameters:

secs	number of seconds since January 1, 1970 00:00

Definition at line 777 of file DPXHeader.cpp.

void dpx::GenericHeader::SetTransfer	(	const int	i,
		const Characteristic	ch
	)		`[inline]`

Set the amplitude transfer function.

Parameters:

i	element index (0-7)
ch	transfer characteristic

Definition at line 1780 of file DPXHeader.h.

References chan, MAX_ELEMENTS, and dpx::ImageElement::transfer.

void dpx::GenericHeader::SetUserSize ( const U32 size ) [inline]

Set the size of the user data.

Parameters:

size	user data size in bytes

Definition at line 1578 of file DPXHeader.h.

References userSize.

void dpx::GenericHeader::SetVersion ( const char * v ) [inline]

Set the version string.

Parameters:

v	version string

Definition at line 1538 of file DPXHeader.h.

References version.

void dpx::GenericHeader::SetXCenter ( const R32 center ) [inline]

Set the X image center in pixels.

Parameters:

center pixel position

Definition at line 1936 of file DPXHeader.h.

References xCenter.

void dpx::GenericHeader::SetXOffset ( const U32 offset ) [inline]

Set the line offset (in pixels) from the first pixel in original image.

Parameters:

offset offset count

Definition at line 1916 of file DPXHeader.h.

References xOffset.

void dpx::GenericHeader::SetXOriginalSize ( const U32 size ) [inline]

GSt the number of pixels per line in the original image.

Parameters:

size size

Definition at line 1956 of file DPXHeader.h.

References xOriginalSize.

void dpx::GenericHeader::SetXScannedSize ( const R32 size ) [inline]

Set the horizontal size of the original scanned optical image.

Parameters:

size	size in millimeters

Definition at line 2050 of file DPXHeader.h.

References xScannedSize.

void dpx::GenericHeader::SetYCenter ( const R32 center ) [inline]

Set the Y image center in pixels.

Parameters:

center pixel position

Definition at line 1946 of file DPXHeader.h.

References yCenter.

void dpx::GenericHeader::SetYOffset ( const U32 offset ) [inline]

Set the frame offset (in lines) from the first line in original image.

Parameters:

offset offset count

Definition at line 1926 of file DPXHeader.h.

References yOffset.

void dpx::GenericHeader::SetYOriginalSize ( const U32 size ) [inline]

Set the number of lines per image in the original image.

Parameters:

size size

Definition at line 1966 of file DPXHeader.h.

References yOriginalSize.

void dpx::GenericHeader::SetYScannedSize ( const R32 size ) [inline]

Set the vertical size of the original scanned optical image.

Parameters:

size	size in millimeters

Definition at line 2060 of file DPXHeader.h.

References yScannedSize.

void dpx::GenericHeader::SourceImageFileName ( char * fn ) const [inline]

Get the source image file name that this image was extracted.

Parameters:

fn	buffer to write source file name (100+1)

Definition at line 1971 of file DPXHeader.h.

References sourceImageFileName.

void dpx::GenericHeader::SourceTimeDate ( char * td ) const [inline]

Get the source image time and date that this image was extracted.

Parameters:

td	buffer to write time/date string (24+1)

Definition at line 1982 of file DPXHeader.h.

References sourceTimeDate.

Characteristic dpx::GenericHeader::Transfer ( const int i ) const [inline]

Get the amplitude transfer function.

Parameters:

i	element index (0-7)

Returns:: transfer characteristic

Definition at line 1773 of file DPXHeader.h.

References chan, and MAX_ELEMENTS.

U32 dpx::GenericHeader::UserSize ( ) const [inline]

Get the size of the user data.

Returns:: user data size in bytes

Definition at line 1573 of file DPXHeader.h.

References userSize.

void dpx::GenericHeader::Version ( char * v ) const [inline]

Get current version string of header.

Parameters:

v	buffer to place string, needs to be at least 8+1 bytes long

Definition at line 1532 of file DPXHeader.h.

References version.

R32 dpx::GenericHeader::XCenter ( ) const [inline]

Get the X image center in pixels.

Returns:: pixel position

Definition at line 1931 of file DPXHeader.h.

References xCenter.

U32 dpx::GenericHeader::XOffset ( ) const [inline]

Get the line offset (in pixels) from the first pixel in original image.

Returns:: offset count

Definition at line 1911 of file DPXHeader.h.

References xOffset.

U32 dpx::GenericHeader::XOriginalSize ( ) const [inline]

Get the number of pixels per line in the original image.

Returns:: size

Definition at line 1951 of file DPXHeader.h.

References xOriginalSize.

R32 dpx::GenericHeader::XScannedSize ( ) const [inline]

Get the horizontal size of the original scanned optical image.

Returns:: size in millimeters

Definition at line 2045 of file DPXHeader.h.

References xScannedSize.

R32 dpx::GenericHeader::YCenter ( ) const [inline]

Get the Y image center in pixels.

Returns:: pixel position

Definition at line 1941 of file DPXHeader.h.

References yCenter.

U32 dpx::GenericHeader::YOffset ( ) const [inline]

Get the frame offset (in lines) from the first line in original image.

Returns:: offset count

Definition at line 1921 of file DPXHeader.h.

References yOffset.

U32 dpx::GenericHeader::YOriginalSize ( ) const [inline]

Get the number of lines per image in the original image.

Returns:: size

Definition at line 1961 of file DPXHeader.h.

References yOriginalSize.

R32 dpx::GenericHeader::YScannedSize ( ) const [inline]

Get the vertical size of the original scanned optical image.

Returns:: size in millimeters

Definition at line 2055 of file DPXHeader.h.

References yScannedSize.

Field Documentation

U32 dpx::GenericHeader::aspectRatio[2]

Pixel aspect ratio (horizontal:vertical)

Definition at line 347 of file DPXHeader.h.

Referenced by AspectRatio(), and SetAspectRatio().

U16 dpx::GenericHeader::border[4]

Border validity.

Definition at line 346 of file DPXHeader.h.

Referenced by Border(), and SetBorder().

ImageElement dpx::GenericHeader::chan[MAX_ELEMENTS]

Image element data structures.

Definition at line 326 of file DPXHeader.h.

Referenced by BitDepth(), Colorimetric(), DataOffset(), DataSign(), Description(), EndOfImagePadding(), EndOfLinePadding(), HighData(), HighQuantity(), ImageDescriptor(), ImageEncoding(), ImagePacking(), LowData(), LowQuantity(), SetBitDepth(), SetColorimetric(), SetDataOffset(), SetDataSign(), SetDescription(), SetEndOfImagePadding(), SetEndOfLinePadding(), SetHighData(), SetHighQuantity(), SetImageDescriptor(), SetImageEncoding(), SetImagePacking(), SetLowData(), SetLowQuantity(), SetTransfer(), and Transfer().

ASCII dpx::GenericHeader::copyright[200]

Copyright statement.

Definition at line 311 of file DPXHeader.h.

Referenced by Copyright(), and SetCopyright().

ASCII dpx::GenericHeader::creationTimeDate[24]

Create date time /see DateTimeFormat.

Definition at line 308 of file DPXHeader.h.

Referenced by CreationTimeDate(), and SetCreationTimeDate().

ASCII dpx::GenericHeader::creator[100]

Creator.

Definition at line 309 of file DPXHeader.h.

Referenced by Creator(), and SetCreator().

U32 dpx::GenericHeader::dittoKey

Ditto Key (0 = same as previous frame, 1 = new)

Definition at line 303 of file DPXHeader.h.

Referenced by DittoKey(), and SetDittoKey().

U32 dpx::GenericHeader::encryptKey

Encryption Key (0xffffffff if unencrypted)

Definition at line 312 of file DPXHeader.h.

Referenced by EncryptKey(), and SetEncryptKey().

ASCII dpx::GenericHeader::fileName[100]

File name.

Definition at line 307 of file DPXHeader.h.

Referenced by FileName(), and SetFileName().

U32 dpx::GenericHeader::fileSize

Total file size (in bytes)

Definition at line 302 of file DPXHeader.h.

Referenced by FileSize(), and SetFileSize().

U32 dpx::GenericHeader::genericSize

Generic Header length (in bytes)

Definition at line 304 of file DPXHeader.h.

Referenced by GenericSize().

U32 dpx::GenericHeader::imageOffset

Offset to image data (in bytes)

Definition at line 300 of file DPXHeader.h.

Referenced by ImageOffset(), and SetImageOffset().

U16 dpx::GenericHeader::imageOrientation

Image orientation.

See also:: Orientation

Definition at line 322 of file DPXHeader.h.

Referenced by ImageOrientation(), and SetImageOrientation().

U32 dpx::GenericHeader::industrySize

Industry Header length (in bytes)

Definition at line 305 of file DPXHeader.h.

Referenced by IndustrySize().

ASCII dpx::GenericHeader::inputDevice[32]

Input device name.

Definition at line 344 of file DPXHeader.h.

Referenced by InputDevice(), and SetInputDevice().

ASCII dpx::GenericHeader::inputDeviceSerialNumber[32]

Input device serial number.

Definition at line 345 of file DPXHeader.h.

Referenced by InputDeviceSerialNumber(), and SetInputDeviceSerialNumber().

U32 dpx::GenericHeader::linesPerElement

Lines per element.

Definition at line 325 of file DPXHeader.h.

Referenced by LinesPerElement(), and SetLinesPerElement().

U32 dpx::GenericHeader::magicNumber

Indicates start of DPX image file and is used to determine byte order.

Definition at line 299 of file DPXHeader.h.

Referenced by MagicNumber(), and dpx::Header::RequiresByteSwap().

U16 dpx::GenericHeader::numberOfElements

Number of elements (1-8)

Definition at line 323 of file DPXHeader.h.

Referenced by NumberOfElements(), and SetNumberOfElements().

U32 dpx::GenericHeader::pixelsPerLine

Pixels per line.

Definition at line 324 of file DPXHeader.h.

Referenced by PixelsPerLine(), and SetPixelsPerLine().

ASCII dpx::GenericHeader::project[200]

Project name.

Definition at line 310 of file DPXHeader.h.

Referenced by Project(), and SetProject().

ASCII dpx::GenericHeader::reserved1[104]

Reserved.

Definition at line 313 of file DPXHeader.h.

ASCII dpx::GenericHeader::reserved2[52]

Reserved.

Definition at line 327 of file DPXHeader.h.

ASCII dpx::GenericHeader::reserved3[20]

Reserved.

Definition at line 350 of file DPXHeader.h.

ASCII dpx::GenericHeader::sourceImageFileName[100]

Source image file name.

Definition at line 342 of file DPXHeader.h.

Referenced by SetSourceImageFileName(), and SourceImageFileName().

ASCII dpx::GenericHeader::sourceTimeDate[24]

Source date and time /see DateTimeFormat.

Definition at line 343 of file DPXHeader.h.

Referenced by SetSourceTimeDate(), and SourceTimeDate().

U32 dpx::GenericHeader::userSize

User defined header length (in bytes)

Definition at line 306 of file DPXHeader.h.

Referenced by SetUserSize(), and UserSize().

ASCII dpx::GenericHeader::version[8]

Version number of header format.

Definition at line 301 of file DPXHeader.h.

Referenced by SetVersion(), and Version().

R32 dpx::GenericHeader::xCenter

X center.

Definition at line 338 of file DPXHeader.h.

Referenced by SetXCenter(), and XCenter().

U32 dpx::GenericHeader::xOffset

X offset.

Definition at line 336 of file DPXHeader.h.

Referenced by SetXOffset(), and XOffset().

U32 dpx::GenericHeader::xOriginalSize

X original size.

Definition at line 340 of file DPXHeader.h.

Referenced by SetXOriginalSize(), and XOriginalSize().

R32 dpx::GenericHeader::xScannedSize

X scanned size.

Definition at line 348 of file DPXHeader.h.

Referenced by SetXScannedSize(), and XScannedSize().

R32 dpx::GenericHeader::yCenter

Y center.

Definition at line 339 of file DPXHeader.h.

Referenced by SetYCenter(), and YCenter().

U32 dpx::GenericHeader::yOffset

Y offset.

Definition at line 337 of file DPXHeader.h.

Referenced by SetYOffset(), and YOffset().

U32 dpx::GenericHeader::yOriginalSize

Y original size.

Definition at line 341 of file DPXHeader.h.

Referenced by SetYOriginalSize(), and YOriginalSize().

R32 dpx::GenericHeader::yScannedSize

Y scanned size.

Definition at line 349 of file DPXHeader.h.

Referenced by SetYScannedSize(), and YScannedSize().

The documentation for this struct was generated from the following files:

plugins/image/io/Dpx/src/dpx-google-code/libdpx/DPXHeader.h
plugins/image/io/Dpx/src/dpx-google-code/libdpx/DPXHeader.cpp

Public Member Functions

Static Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation