libcineon  0.1
Public Member Functions | Static Public Member Functions | List of all members
cineon::GenericHeader Struct Reference

Generic File and Image Header Information. More...

#include <CineonHeader.h>

Inheritance diagram for cineon::GenericHeader:
Inheritance graph
[legend]
Collaboration diagram for cineon::GenericHeader:
Collaboration graph
[legend]

Public Member Functions

 GenericHeader ()
 Constructor. More...
 
void Reset ()
 Reset class to initial state. More...
 
int ImageElementCount () const
 Number of Active Elements in the Image. More...
 
void CalculateNumberOfElements ()
 Set member numberOfElements based on channel structure. More...
 
int ImageElementComponentCount (const int element) const
 Number of components for the element. More...
 
DataSize ComponentDataSize (const int element) const
 DataSize required for individual image element components. More...
 
int ComponentByteCount (const int element) const
 Byte count of data element components. More...
 
File Information Methods
U32 MagicNumber () const
 Get magic number, used for byte ordering identification. More...
 
U32 ImageOffset () const
 Get the offset in bytes to the start of the first image element. More...
 
void SetImageOffset (const U32 offset)
 Set the offset in bytes to the start of the first image element. More...
 
U32 GenericSize () const
 Get the size of the generic section within the header. More...
 
U32 IndustrySize () const
 Get the size of the industry section within the header. More...
 
U32 UserSize () const
 Get the size of the user data. More...
 
void SetUserSize (const U32 size)
 Set the size of the user data. More...
 
U32 FileSize () const
 Get the size of the entire file. More...
 
void SetFileSize (const U32 fs)
 Set the size of the entire file. More...
 
void Version (char *v) const
 Get current version string of header. More...
 
void SetVersion (const char *v)
 Set the version string. More...
 
void FileName (char *fn) const
 Get the file name. More...
 
void SetFileName (const char *fn)
 Set the file name. More...
 
void CreationDate (char *ct) const
 Get the creation time/date. More...
 
void SetCreationDate (const char *ct)
 Set the creation time/date. More...
 
void CreationTime (char *ct) const
 Get the creation time/date. More...
 
void SetCreationTime (const char *ct)
 Set the creation time/date. More...
 
void SetCreationTimeDate (const long secs)
 Set the creation time/date. More...
 
Image Information Methods
Orientation ImageOrientation () const
 Get the image orientation. More...
 
void SetImageOrientation (const Orientation orient)
 Set the image orientation. More...
 
U8 NumberOfElements () const
 Get the number of elements. More...
 
void SetNumberOfElements (const U8 num)
 Set the number of elements. More...
 
U8 Metric (const int i) const
 Get the first byte of the channel designator - metric info. More...
 
void SetMetric (const int i, const U8 m)
 Set the first byte of the channel designator - metric info. More...
 
Descriptor ImageDescriptor (const int i) const
 Get the second byte of the channel designator. More...
 
void SetImageDescriptor (const int i, const Descriptor d)
 Set the second byte of the channel designator. More...
 
U8 BitDepth (const int i) const
 Get the bits per pixel. More...
 
void SetBitDepth (const int i, const U8 bpp)
 Set the bits per pixel. More...
 
U32 PixelsPerLine (const int i) const
 Get the pixels per line. More...
 
void SetPixelsPerLine (const int i, const U32 ppl)
 Set the pixels per line. More...
 
U32 LinesPerElement (const int i) const
 Get the lines per element. More...
 
void SetLinesPerElement (const int i, const U32 lpe)
 Set the lines per element. More...
 
R32 LowData (const int i) const
 Get the minimum data value. More...
 
void SetLowData (const int i, const R32 data)
 Set the minimum data value. More...
 
R32 LowQuantity (const int i) const
 Get the quantity of minimum data value. More...
 
void SetLowQuantity (const int i, const R32 quant)
 Set the quantity of minimum data value. More...
 
R32 HighData (const int i) const
 Get the maximum data value. More...
 
void SetHighData (const int i, const R32 data)
 Set the maximum data value. More...
 
R32 HighQuantity (const int i) const
 Get the quantity of maximum data value. More...
 
void SetHighQuantity (const int i, const R32 quant)
 Set the quantity of maximum data value. More...
 
void WhitePoint (R32 xy[2]) const
 Get the white point primary x, y pair. More...
 
void SetWhitePoint (const R32 xy[2])
 Set the white point primary x, y pair. More...
 
void RedPrimary (R32 xy[2]) const
 Get the red primary x, y pair. More...
 
void SetRedPrimary (const R32 xy[2])
 Set the red primary x, y pair. More...
 
void GreenPrimary (R32 xy[2]) const
 Get the green primary x, y pair. More...
 
void SetGreenPrimary (const R32 xy[2])
 Set the green primary x, y pair. More...
 
void BluePrimary (R32 xy[2]) const
 Get the blue primary x, y pair. More...
 
void SetBluePrimary (const R32 xy[2])
 Set the blue primary x, y pair. More...
 
void LabelText (char *ct) const
 Get the label text. More...
 
void SetLabelText (const char *ct)
 Set the label text. More...
 
Interleave ImageInterleave () const
 Get the data interleave mode. More...
 
void SetImageInterleave (const Interleave inter)
 Set the data intearleave mode. More...
 
Packing ImagePacking () const
 Get the data packing mode. More...
 
void SetImagePacking (const Packing pack)
 Set the data packing mode. More...
 
U8 DataSign () const
 Get the data sign (0 = unsigned, 1 = signed) More...
 
void SetDataSign (const U8 sign)
 Set the data sign (0 = unsigned, 1 = signed) More...
 
U8 ImageSense () const
 Get the image sense (0 = positive, 1 = negative) More...
 
void SetImageSense (const U8 sense)
 Set the image sense (0 = positive, 1 = negative) More...
 
U32 EndOfLinePadding () const
 Get the number of bytes padding the end of each line. More...
 
void SetEndOfLinePadding (const U32 eolp)
 Set the number of bytes padding the end of each line. More...
 
U32 EndOfImagePadding () const
 Get the number of bytes padding the end of the image element. More...
 
void SetEndOfImagePadding (const U32 eoip)
 Set the number of bytes padding the end of the image element. More...
 
Image Origination Methods
S32 XOffset () const
 Get the line offset (in pixels) from the first pixel in original image. More...
 
void SetXOffset (const S32 offset)
 Set the line offset (in pixels) from the first pixel in original image. More...
 
S32 YOffset () const
 Get the frame offset (in lines) from the first line in original image. More...
 
void SetYOffset (const S32 offset)
 Set the frame offset (in lines) from the first line in original image. More...
 
void SourceImageFileName (char *fn) const
 Get the source image file name that this image was extracted. More...
 
void SetSourceImageFileName (const char *fn)
 Set the source image file name that this image was extracted. More...
 
void SourceDate (char *td) const
 Get the source image time and date that this image was extracted. More...
 
void SetSourceDate (const char *td)
 Set the source image time and date that this image was extracted. More...
 
void SourceTime (char *td) const
 Get the source image time and date that this image was extracted. More...
 
void SetSourceTime (const char *td)
 Set the source image time and date that this image was extracted. More...
 
void SetSourceTimeDate (const long secs)
 Set the source image time and date that this image was extracted. More...
 
void InputDevice (char *dev) const
 Get the input device name. More...
 
void SetInputDevice (const char *dev)
 Set the input device name. More...
 
void InputDeviceModelNumber (char *sn) const
 Get the input device model number. More...
 
void SetInputDeviceModelNumber (const char *sn)
 Set the input device model number. More...
 
void InputDeviceSerialNumber (char *sn) const
 Get the input device serial number. More...
 
void SetInputDeviceSerialNumber (const char *sn)
 Set the input device serial number. More...
 
R32 XDevicePitch () const
 Get the horizontal pitch of the device. More...
 
void SetXDevicePitch (const R32 size)
 Set the horizontal pitch of the device. More...
 
R32 YDevicePitch () const
 Get the veritcal pitch of the device. More...
 
void SetYDevicePitch (const R32 size)
 Set the vertical pitch of the device. More...
 
R32 Gamma () const
 Get the gamma correction exponent. More...
 
void SetGamma (const R32 gamma)
 Set the gamma correction exponent. More...
 

Static Public Member Functions

static int DataSizeByteCount (const DataSize ds)
 

Public Attributes

File Information Members
U32 magicNumber
 Indicates start of DPX image file and is used to determine byte order. More...
 
U32 imageOffset
 Offset to image data (in bytes) More...
 
U32 genericSize
 Generic Header length (in bytes) More...
 
U32 industrySize
 Industry Header length (in bytes) More...
 
U32 userSize
 User defined header length (in bytes) More...
 
U32 fileSize
 Total file size (in bytes) More...
 
ASCII version [8]
 Version number of header format. More...
 
ASCII fileName [100]
 File name. More...
 
ASCII creationDate [12]
 Create date /see DateTimeFormat. More...
 
ASCII creationTime [12]
 Create time /see DateTimeFormat. More...
 
ASCII reserved1 [36]
 Reserved. More...
 
Image Information Members
U8 imageOrientation
 Image orientation. More...
 
U8 numberOfElements
 Number of elements (1-8) More...
 
U8 unused1 [2]
 Unused (word alignment) More...
 
ImageElement chan [MAX_ELEMENTS]
 Image element data structures. More...
 
R32 whitePoint [2]
 White point (x, y pair) More...
 
R32 redPrimary [2]
 Red primary chromaticity (x, y pair) More...
 
R32 greenPrimary [2]
 Green primary chromaticity (x, y pair) More...
 
R32 bluePrimary [2]
 Blue primary chromaticity (x, y pair) More...
 
ASCII labelText [200]
 Label text. More...
 
ASCII reserved2 [28]
 Reserved. More...
 
U8 interleave
 Data interleave. More...
 
U8 packing
 Packing. More...
 
U8 dataSign
 Data sign (0 = unsigned, 1 = signed) More...
 
U8 imageSense
 Image sense (0 = positive image, 1 = negative image) More...
 
U32 endOfLinePadding
 End-of-Line Padding. More...
 
U32 endOfImagePadding
 End-of-Image Padding. More...
 
ASCII reserved3 [20]
 
Image Origination Members
S32 xOffset
 X offset. More...
 
S32 yOffset
 Y offset. More...
 
ASCII sourceImageFileName [100]
 Source image file name. More...
 
ASCII sourceDate [12]
 Source date /see DateTimeFormat. More...
 
ASCII sourceTime [12]
 Source time /see DateTimeFormat. More...
 
ASCII inputDevice [64]
 Input device name. More...
 
ASCII inputDeviceModelNumber [32]
 Input device model number. More...
 
ASCII inputDeviceSerialNumber [32]
 Input device serial number. More...
 
R32 xDevicePitch
 X device pitch (samples/mm) More...
 
R32 yDevicePitch
 Y device pitch (samples/mm) More...
 
R32 gamma
 Gamma. More...
 
ASCII reserved4 [40]
 Reserved. More...
 

Detailed Description

Generic File and Image Header Information.

Constructor & Destructor Documentation

cineon::GenericHeader::GenericHeader ( )

Constructor.

Member Function Documentation

U8 cineon::GenericHeader::BitDepth ( const int  i) const
inline

Get the bits per pixel.

Parameters
ielement index (0-7)
Returns
bit count
void cineon::GenericHeader::BluePrimary ( R32  xy[2]) const
inline

Get the blue primary x, y pair.

Parameters
xybuffer to store the x, y pair (2 32-bit floats)
void cineon::GenericHeader::CalculateNumberOfElements ( )

Set member numberOfElements based on channel structure.

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

Byte count of data element components.

Returns
byte count
cineon::DataSize cineon::GenericHeader::ComponentDataSize ( const int  element) const

DataSize required for individual image element components.

Returns
datasize of element
void cineon::GenericHeader::CreationDate ( char *  ct) const
inline

Get the creation time/date.

Parameters
ctbuffer to store creation time/date (24+1 chars)
void cineon::GenericHeader::CreationTime ( char *  ct) const
inline

Get the creation time/date.

Parameters
ctbuffer to store creation time/date (24+1 chars)
U8 cineon::GenericHeader::DataSign ( ) const
inline

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

Returns
data sign
int cineon::GenericHeader::DataSizeByteCount ( const DataSize  ds)
static
U32 cineon::GenericHeader::EndOfImagePadding ( ) const
inline

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

Parameters
ielement index (0-7)
Returns
count
U32 cineon::GenericHeader::EndOfLinePadding ( ) const
inline

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

Parameters
ielement index (0-7)
Returns
count
void cineon::GenericHeader::FileName ( char *  fn) const
inline

Get the file name.

Parameters
fnbuffer to store filename (100+1 chars)
U32 cineon::GenericHeader::FileSize ( ) const
inline

Get the size of the entire file.

Returns
file size in bytes
R32 cineon::GenericHeader::Gamma ( ) const
inline

Get the gamma correction exponent.

Returns
gamma exponent
U32 cineon::GenericHeader::GenericSize ( ) const
inline

Get the size of the generic section within the header.

Returns
generic header size in bytes
void cineon::GenericHeader::GreenPrimary ( R32  xy[2]) const
inline

Get the green primary x, y pair.

Parameters
xybuffer to store the x, y pair (2 32-bit floats)
R32 cineon::GenericHeader::HighData ( const int  i) const
inline

Get the maximum data value.

Parameters
ielement index (0-7)
Returns
maximum value
R32 cineon::GenericHeader::HighQuantity ( const int  i) const
inline

Get the quantity of maximum data value.

Parameters
ielement index (0-7)
Returns
quantity
Descriptor cineon::GenericHeader::ImageDescriptor ( const int  i) const
inline

Get the second byte of the channel designator.

Parameters
ielement index (0-7)
Returns
channel descriptor
int cineon::GenericHeader::ImageElementComponentCount ( const int  element) const

Number of components for the element.

Returns
number of components
int cineon::GenericHeader::ImageElementCount ( ) const

Number of Active Elements in the Image.

Returns
element count
Interleave cineon::GenericHeader::ImageInterleave ( ) const
inline

Get the data interleave mode.

Returns
interleave method
U32 cineon::GenericHeader::ImageOffset ( ) const
inline

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

Returns
offset
Orientation cineon::GenericHeader::ImageOrientation ( ) const
inline

Get the image orientation.

Returns
orientation enum
Packing cineon::GenericHeader::ImagePacking ( ) const
inline

Get the data packing mode.

Returns
packing method
U8 cineon::GenericHeader::ImageSense ( ) const
inline

Get the image sense (0 = positive, 1 = negative)

Returns
image sense
U32 cineon::GenericHeader::IndustrySize ( ) const
inline

Get the size of the industry section within the header.

Returns
industry header size in bytes
void cineon::GenericHeader::InputDevice ( char *  dev) const
inline

Get the input device name.

Parameters
devbuffer to write device (64+1)
void cineon::GenericHeader::InputDeviceModelNumber ( char *  sn) const
inline

Get the input device model number.

Parameters
snbuffer to write device model number (32+1)
void cineon::GenericHeader::InputDeviceSerialNumber ( char *  sn) const
inline

Get the input device serial number.

Parameters
snbuffer to write device serial number (32+1)
void cineon::GenericHeader::LabelText ( char *  ct) const
inline

Get the label text.

Parameters
ctbuffer to store label text (200 chars)
U32 cineon::GenericHeader::LinesPerElement ( const int  i) const
inline

Get the lines per element.

Parameters
ielement index (0-7)
Returns
lines count
R32 cineon::GenericHeader::LowData ( const int  i) const
inline

Get the minimum data value.

Parameters
ielement index (0-7)
Returns
minimum value
R32 cineon::GenericHeader::LowQuantity ( const int  i) const
inline

Get the quantity of minimum data value.

Parameters
ielement index (0-7)
Returns
quantity
U32 cineon::GenericHeader::MagicNumber ( ) const
inline

Get magic number, used for byte ordering identification.

Returns
magic number
U8 cineon::GenericHeader::Metric ( const int  i) const
inline

Get the first byte of the channel designator - metric info.

Parameters
ielement index (0-7)
Returns
0 = universal metric, 1-254 = vendor-specific
U8 cineon::GenericHeader::NumberOfElements ( ) const
inline

Get the number of elements.

Returns
element count
U32 cineon::GenericHeader::PixelsPerLine ( const int  i) const
inline

Get the pixels per line.

Parameters
ielement index (0-7)
Returns
pixel count
void cineon::GenericHeader::RedPrimary ( R32  xy[2]) const
inline

Get the red primary x, y pair.

Parameters
xybuffer to store the x, y pair (2 32-bit floats)
void cineon::GenericHeader::Reset ( )

Reset class to initial state.

void cineon::GenericHeader::SetBitDepth ( const int  i,
const U8  bpp 
)
inline

Set the bits per pixel.

Parameters
ielement index (0-7)
bppbit count
void cineon::GenericHeader::SetBluePrimary ( const R32  xy[2])
inline

Set the blue primary x, y pair.

Parameters
xythe x, y pair (2 32-bit floats)
void cineon::GenericHeader::SetCreationDate ( const char *  ct)
inline

Set the creation time/date.

Parameters
ctbuffer with creation time/date
void cineon::GenericHeader::SetCreationTime ( const char *  ct)
inline

Set the creation time/date.

Parameters
ctbuffer with creation time/date
void cineon::GenericHeader::SetCreationTimeDate ( const long  secs)

Set the creation time/date.

Parameters
secsnumber of seconds since January 1, 1970 00:00
void cineon::GenericHeader::SetDataSign ( const U8  sign)
inline

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

Parameters
signdata sign
void cineon::GenericHeader::SetEndOfImagePadding ( const U32  eoip)
inline

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

Parameters
ielement index (0-7)
eoipcount
void cineon::GenericHeader::SetEndOfLinePadding ( const U32  eolp)
inline

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

Parameters
ielement index (0-7)
eolpcount
void cineon::GenericHeader::SetFileName ( const char *  fn)
inline

Set the file name.

Parameters
fnbuffer with filename
void cineon::GenericHeader::SetFileSize ( const U32  fs)
inline

Set the size of the entire file.

Parameters
fsfile size in bytes
void cineon::GenericHeader::SetGamma ( const R32  gamma)
inline

Set the gamma correction exponent.

Parameters
gammagamma exponent
void cineon::GenericHeader::SetGreenPrimary ( const R32  xy[2])
inline

Set the green primary x, y pair.

Parameters
xythe x, y pair (2 32-bit floats)
void cineon::GenericHeader::SetHighData ( const int  i,
const R32  data 
)
inline

Set the maximum data value.

Parameters
ielement index (0-7)
datamaximum value
void cineon::GenericHeader::SetHighQuantity ( const int  i,
const R32  quant 
)
inline

Set the quantity of maximum data value.

Parameters
ielement index (0-7)
quantquantity
void cineon::GenericHeader::SetImageDescriptor ( const int  i,
const Descriptor  d 
)
inline

Set the second byte of the channel designator.

Parameters
ielement index (0-7)
dchannel descriptor
void cineon::GenericHeader::SetImageInterleave ( const Interleave  inter)
inline

Set the data intearleave mode.

Parameters
interintearleave method
void cineon::GenericHeader::SetImageOffset ( const U32  offset)
inline

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

Parameters
offsetoffset in bytes
void cineon::GenericHeader::SetImageOrientation ( const Orientation  orient)
inline

Set the image orientation.

Parameters
orientorientation
void cineon::GenericHeader::SetImagePacking ( const Packing  pack)
inline

Set the data packing mode.

Parameters
packpacking method
void cineon::GenericHeader::SetImageSense ( const U8  sense)
inline

Set the image sense (0 = positive, 1 = negative)

Parameters
senseimage sense
void cineon::GenericHeader::SetInputDevice ( const char *  dev)
inline

Set the input device name.

Parameters
devbuffer with device name
void cineon::GenericHeader::SetInputDeviceModelNumber ( const char *  sn)
inline

Set the input device model number.

Parameters
snbuffer with device model number
void cineon::GenericHeader::SetInputDeviceSerialNumber ( const char *  sn)
inline

Set the input device serial number.

Parameters
snbuffer with device serial number
void cineon::GenericHeader::SetLabelText ( const char *  ct)
inline

Set the label text.

Parameters
ctbuffer with label text
void cineon::GenericHeader::SetLinesPerElement ( const int  i,
const U32  lpe 
)
inline

Set the lines per element.

Parameters
ielement index (0-7)
lpelines count
void cineon::GenericHeader::SetLowData ( const int  i,
const R32  data 
)
inline

Set the minimum data value.

Parameters
ielement index (0-7)
dataminimum value
void cineon::GenericHeader::SetLowQuantity ( const int  i,
const R32  quant 
)
inline

Set the quantity of minimum data value.

Parameters
ielement index (0-7)
quantquantity
void cineon::GenericHeader::SetMetric ( const int  i,
const U8  m 
)
inline

Set the first byte of the channel designator - metric info.

Parameters
ielement index (0-7)
pplmetric
void cineon::GenericHeader::SetNumberOfElements ( const U8  num)
inline

Set the number of elements.

Parameters
numelement count
void cineon::GenericHeader::SetPixelsPerLine ( const int  i,
const U32  ppl 
)
inline

Set the pixels per line.

Parameters
ielement index (0-7)
pplpixel count
void cineon::GenericHeader::SetRedPrimary ( const R32  xy[2])
inline

Set the red primary x, y pair.

Parameters
xythe x, y pair (2 32-bit floats)
void cineon::GenericHeader::SetSourceDate ( const char *  td)
inline

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

Parameters
tdbuffer with time/date string
void cineon::GenericHeader::SetSourceImageFileName ( const char *  fn)
inline

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

Parameters
fnbuffer with source file name
void cineon::GenericHeader::SetSourceTime ( const char *  td)
inline

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

Parameters
tdbuffer with time/date string
void cineon::GenericHeader::SetSourceTimeDate ( const long  secs)

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

Parameters
secsnumber of seconds since January 1, 1970 00:00
void cineon::GenericHeader::SetUserSize ( const U32  size)
inline

Set the size of the user data.

Parameters
sizeuser data size in bytes
void cineon::GenericHeader::SetVersion ( const char *  v)
inline

Set the version string.

Parameters
vversion string
void cineon::GenericHeader::SetWhitePoint ( const R32  xy[2])
inline

Set the white point primary x, y pair.

Parameters
xythe x, y pair (2 32-bit floats)
void cineon::GenericHeader::SetXDevicePitch ( const R32  size)
inline

Set the horizontal pitch of the device.

Parameters
sizepitch in samples/mm
void cineon::GenericHeader::SetXOffset ( const S32  offset)
inline

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

Parameters
offsetoffset count
void cineon::GenericHeader::SetYDevicePitch ( const R32  size)
inline

Set the vertical pitch of the device.

Parameters
sizepitch in samples/mm
void cineon::GenericHeader::SetYOffset ( const S32  offset)
inline

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

Parameters
offsetoffset count
void cineon::GenericHeader::SourceDate ( char *  td) const
inline

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

Parameters
tdbuffer to write time/date string (24+1)
void cineon::GenericHeader::SourceImageFileName ( char *  fn) const
inline

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

Parameters
fnbuffer to write source file name (100+1)
void cineon::GenericHeader::SourceTime ( char *  td) const
inline

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

Parameters
tdbuffer to write time/date string (24+1)
U32 cineon::GenericHeader::UserSize ( ) const
inline

Get the size of the user data.

Returns
user data size in bytes
void cineon::GenericHeader::Version ( char *  v) const
inline

Get current version string of header.

Parameters
vbuffer to place string, needs to be at least 8+1 bytes long
void cineon::GenericHeader::WhitePoint ( R32  xy[2]) const
inline

Get the white point primary x, y pair.

Parameters
xybuffer to store the x, y pair (2 32-bit floats)
R32 cineon::GenericHeader::XDevicePitch ( ) const
inline

Get the horizontal pitch of the device.

Returns
pitch in samples/mm
S32 cineon::GenericHeader::XOffset ( ) const
inline

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

Returns
offset count
R32 cineon::GenericHeader::YDevicePitch ( ) const
inline

Get the veritcal pitch of the device.

Returns
pitch in samples/mm
S32 cineon::GenericHeader::YOffset ( ) const
inline

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

Returns
offset count

Member Data Documentation

R32 cineon::GenericHeader::bluePrimary[2]

Blue primary chromaticity (x, y pair)

ImageElement cineon::GenericHeader::chan[MAX_ELEMENTS]

Image element data structures.

ASCII cineon::GenericHeader::creationDate[12]

Create date /see DateTimeFormat.

ASCII cineon::GenericHeader::creationTime[12]

Create time /see DateTimeFormat.

U8 cineon::GenericHeader::dataSign

Data sign (0 = unsigned, 1 = signed)

U32 cineon::GenericHeader::endOfImagePadding

End-of-Image Padding.

U32 cineon::GenericHeader::endOfLinePadding

End-of-Line Padding.

ASCII cineon::GenericHeader::fileName[100]

File name.

U32 cineon::GenericHeader::fileSize

Total file size (in bytes)

R32 cineon::GenericHeader::gamma

Gamma.

U32 cineon::GenericHeader::genericSize

Generic Header length (in bytes)

R32 cineon::GenericHeader::greenPrimary[2]

Green primary chromaticity (x, y pair)

U32 cineon::GenericHeader::imageOffset

Offset to image data (in bytes)

U8 cineon::GenericHeader::imageOrientation

Image orientation.

See also
Orientation
U8 cineon::GenericHeader::imageSense

Image sense (0 = positive image, 1 = negative image)

U32 cineon::GenericHeader::industrySize

Industry Header length (in bytes)

ASCII cineon::GenericHeader::inputDevice[64]

Input device name.

ASCII cineon::GenericHeader::inputDeviceModelNumber[32]

Input device model number.

ASCII cineon::GenericHeader::inputDeviceSerialNumber[32]

Input device serial number.

U8 cineon::GenericHeader::interleave

Data interleave.

See also
Interleave
ASCII cineon::GenericHeader::labelText[200]

Label text.

U32 cineon::GenericHeader::magicNumber

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

U8 cineon::GenericHeader::numberOfElements

Number of elements (1-8)

U8 cineon::GenericHeader::packing

Packing.

See also
Packing
R32 cineon::GenericHeader::redPrimary[2]

Red primary chromaticity (x, y pair)

ASCII cineon::GenericHeader::reserved1[36]

Reserved.

ASCII cineon::GenericHeader::reserved2[28]

Reserved.

ASCII cineon::GenericHeader::reserved3[20]
ASCII cineon::GenericHeader::reserved4[40]

Reserved.

ASCII cineon::GenericHeader::sourceDate[12]

Source date /see DateTimeFormat.

ASCII cineon::GenericHeader::sourceImageFileName[100]

Source image file name.

ASCII cineon::GenericHeader::sourceTime[12]

Source time /see DateTimeFormat.

U8 cineon::GenericHeader::unused1[2]

Unused (word alignment)

U32 cineon::GenericHeader::userSize

User defined header length (in bytes)

ASCII cineon::GenericHeader::version[8]

Version number of header format.

R32 cineon::GenericHeader::whitePoint[2]

White point (x, y pair)

R32 cineon::GenericHeader::xDevicePitch

X device pitch (samples/mm)

S32 cineon::GenericHeader::xOffset

X offset.

R32 cineon::GenericHeader::yDevicePitch

Y device pitch (samples/mm)

S32 cineon::GenericHeader::yOffset

Y offset.


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