DpxHeader Class

The fields of the headers of a DPX file (SMPTE ST 268) that describe its first image element and where it comes from. This is informational only, like ImageMetadata.SourceFormat: it describes the file, not the pixels.

public sealed class DpxHeader : IEquatable<DpxHeader>

Remarks

Nothing is applied to the pixels: they are the code values the file stores, scaled to the sample range of the pixel format. DpxHeader.Transfer says how they encode light (a logarithmic film scan, linear light, a video signal); 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 numbers and an empty string for text) is null. No operation updates it, and every encoder ignores it: DpxEncoder writes the fields it derives from the image itself.

Implements

Constructors

NameDescription
DpxHeader()

DpxHeader()

DpxHeader.cs
public DpxHeader()

No documentation is available.

Properties

NameDescription
BitDepthGets the number of bits of each component: 1, 8, 10, 12 or 16 (integers), 32 or 64 (floating point).
ColorimetricGets the colorimetric specification (the primaries or the color responses) of the code values.
CopyrightGets the right-to-use or copyright statement, or null.
CreationTimeGets the creation date and time (yyyy:mm:dd:hh:mm:ssLTZ, as the file stores it), or null.
CreatorGets the creator (the program that wrote the file), or null.
DescriptorGets the components of the first image element.
ElementDescriptionGets the description of the first image element, or null.
FieldNumberGets the field number of the first field, or null.
FileNameGets the file name recorded in the header, or null.
FilmEdgeCodeGets the film edge code (SMPTE ST 254): the manufacturer identification, the film type, the offset in perforations, the prefix and the count, 16 digits as the file stores them, or null without a motion-picture film header or when one of its parts is undefined.
FilmFormatGets the film format, such as Academy, or null.
FrameIdentificationGets the frame identification (such as a key frame), or null.
FramePositionGets the position of the frame in its sequence, or null.
FrameRateGets the frame rate of the original film, in frames per second, or null.
GammaGets the gamma of the television header (the exponent of Y = X^(1/gamma)), or null. It is never applied.
HeldCountGets the number of frames for which to hold this frame, or null.
ImageElementCountGets the number of image elements of the file (1 to 8). Only the first one is decoded.
InputDeviceGets the name 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 SDPX) rather than little-endian (XPDS).
IsInterlacedGets a value indicating whether the signal is 2:1 interlaced, or null.
PackingGets how the components are packed into 32-bit words.
ProjectGets the project name, or null.
ReferenceHighCodeGets the code value of the reference high quantity (the maximum expected code value), or null.
ReferenceHighQuantityGets the signal level or measured value the reference high code value represents, such as a density of 2.048, or null.
ReferenceLowCodeGets the code value of the reference low quantity (the minimum expected code value), or null.
ReferenceLowQuantityGets the signal level or measured value the reference low code value represents, or null.
SequenceLengthGets the number of frames of the sequence, or null.
ShutterAngleGets the shutter angle of the camera, in degrees, or null.
SlateInformationGets the slate information, or null.
SourceCreationTimeGets the creation date and time of the source image, as the file stores it, or null.
SourceFileNameGets the file name of the source image, or null.
TemporalSamplingRateGets the temporal sampling rate (the frame rate) of the television header, in hertz, or null.
TimeCodeGets the SMPTE time code of the television header (SMPTE ST 12-1, Table 6) as hh:mm:ss:ff, or null without a television header or when it is undefined or its digits are not decimal.
TransferGets the transfer characteristic of the code values. It is never applied.
UserBitsGets the SMPTE user bits of the television header, or null.
VersionGets the version of the header format, such as V2.0 or V1.0.
VideoSignalStandardGets the video signal standard (SMPTE ST 268, Table 4), or null.

BitDepth

DpxHeader.cs

Gets the number of bits of each component: 1, 8, 10, 12 or 16 (integers), 32 or 64 (floating point).

public int BitDepth { get; init; }

Property value

int

Colorimetric

DpxHeader.cs

Gets the colorimetric specification (the primaries or the color responses) of the code values.

public DpxColorimetricSpecification Colorimetric { get; init; }

CreationTime

DpxHeader.cs

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

public string? CreationTime { get; init; }

Property value

string?

Gets the creator (the program that wrote the file), or null.

public string? Creator { get; init; }

Property value

string?

Descriptor

DpxHeader.cs

Gets the components of the first image element.

public DpxDescriptor Descriptor { get; init; }

Property value

DpxDescriptor

ElementDescription

DpxHeader.cs

Gets the description of the first image element, or null.

public string? ElementDescription { get; init; }

Property value

string?

FieldNumber

DpxHeader.cs

Gets the field number of the first field, or null.

public byte? FieldNumber { get; init; }

Property value

byte?

FileName

DpxHeader.cs

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

public string? FileName { get; init; }

Property value

string?

FilmEdgeCode

DpxHeader.cs

Gets the film edge code (SMPTE ST 254): the manufacturer identification, the film type, the offset in perforations, the prefix and the count, 16 digits as the file stores them, or null without a motion-picture film header or when one of its parts is undefined.

public string? FilmEdgeCode { get; init; }

Property value

string?

FilmFormat

DpxHeader.cs

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

public string? FilmFormat { get; init; }

Property value

string?

FrameIdentification

DpxHeader.cs

Gets the frame identification (such as a key frame), or null.

public string? FrameIdentification { get; init; }

Property value

string?

FramePosition

DpxHeader.cs

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

public uint? FramePosition { get; init; }

Property value

uint?

FrameRate

DpxHeader.cs

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

public float? FrameRate { get; init; }

Property value

float?

Gets the gamma of the television header (the exponent of Y = X^(1/gamma)), or null. It is never applied.

public float? Gamma { get; init; }

Property value

float?

HeldCount

DpxHeader.cs

Gets the number of frames for which to hold this frame, or null.

public uint? HeldCount { get; init; }

Property value

uint?

ImageElementCount

DpxHeader.cs

Gets the number of image elements of the file (1 to 8). Only the first one is decoded.

public int ImageElementCount { get; init; }

Property value

int

InputDevice

DpxHeader.cs

Gets the name of the input device, or null.

public string? InputDevice { get; init; }

Property value

string?

InputDeviceSerialNumber

DpxHeader.cs

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

public string? InputDeviceSerialNumber { get; init; }

Property value

string?

IsBigEndian

DpxHeader.cs

Gets a value indicating whether the file is big-endian (magic number SDPX) rather than little-endian (XPDS).

public bool IsBigEndian { get; init; }

Property value

bool

IsInterlaced

DpxHeader.cs

Gets a value indicating whether the signal is 2:1 interlaced, or null.

public bool? IsInterlaced { get; init; }

Property value

bool?

Gets how the components are packed into 32-bit words.

public DpxPacking Packing { get; init; }

Property value

DpxPacking

Gets the project name, or null.

public string? Project { get; init; }

Property value

string?

ReferenceHighCode

DpxHeader.cs

Gets the code value of the reference high quantity (the maximum expected code value), or null.

public uint? ReferenceHighCode { get; init; }

Property value

uint?

ReferenceHighQuantity

DpxHeader.cs

Gets the signal level or measured value the reference high code value represents, such as a density of 2.048, or null.

public float? ReferenceHighQuantity { get; init; }

Property value

float?

ReferenceLowCode

DpxHeader.cs

Gets the code value of the reference low quantity (the minimum expected code value), or null.

public uint? ReferenceLowCode { get; init; }

Property value

uint?

ReferenceLowQuantity

DpxHeader.cs

Gets the signal level or measured value the reference low code value represents, or null.

public float? ReferenceLowQuantity { get; init; }

Property value

float?

SequenceLength

DpxHeader.cs

Gets the number of frames of the sequence, or null.

public uint? SequenceLength { get; init; }

Property value

uint?

ShutterAngle

DpxHeader.cs

Gets the shutter angle of the camera, in degrees, or null.

public float? ShutterAngle { get; init; }

Property value

float?

SlateInformation

DpxHeader.cs

Gets the slate information, or null.

public string? SlateInformation { get; init; }

Property value

string?

SourceCreationTime

DpxHeader.cs

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

public string? SourceCreationTime { get; init; }

Property value

string?

SourceFileName

DpxHeader.cs

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

public string? SourceFileName { get; init; }

Property value

string?

TemporalSamplingRate

DpxHeader.cs

Gets the temporal sampling rate (the frame rate) of the television header, in hertz, or null.

public float? TemporalSamplingRate { get; init; }

Property value

float?

TimeCode

DpxHeader.cs

Gets the SMPTE time code of the television header (SMPTE ST 12-1, Table 6) as hh:mm:ss:ff, or null without a television header or when it is undefined or its digits are not decimal.

public string? TimeCode { get; init; }

Property value

string?

Transfer

DpxHeader.cs

Gets the transfer characteristic of the code values. It is never applied.

public DpxTransferCharacteristic Transfer { get; init; }

UserBits

DpxHeader.cs

Gets the SMPTE user bits of the television header, or null.

public uint? UserBits { get; init; }

Property value

uint?

Gets the version of the header format, such as V2.0 or V1.0.

public string Version { get; init; }

Property value

string

VideoSignalStandard

DpxHeader.cs

Gets the video signal standard (SMPTE ST 268, Table 4), or null.

public byte? VideoSignalStandard { get; init; }

Property value

byte?

Methods

NameDescription
Equals(DpxHeader?)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(DpxHeader?)

DpxHeader.cs

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

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

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

Equals(object?)

DpxHeader.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()

DpxHeader.cs

Serves as the default hash function.

public override int GetHashCode()

Returns

int A hash code for the current object.

ToString()

DpxHeader.cs

Returns a string that represents the current object.

public override string ToString()

Returns

string A string that represents the current object.