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
| Name | Description |
|---|---|
| CineonHeader() |
CineonHeader()
CineonHeader.cspublic CineonHeader()No documentation is available.
Properties
| Name | Description |
|---|---|
| BitsPerSample | Gets the number of bits of each sample. |
| ChannelDesignators | 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. |
| Chromaticities | 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. |
| CreationDate | Gets the creation date (yyyy:mm:dd, as the file stores it), or null. |
| CreationTime | Gets the creation time (hh:mm:ss and a time zone, as the file stores it), or null. |
| FileName | Gets the file name recorded in the header, or null. |
| FilmEdgeCode | 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. |
| FilmFormat | Gets the film format, such as ACADEMY, or null. |
| FrameAttribute | Gets the frame attribute (such as KEYFRAME), or null. |
| FramePosition | Gets the position of the frame in its sequence, or null. |
| FrameRate | Gets the frame rate of the original, in frames per second, or null. |
| Gamma | Gets the image gamma of the capture device, or null. It is never applied. |
| InputDevice | Gets the input device, or null. |
| InputDeviceModel | Gets the model number of the input device, or null. |
| InputDeviceSerialNumber | Gets the serial number of the input device, or null. |
| IsBigEndian | Gets a value indicating whether the file is big-endian (magic number 80 2A 5F D7) rather than little-endian. |
| IsNegative | Gets a value indicating whether the image is a negative (image sense 1). The pixels are not inverted. |
| Label | Gets the label text, or null. |
| MaximumDataValues | Gets the maximum code value of each channel, or null. |
| MaximumQuantities | Gets the quantity the maximum code value of each channel represents, such as a density of 2.048, or null. |
| MinimumDataValues | Gets the minimum code value of each channel, or null for a channel that leaves it undefined. |
| MinimumQuantities | Gets the quantity the minimum code value of each channel represents, or null. |
| Packing | 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). |
| SlateInformation | Gets the slate information, or null. |
| SourceCreationDate | Gets the creation date of the source image, as the file stores it, or null. |
| SourceCreationTime | Gets the creation time of the source image, as the file stores it, or null. |
| SourceFileName | Gets the file name of the source image, or null. |
| Version | Gets the version of the header format, such as V4.5. |
| XDevicePitch | Gets the horizontal pitch of the input device, in samples per millimeter, or null. |
| XOffset | Gets the horizontal offset of the image on its source medium, or null. |
| YDevicePitch | Gets the vertical pitch of the input device, in samples per millimeter, or null. |
| YOffset | Gets the vertical offset of the image on its source medium, or null. |
BitsPerSample
CineonHeader.csChannelDesignators
CineonHeader.csGets 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
Chromaticities
CineonHeader.csGets 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
CreationDate
CineonHeader.csCreationTime
CineonHeader.csFileName
CineonHeader.csFilmEdgeCode
CineonHeader.csFilmFormat
CineonHeader.csFrameAttribute
CineonHeader.csFramePosition
CineonHeader.csFrameRate
CineonHeader.csGamma
CineonHeader.csInputDevice
CineonHeader.csInputDeviceModel
CineonHeader.csInputDeviceSerialNumber
CineonHeader.csIsBigEndian
CineonHeader.csIsNegative
CineonHeader.csLabel
CineonHeader.csMaximumDataValues
CineonHeader.csGets the maximum code value of each channel, or null.
public IReadOnlyList<float?> MaximumDataValues { get; init; }Property value
MaximumQuantities
CineonHeader.csGets 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
MinimumDataValues
CineonHeader.csGets the minimum code value of each channel, or null for a channel that leaves it undefined.
public IReadOnlyList<float?> MinimumDataValues { get; init; }Property value
MinimumQuantities
CineonHeader.csGets the quantity the minimum code value of each channel represents, or null.
public IReadOnlyList<float?> MinimumQuantities { get; init; }Property value
Packing
CineonHeader.csSlateInformation
CineonHeader.csSourceCreationDate
CineonHeader.csSourceCreationTime
CineonHeader.csSourceFileName
CineonHeader.csVersion
CineonHeader.csXDevicePitch
CineonHeader.csXOffset
CineonHeader.csYDevicePitch
CineonHeader.csYOffset
CineonHeader.csMethods
| Name | Description |
|---|---|
| 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.csIndicates whether the current object is equal to another object of the same type.
public bool Equals(CineonHeader? other)Parameters
otherCineonHeader?- An object to compare with this object.
Returns
bool true if the current object is equal to the other parameter; otherwise, false.