CineonHeader Class

The fields of the header of a Kodak Cineon file (Image File Format Proposal for Digital Pictures, draft 4.5) that describe its channels and where it comes from. This is informational only, like ImageMetadata.SourceFormat: it describes the file, not the pixels.

public sealed class CineonHeader : IEquatable<CineonHeader>

Remarks

Nothing is applied to the pixels: they are the code values the file stores, scaled to the sample range of the pixel format. Cineon files usually hold printing densities (a logarithmic film scan); the minimum and maximum quantities say which densities the code values represent, and a conversion to linear light is an explicit operation of the caller.

A field the file leaves undefined (the "undefined" value of its type: all bits set for unsigned numbers, 0x80000000 for signed ones, positive infinity for reals and an empty string for text) is null. No operation updates it. CineonEncoder copies its fields to the files it writes (the byte order and the packing are those of the encoder); the other encoders ignore it.

Implements

Constructors

NameDescription
CineonHeader()

CineonHeader()

CineonHeader.cs
public CineonHeader()

No documentation is available.

Properties

NameDescription
BitsPerSampleGets the number of bits of each sample.
ChannelDesignatorsGets the designator of each channel, in the order of the file: the metric (byte 0, 0 for the universal metric) in the high byte and the code (byte 1) in the low byte. In the universal metric, 0 is black and white, 1 to 3 are the red, green and blue printing densities, and 4 to 6 the red, green and blue of CCIR XA/11.
ChromaticitiesGets the CIE (x, y) chromaticities of the white point and of the red, green and blue primaries, in that order, or null when one of them is undefined. They are never applied.
CreationDateGets the creation date (yyyy:mm:dd, as the file stores it), or null.
CreationTimeGets the creation time (hh:mm:ss and a time zone, as the file stores it), or null.
FileNameGets the file name recorded in the header, or null.
FilmEdgeCodeGets the film edge code (KEYKODE): the manufacturer identification, the film type, the offset in perforations (two digits each), the prefix (six digits) and the count (four digits), or null when one of them is undefined.
FilmFormatGets the film format, such as ACADEMY, or null.
FrameAttributeGets the frame attribute (such as KEYFRAME), or null.
FramePositionGets the position of the frame in its sequence, or null.
FrameRateGets the frame rate of the original, in frames per second, or null.
GammaGets the image gamma of the capture device, or null. It is never applied.
InputDeviceGets the input device, or null.
InputDeviceModelGets the model number of the input device, or null.
InputDeviceSerialNumberGets the serial number of the input device, or null.
IsBigEndianGets a value indicating whether the file is big-endian (magic number 80 2A 5F D7) rather than little-endian.
IsNegativeGets a value indicating whether the image is a negative (image sense 1). The pixels are not inverted.
LabelGets the label text, or null.
MaximumDataValuesGets the maximum code value of each channel, or null.
MaximumQuantitiesGets the quantity the maximum code value of each channel represents, such as a density of 2.048, or null.
MinimumDataValuesGets the minimum code value of each channel, or null for a channel that leaves it undefined.
MinimumQuantitiesGets the quantity the minimum code value of each channel represents, or null.
PackingGets the packing field (0 for bit fields, 1 to 6 for cells of 8, 16 or 32 bits, left or right justified; the high bit packs fields of several pixels in a cell).
SlateInformationGets the slate information, or null.
SourceCreationDateGets the creation date of the source image, as the file stores it, or null.
SourceCreationTimeGets the creation time of the source image, as the file stores it, or null.
SourceFileNameGets the file name of the source image, or null.
VersionGets the version of the header format, such as V4.5.
XDevicePitchGets the horizontal pitch of the input device, in samples per millimeter, or null.
XOffsetGets the horizontal offset of the image on its source medium, or null.
YDevicePitchGets the vertical pitch of the input device, in samples per millimeter, or null.
YOffsetGets the vertical offset of the image on its source medium, or null.

BitsPerSample

CineonHeader.cs

Gets the number of bits of each sample.

public int BitsPerSample { get; init; }

Property value

int

ChannelDesignators

CineonHeader.cs

Gets the designator of each channel, in the order of the file: the metric (byte 0, 0 for the universal metric) in the high byte and the code (byte 1) in the low byte. In the universal metric, 0 is black and white, 1 to 3 are the red, green and blue printing densities, and 4 to 6 the red, green and blue of CCIR XA/11.

public IReadOnlyList<ushort> ChannelDesignators { get; init; }

Property value

IReadOnlyList<ushort>

Chromaticities

CineonHeader.cs

Gets the CIE (x, y) chromaticities of the white point and of the red, green and blue primaries, in that order, or null when one of them is undefined. They are never applied.

public IReadOnlyList<float>? Chromaticities { get; init; }

Property value

IReadOnlyList<float>?

CreationDate

CineonHeader.cs

Gets the creation date (yyyy:mm:dd, as the file stores it), or null.

public string? CreationDate { get; init; }

Property value

string?

CreationTime

CineonHeader.cs

Gets the creation time (hh:mm:ss and a time zone, as the file stores it), or null.

public string? CreationTime { get; init; }

Property value

string?

Gets the file name recorded in the header, or null.

public string? FileName { get; init; }

Property value

string?

FilmEdgeCode

CineonHeader.cs

Gets the film edge code (KEYKODE): the manufacturer identification, the film type, the offset in perforations (two digits each), the prefix (six digits) and the count (four digits), or null when one of them is undefined.

public string? FilmEdgeCode { get; init; }

Property value

string?

FilmFormat

CineonHeader.cs

Gets the film format, such as ACADEMY, or null.

public string? FilmFormat { get; init; }

Property value

string?

FrameAttribute

CineonHeader.cs

Gets the frame attribute (such as KEYFRAME), or null.

public string? FrameAttribute { get; init; }

Property value

string?

FramePosition

CineonHeader.cs

Gets the position of the frame in its sequence, or null.

public uint? FramePosition { get; init; }

Property value

uint?

Gets the frame rate of the original, in frames per second, or null.

public float? FrameRate { get; init; }

Property value

float?

Gets the image gamma of the capture device, or null. It is never applied.

public float? Gamma { get; init; }

Property value

float?

InputDevice

CineonHeader.cs

Gets the input device, or null.

public string? InputDevice { get; init; }

Property value

string?

InputDeviceModel

CineonHeader.cs

Gets the model number of the input device, or null.

public string? InputDeviceModel { get; init; }

Property value

string?

InputDeviceSerialNumber

CineonHeader.cs

Gets the serial number of the input device, or null.

public string? InputDeviceSerialNumber { get; init; }

Property value

string?

IsBigEndian

CineonHeader.cs

Gets a value indicating whether the file is big-endian (magic number 80 2A 5F D7) rather than little-endian.

public bool IsBigEndian { get; init; }

Property value

bool

IsNegative

CineonHeader.cs

Gets a value indicating whether the image is a negative (image sense 1). The pixels are not inverted.

public bool IsNegative { get; init; }

Property value

bool

Gets the label text, or null.

public string? Label { get; init; }

Property value

string?

MaximumDataValues

CineonHeader.cs

Gets the maximum code value of each channel, or null.

public IReadOnlyList<float?> MaximumDataValues { get; init; }

Property value

IReadOnlyList<float?>

MaximumQuantities

CineonHeader.cs

Gets the quantity the maximum code value of each channel represents, such as a density of 2.048, or null.

public IReadOnlyList<float?> MaximumQuantities { get; init; }

Property value

IReadOnlyList<float?>

MinimumDataValues

CineonHeader.cs

Gets the minimum code value of each channel, or null for a channel that leaves it undefined.

public IReadOnlyList<float?> MinimumDataValues { get; init; }

Property value

IReadOnlyList<float?>

MinimumQuantities

CineonHeader.cs

Gets the quantity the minimum code value of each channel represents, or null.

public IReadOnlyList<float?> MinimumQuantities { get; init; }

Property value

IReadOnlyList<float?>

Gets the packing field (0 for bit fields, 1 to 6 for cells of 8, 16 or 32 bits, left or right justified; the high bit packs fields of several pixels in a cell).

public byte Packing { get; init; }

Property value

byte

SlateInformation

CineonHeader.cs

Gets the slate information, or null.

public string? SlateInformation { get; init; }

Property value

string?

SourceCreationDate

CineonHeader.cs

Gets the creation date of the source image, as the file stores it, or null.

public string? SourceCreationDate { get; init; }

Property value

string?

SourceCreationTime

CineonHeader.cs

Gets the creation time of the source image, as the file stores it, or null.

public string? SourceCreationTime { get; init; }

Property value

string?

SourceFileName

CineonHeader.cs

Gets the file name of the source image, or null.

public string? SourceFileName { get; init; }

Property value

string?

Gets the version of the header format, such as V4.5.

public string Version { get; init; }

Property value

string

XDevicePitch

CineonHeader.cs

Gets the horizontal pitch of the input device, in samples per millimeter, or null.

public float? XDevicePitch { get; init; }

Property value

float?

Gets the horizontal offset of the image on its source medium, or null.

public int? XOffset { get; init; }

Property value

int?

YDevicePitch

CineonHeader.cs

Gets the vertical pitch of the input device, in samples per millimeter, or null.

public float? YDevicePitch { get; init; }

Property value

float?

Gets the vertical offset of the image on its source medium, or null.

public int? YOffset { get; init; }

Property value

int?

Methods

NameDescription
Equals(CineonHeader?)Indicates whether the current object is equal to another object of the same type.
Equals(object?)Determines whether the specified object is equal to the current object.
GetHashCode()Serves as the default hash function.
ToString()Returns a string that represents the current object.

Equals overloads

Equals(CineonHeader?)

CineonHeader.cs

Indicates whether the current object is equal to another object of the same type.

public bool Equals(CineonHeader? other)
Parameters
other CineonHeader?
An object to compare with this object.
Returns

bool true if the current object is equal to the other parameter; otherwise, false.

Equals(object?)

CineonHeader.cs

Determines whether the specified object is equal to the current object.

public override bool Equals(object? obj)
Parameters
obj object?
The object to compare with the current object.
Returns

bool true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

CineonHeader.cs

Serves as the default hash function.

public override int GetHashCode()

Returns

int A hash code for the current object.

ToString()

CineonHeader.cs

Returns a string that represents the current object.

public override string ToString()

Returns

string A string that represents the current object.